# com.herewhite.sdk.domain.RectangleConfig class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## 详细描述 [#详细描述] 适用版本:**Whiteboard Android SDK 2.16.134**。 `RectangleConfig` 类,用于配置白板的视觉矩形。 @since 2.2.0 视觉矩形是用户的视角必须容纳的区域。设置好视觉矩形后,SDK 会自动将视角会调整到刚好可以完整展示视觉矩形所表示的范围。 你可以根据要展示的 PPT 幻灯片或图像的尺寸设置视觉矩形,以确保相同的内容在不同尺寸的屏幕上都可以完整显示。 父类:[WhiteObject](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-object);继承接口详见父类。 ## 属性与 JSON 字段 [#属性与-json-字段] Java 非公开字段通过对应 getter/setter 访问;可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值;其他构造参数以签名为准。 | 字段 | 声明 | 源码初值 | 说明 | | --- | --- | --- | --- | | [originX](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#acc196c9c7ac28379111d884d10853975) | `Double originX` | 未显式赋值 | [api-center-table-0 details](#table-slot-api-center-table-0) | | [originY](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a41d022fc9a0f3a16f4bafadef9e0dd1a) | `Double originY` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) | | [width](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a9e46cc8d5090e10032f42751b8e05969) | `Double width` | 未显式赋值 | [api-center-table-2 details](#table-slot-api-center-table-2) | | [height](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#adf5c4971c544fdaa37b3b2b2787e3969) | `Double height` | 未显式赋值 | [api-center-table-3 details](#table-slot-api-center-table-3) | | [animationMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a2b0ba6695d3fd34dcc66def715cc3ce1) | `AnimationMode animationMode` | 未显式赋值 | [api-center-table-4 details](#table-slot-api-center-table-4) | **api-center-table-0 details** 模型属性;通过对应 getter/setter 访问。 **api-center-table-1 details** 模型属性;通过对应 getter/setter 访问。 **api-center-table-2 details** 模型属性;通过对应 getter/setter 访问。 **api-center-table-3 details** 模型属性;通过对应 getter/setter 访问。 **api-center-table-4 details** 模型属性;通过对应 getter/setter 访问。 | 公开成员签名 | | | --- | --- | | | [RectangleConfig](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a00abec6b2a88cc17382d0d3bbef282ea) (Double width, Double height, AnimationMode mode) | | | [RectangleConfig](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a7c5540be82cfdeb3659fc655038181fa) (Double width, Double height) | | | [RectangleConfig](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a33e338dd76fcf5bfd8ad793a372d5766) (Double originX, Double originY, Double width, Double height) | | | [RectangleConfig](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a9bdd60e088b51ab7a18adc66886b586e) (Double originX, Double originY, Double width, Double height, AnimationMode mode) | | Double | [getOriginX](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#ad19772962b549055388361932d03b7ad) () | | void | [setOriginX](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#ae6701f37fe7bb14f02bb207eafa66c4d) (Double originX) | | Double | [getOriginY](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#ae92c2a2088b4839673e807bf08ef4ef6) () | | void | [setOriginY](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#ac21e75a67dd3a36f2c741686b07d5502) (Double originY) | | Double | [getWidth](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a99dff390e92b94d1f88dba08ca04e4a7) () | | void | [setWidth](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a179635e6f558dc89107344b5c89dafe1) (Double width) | | Double | [getHeight](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a38edf7afae5e8cec8cc7e4c1ae93f957) () | | void | [setHeight](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a44a309679d4f0edce5d9e9abc9a500f5) (Double height) | | AnimationMode | [getAnimationMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#a864ee572d2fe0c42a090f5d63748998d) () | | void | [setAnimationMode](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config#ad088be5a85d563e287938467a86aae20) (AnimationMode animationMode) | ## 变量说明 [#变量说明] ### originX [#originx] ```text Double originX ``` 源码初值:未显式赋值 模型属性;通过对应 getter/setter 访问。 ### originY [#originy] ```text Double originY ``` 源码初值:未显式赋值 模型属性;通过对应 getter/setter 访问。 ### width [#width] ```text Double width ``` 源码初值:未显式赋值 模型属性;通过对应 getter/setter 访问。 ### height [#height] ```text Double height ``` 源码初值:未显式赋值 模型属性;通过对应 getter/setter 访问。 ### animationMode [#animationmode] ```text AnimationMode animationMode ``` 源码初值:未显式赋值 模型属性;通过对应 getter/setter 访问。 ## 函数说明 [#函数说明] ### RectangleConfig() [#rectangleconfig] RectangleConfig(Double width, Double height, AnimationMode mode) [`RectangleConfig`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config) 构造函数。 在该函数中,你需要传入 `width`,`height` 和 `mode`。SDK 会根据你传入 `width` 和 `height` 计算视觉矩形左上角原点 在世界坐标系中的位置 `originX` 和 `originY`, 即 `originX = - width / 2.0d`,`originY = - height / 2.0d`。 该方法适用于需要快速显示完整 PPT 内容的场景。 白板视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。 白板视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。 视觉矩形的动画模式,详见 [`AnimationMode`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-animation-mode)。 ### RectangleConfig() [#rectangleconfig-1] RectangleConfig(Double width, Double height) [`RectangleConfig`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config) 构造函数。 在该函数中,你需要传入 `width` 和 `height`。SDK 会根据你传入 `width` 和 `height` 计算视觉矩形左上角原点 在世界坐标系中的位置 `originX` 和 `originY`, 即 `originX = - width / 2.0d`,`originY = - height / 2.0d`。 该方法不支持设置动画模式,SDK 会默认将动画模式设置为 `Continuous`,即连续动画的模式。 该方法适用于需要快速显示完整 PPT 内容的场景。 视觉矩形宽度。视觉矩形的宽度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。 视觉矩形高度。视觉矩形的高度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。 ### RectangleConfig() [#rectangleconfig-2] RectangleConfig(Double originX, Double originY, Double width, Double height) [`RectangleConfig`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config) 构造函数。 在该函数中,你需要传入 `originX`、`originY`、`width` 和 `height`。SDK 会根据你传入的 `originX`、`originY`、`width` 和 `height` 确定视觉矩形在世界坐标系(即世界坐标系)中的位置和大小。 该方法不支持设置动画模式,而是使用默认的连续动画 `Continuous` 模式。 视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。 视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。 视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。 视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。 ### RectangleConfig() [#rectangleconfig-3] RectangleConfig(Double originX, Double originY, Double width, Double height, AnimationMode mode) [`RectangleConfig`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-rectangle-config) 构造函数。 在该函数中,你需要传入 `originX`、`originY`、`width`、`height` 和 `mode`。 SDK 会根据你传入的 `originX`、`originY`、`width`、`height` 和 `mode` 确定视觉矩形在世界坐标系(即世界坐标系)中的位置、大小和动画模式。 视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。 视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。 视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。 视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度,否则用户将看不见超出的部分。 视觉矩形的动画模式,详见 [`AnimationMode`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-animation-mode)。 ### getOriginX() [#getoriginx] Double getOriginX() 获取视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。

返回值

视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。 ### setOriginX() [#setoriginx] void setOriginX(Double originX) 设置视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。 视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。 ### getOriginY() [#getoriginy] Double getOriginY() 获取视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。

返回值

视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。 ### setOriginY() [#setoriginy] void setOriginY(Double originY) 设置视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。 视觉矩形左上角原点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。 ### getWidth() [#getwidth] Double getWidth() 获取视觉矩形的宽度。

返回值

视觉矩形的宽度。 ### setWidth() [#setwidth] void setWidth(Double width) 设置视觉矩形的宽度。 视觉矩形的宽度。 ### getHeight() [#getheight] Double getHeight() 获取视觉矩形的高度。

返回值

视觉矩形的高度。 ### setHeight() [#setheight] void setHeight(Double height) 设置视觉矩形的高度。 视觉矩形的高度。 ### getAnimationMode() [#getanimationmode] AnimationMode getAnimationMode() 获取视觉矩形的动画模式。

返回值

视觉矩形的动画模式,详见 [`AnimationMode`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-animation-mode)。 ### setAnimationMode() [#setanimationmode] void setAnimationMode(AnimationMode animationMode) 设置视觉矩形的动画模式。 视觉矩形的动画模式,详见 [`AnimationMode`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-animation-mode)。