Agora Interactive Whiteboard Java API Reference
Public Member Functions | List of all members
com.herewhite.sdk.domain.ImageInformationWithUrl Class Reference
Inheritance diagram for com.herewhite.sdk.domain.ImageInformationWithUrl:
com.herewhite.sdk.domain.WhiteObject

Public Member Functions

 ImageInformationWithUrl (Double centerX, Double centerY, Double width, Double height, String url)
 
double getCenterX ()
 
void setCenterX (double centerX)
 
double getCenterY ()
 
void setCenterY (double centerY)
 
double getWidth ()
 
void setWidth (double width)
 
double getHeight ()
 
void setHeight (double height)
 
String getUrl ()
 
void setUrl (String url)
 
- Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject
String toString ()
 
JSONObject toJSON ()
 

Detailed Description

Position and sizing information for the image and the URL address of the image.

Constructor & Destructor Documentation

◆ ImageInformationWithUrl()

com.herewhite.sdk.domain.ImageInformationWithUrl.ImageInformationWithUrl ( Double  centerX,
Double  centerY,
Double  width,
Double  height,
String  url 
)

The ImageInformationWithUrl constructor, for initializing an ImageInformationWithUrl object.

Parameters
centerXThe X coordinate of the center of the image in the world coordinate system (taking the center of the initial whiteboard as the origin).
centerYThe Y coordinate of the center of the image in the world coordinate system (taking the center of the initial whiteboard as the origin).
widthThe width (px) of the image.
heightThe height (px) of the image.
urlThe URL address of the image. Ensure the application client can access the URL; otherwise, the image cannot be displayed.

Member Function Documentation

◆ getCenterX()

double com.herewhite.sdk.domain.ImageInformationWithUrl.getCenterX ( )

Gets the X coordinate of the center of the image in the world coordinate system (taking the center of the initial whiteboard as the origin).

Returns
The X coordinate of the center of the image in the world coordinate system.

◆ setCenterX()

void com.herewhite.sdk.domain.ImageInformationWithUrl.setCenterX ( double  centerX)

Sets the X coordinate of the center of the image in the world coordinate system (taking the center of the initial whiteboard as the origin).

Parameters
centerXThe X coordinate of the center of the image in the world coordinate system.

◆ getCenterY()

double com.herewhite.sdk.domain.ImageInformationWithUrl.getCenterY ( )

Gets the Y coordinate of the center of the image in the world coordinate system (taking the center of the initial whiteboard as the origin).

Returns
The Y coordinate of the center of the image in the world coordinate system.

◆ setCenterY()

void com.herewhite.sdk.domain.ImageInformationWithUrl.setCenterY ( double  centerY)

Sets the Y coordinate of the center of the image in the world coordinate system (taking the center of the initial whiteboard as the origin).

Parameters
centerYThe Y coordinate of the center of the image in the world coordinate system.

◆ getWidth()

double com.herewhite.sdk.domain.ImageInformationWithUrl.getWidth ( )

Gets the width of the image.

Returns
The width (px) of the image.

◆ setWidth()

void com.herewhite.sdk.domain.ImageInformationWithUrl.setWidth ( double  width)

Sets the width of the image.

Parameters
widthThe width (px) of the image. If the width of the image is greater than the boundary of the view, then users cannot see the parts that exceed the boundary.

◆ getHeight()

double com.herewhite.sdk.domain.ImageInformationWithUrl.getHeight ( )

Gets the height of the image.

Returns
The height (px) of the image.

◆ setHeight()

void com.herewhite.sdk.domain.ImageInformationWithUrl.setHeight ( double  height)

Sets the height of the image.

Parameters
heightThe height (px) of the image. If the height of the image is greater than the boundary of the view, then users cannot see parts that exceed the boundary.

◆ getUrl()

String com.herewhite.sdk.domain.ImageInformationWithUrl.getUrl ( )

Gets the URL address of the image.

Returns
The URL address of the image.

◆ setUrl()

void com.herewhite.sdk.domain.ImageInformationWithUrl.setUrl ( String  url)

Sets the URL address of the image.

Parameters
urlThe URL address of the image. Ensure the application client can access the URL; otherwise, the image cannot be displayed.