com.herewhite.sdk.domain.RectangleConfig class 参考
- Android
更新时间不可用
详细描述
适用版本：Whiteboard Android SDK 2.16.134。
RectangleConfig 类，用于配置白板的视觉矩形。
@since 2.2.0 视觉矩形是用户的视角必须容纳的区域。设置好视觉矩形后，SDK 会自动将视角会调整到刚好可以完整展示视觉矩形所表示的范围。 你可以根据要展示的 PPT 幻灯片或图像的尺寸设置视觉矩形，以确保相同的内容在不同尺寸的屏幕上都可以完整显示。
父类：WhiteObject；继承接口详见父类。
属性与 JSON 字段
Java 非公开字段通过对应 getter/setter 访问；可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。
| 字段 | 声明 | 源码初值 | 说明 |
|---|---|---|---|
| originX | Double originX | 未显式赋值 | 模型属性；通过对应 getter/setter 访问。 |
| originY | Double originY | 未显式赋值 | 模型属性；通过对应 getter/setter 访问。 |
| width | Double width | 未显式赋值 | 模型属性；通过对应 getter/setter 访问。 |
| height | Double height | 未显式赋值 | 模型属性；通过对应 getter/setter 访问。 |
| animationMode | AnimationMode animationMode | 未显式赋值 | 模型属性；通过对应 getter/setter 访问。 |
| 公开成员签名 | |
|---|---|
| RectangleConfig (Double width, Double height, AnimationMode mode) | |
| RectangleConfig (Double width, Double height) | |
| RectangleConfig (Double originX, Double originY, Double width, Double height) | |
| RectangleConfig (Double originX, Double originY, Double width, Double height, AnimationMode mode) | |
| Double | getOriginX () |
| void | setOriginX (Double originX) |
| Double | getOriginY () |
| void | setOriginY (Double originY) |
| Double | getWidth () |
| void | setWidth (Double width) |
| Double | getHeight () |
| void | setHeight (Double height) |
| AnimationMode | getAnimationMode () |
| void | setAnimationMode (AnimationMode animationMode) |
变量说明
originX
Double originX源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。
originY
Double originY源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。
width
Double width源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。
height
Double height源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。
animationMode
AnimationMode animationMode源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。
函数说明
RectangleConfig()
RectangleConfig(Double width, Double height, AnimationMode mode)RectangleConfig 构造函数。
在该函数中，你需要传入 width，height 和 mode。SDK 会根据你传入 width 和 height 计算视觉矩形左上角原点 在世界坐标系中的位置 originX 和 originY, 即 originX = - width / 2.0d，originY = - height / 2.0d。
该方法适用于需要快速显示完整 PPT 内容的场景。
| 参数名 | 描述 |
|---|---|
width | 白板视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。 |
height | 白板视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。 |
mode | 视觉矩形的动画模式，详见 |
RectangleConfig()
RectangleConfig(Double width, Double height)RectangleConfig 构造函数。
在该函数中，你需要传入 width 和 height。SDK 会根据你传入 width 和 height 计算视觉矩形左上角原点 在世界坐标系中的位置 originX 和 originY, 即 originX = - width / 2.0d，originY = - height / 2.0d。
该方法不支持设置动画模式，SDK 会默认将动画模式设置为 Continuous，即连续动画的模式。
该方法适用于需要快速显示完整 PPT 内容的场景。
| 参数名 | 描述 |
|---|---|
width | 视觉矩形宽度。视觉矩形的宽度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。 |
height | 视觉矩形高度。视觉矩形的高度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。 |
RectangleConfig()
RectangleConfig(Double originX, Double originY, Double width, Double height)RectangleConfig 构造函数。
在该函数中，你需要传入 originX、originY、width 和 height。SDK 会根据你传入的 originX、originY、width 和 height 确定视觉矩形在世界坐标系（即世界坐标系）中的位置和大小。
该方法不支持设置动画模式，而是使用默认的连续动画 Continuous 模式。
| 参数名 | 描述 |
|---|---|
originX | 视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。 |
originY | 视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。 |
width | 视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。 |
height | 视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。 |
RectangleConfig()
RectangleConfig(Double originX, Double originY, Double width, Double height, AnimationMode mode)RectangleConfig 构造函数。
在该函数中，你需要传入 originX、originY、width、height 和 mode。 SDK 会根据你传入的 originX、originY、width、height 和 mode 确定视觉矩形在世界坐标系（即世界坐标系）中的位置、大小和动画模式。
| 参数名 | 描述 |
|---|---|
originX | 视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。 |
originY | 视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。 |
width | 视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。 |
height | 视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。 |
mode | 视觉矩形的动画模式，详见 |
getOriginX()
Double getOriginX()获取视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。
返回值
视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。
setOriginX()
void setOriginX(Double originX)设置视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。
| 参数名 | 描述 |
|---|---|
originX | 视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。 |
getOriginY()
Double getOriginY()获取视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。
返回值
视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。
setOriginY()
void setOriginY(Double originY)设置视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。
| 参数名 | 描述 |
|---|---|
originY | 视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。 |
getWidth()
Double getWidth()获取视觉矩形的宽度。
返回值
视觉矩形的宽度。
setWidth()
void setWidth(Double width)设置视觉矩形的宽度。
| 参数名 | 描述 |
|---|---|
width | 视觉矩形的宽度。 |
getHeight()
Double getHeight()获取视觉矩形的高度。
返回值
视觉矩形的高度。
setHeight()
void setHeight(Double height)设置视觉矩形的高度。
| 参数名 | 描述 |
|---|---|
height | 视觉矩形的高度。 |
getAnimationMode()
AnimationMode getAnimationMode()获取视觉矩形的动画模式。
返回值
视觉矩形的动画模式，详见 AnimationMode。
setAnimationMode()
void setAnimationMode(AnimationMode animationMode)设置视觉矩形的动画模式。
| 参数名 | 描述 |
|---|---|
animationMode | 视觉矩形的动画模式，详见 |