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

Public Member Functions

Boolean getLocked ()
 
void setLocked (Boolean locked)
 
String getUuid ()
 
void setUuid (String uuid)
 
double getCenterX ()
 
void setCenterX (double centerX)
 
double getCenterY ()
 
void setCenterY (double centerY)
 
double getWidth ()
 
void setWidth (double width)
 
double getHeight ()
 
void setHeight (double height)
 
- Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject
String toString ()
 
JSONObject toJSON ()
 

Detailed Description

Created by buhe on 2018/8/15. Image information.

Member Function Documentation

◆ getLocked()

Boolean com.herewhite.sdk.domain.ImageInformation.getLocked ( )

Gets whether the image is locked.

Returns
Whether the image is locked:
  • true: Locked. When an image is locked, users cannot move or zoom the image.
  • false: Unlocked.

◆ setLocked()

void com.herewhite.sdk.domain.ImageInformation.setLocked ( Boolean  locked)

Locks an image.

When an image is locked, users cannot move or zoom the image.

Parameters
lockedWhether to lock the image:
  • true: Locks the image.
  • false: (Default) Do not lock the image.

◆ getUuid()

String com.herewhite.sdk.domain.ImageInformation.getUuid ( )

Gets the unique identifier (UUID) of the image.

Returns
The UUID of the image in string format.

◆ setUuid()

void com.herewhite.sdk.domain.ImageInformation.setUuid ( String  uuid)

Sets the unique identifier (UUID) of the image.

The UUID of the image is a string, which is the identifier of the image and must be unique in the live interactive whiteboard room. You can use the UUID generation library to generate the UUID of the image.

Parameters
uuidThe UUID of the image in string format.

◆ getCenterX()

double com.herewhite.sdk.domain.ImageInformation.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.ImageInformation.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.ImageInformation.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.ImageInformation.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.ImageInformation.getWidth ( )

Gets the width of the image.

Returns
The width (px) of the image.

◆ setWidth()

void com.herewhite.sdk.domain.ImageInformation.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 excess part.

◆ getHeight()

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

Gets the height of the image.

Returns
The height (px) of the image.

◆ setHeight()

void com.herewhite.sdk.domain.ImageInformation.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 the excess part.