# 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).

<a id="details"></a>

## 详细描述 [#详细描述]

适用版本：**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) |

<a id="table-slot-api-center-table-0"></a>

**api-center-table-0 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-1"></a>

**api-center-table-1 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-2"></a>

**api-center-table-2 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-3"></a>

**api-center-table-3 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-4"></a>

**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) |

## 变量说明 [#变量说明]

<a id="acc196c9c7ac28379111d884d10853975"></a>

### originX [#originx]

```text
Double originX
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="a41d022fc9a0f3a16f4bafadef9e0dd1a"></a>

### originY [#originy]

```text
Double originY
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="a9e46cc8d5090e10032f42751b8e05969"></a>

### width [#width]

```text
Double width
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="adf5c4971c544fdaa37b3b2b2787e3969"></a>

### height [#height]

```text
Double height
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="a2b0ba6695d3fd34dcc66def715cc3ce1"></a>

### animationMode [#animationmode]

```text
AnimationMode animationMode
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

## 函数说明 [#函数说明]

<a id="a00abec6b2a88cc17382d0d3bbef282ea"></a>

### RectangleConfig() [#rectangleconfig]

<ApiSignature>

RectangleConfig(Double width, Double height, AnimationMode mode)

</ApiSignature>

[`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 内容的场景。

<ParameterList title="参数">
<Parameter name="width">

白板视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。

</Parameter>
<Parameter name="height">

白板视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。

</Parameter>
<Parameter name="mode">

视觉矩形的动画模式，详见 [`AnimationMode`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-animation-mode)。

</Parameter>
</ParameterList>

<a id="a7c5540be82cfdeb3659fc655038181fa"></a>

### RectangleConfig() [#rectangleconfig-1]

<ApiSignature>

RectangleConfig(Double width, Double height)

</ApiSignature>

[`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 内容的场景。

<ParameterList title="参数">
<Parameter name="width">

视觉矩形宽度。视觉矩形的宽度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。

</Parameter>
<Parameter name="height">

视觉矩形高度。视觉矩形的高度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。

</Parameter>
</ParameterList>

<a id="a33e338dd76fcf5bfd8ad793a372d5766"></a>

### RectangleConfig() [#rectangleconfig-2]

<ApiSignature>

RectangleConfig(Double originX, Double originY, Double width, Double height)

</ApiSignature>

[`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` 模式。

<ParameterList title="参数">
<Parameter name="originX">

视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。

</Parameter>
<Parameter name="originY">

视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。

</Parameter>
<Parameter name="width">

视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。

</Parameter>
<Parameter name="height">

视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。

</Parameter>
</ParameterList>

<a id="a9bdd60e088b51ab7a18adc66886b586e"></a>

### RectangleConfig() [#rectangleconfig-3]

<ApiSignature>

RectangleConfig(Double originX, Double originY, Double width, Double height, AnimationMode mode)

</ApiSignature>

[`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` 确定视觉矩形在世界坐标系（即世界坐标系）中的位置、大小和动画模式。

<ParameterList title="参数">
<Parameter name="originX">

视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。

</Parameter>
<Parameter name="originY">

视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。

</Parameter>
<Parameter name="width">

视觉矩形的宽度。视觉矩形的宽度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。

</Parameter>
<Parameter name="height">

视觉矩形的高度。视觉矩形的高度不能小于实际展示内容的宽度，否则用户将看不见超出的部分。

</Parameter>
<Parameter name="mode">

视觉矩形的动画模式，详见 [`AnimationMode`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-animation-mode)。

</Parameter>
</ParameterList>

<a id="ad19772962b549055388361932d03b7ad"></a>

### getOriginX() [#getoriginx]

<ApiSignature>

Double getOriginX()

</ApiSignature>

获取视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。

<h4 data-toc-hidden="true" id={"返回值"}>返回值</h4>

视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。

<a id="ae6701f37fe7bb14f02bb207eafa66c4d"></a>

### setOriginX() [#setoriginx]

<ApiSignature>

void setOriginX(Double originX)

</ApiSignature>

设置视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。

<ParameterList title="参数">
<Parameter name="originX">

视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 X 轴坐标。

</Parameter>
</ParameterList>

<a id="ae92c2a2088b4839673e807bf08ef4ef6"></a>

### getOriginY() [#getoriginy]

<ApiSignature>

Double getOriginY()

</ApiSignature>

获取视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。

<h4 data-toc-hidden="true" id={"返回值-1"}>返回值</h4>

视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。

<a id="ac21e75a67dd3a36f2c741686b07d5502"></a>

### setOriginY() [#setoriginy]

<ApiSignature>

void setOriginY(Double originY)

</ApiSignature>

设置视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。

<ParameterList title="参数">
<Parameter name="originY">

视觉矩形左上角原点在世界坐标系（以白板初始化时的中心点为原点的坐标系）中的 Y 轴坐标。

</Parameter>
</ParameterList>

<a id="a99dff390e92b94d1f88dba08ca04e4a7"></a>

### getWidth() [#getwidth]

<ApiSignature>

Double getWidth()

</ApiSignature>

获取视觉矩形的宽度。

<h4 data-toc-hidden="true" id={"返回值-2"}>返回值</h4>

视觉矩形的宽度。

<a id="a179635e6f558dc89107344b5c89dafe1"></a>

### setWidth() [#setwidth]

<ApiSignature>

void setWidth(Double width)

</ApiSignature>

设置视觉矩形的宽度。

<ParameterList title="参数">
<Parameter name="width">

视觉矩形的宽度。

</Parameter>
</ParameterList>

<a id="a38edf7afae5e8cec8cc7e4c1ae93f957"></a>

### getHeight() [#getheight]

<ApiSignature>

Double getHeight()

</ApiSignature>

获取视觉矩形的高度。

<h4 data-toc-hidden="true" id={"返回值-3"}>返回值</h4>

视觉矩形的高度。

<a id="a44a309679d4f0edce5d9e9abc9a500f5"></a>

### setHeight() [#setheight]

<ApiSignature>

void setHeight(Double height)

</ApiSignature>

设置视觉矩形的高度。

<ParameterList title="参数">
<Parameter name="height">

视觉矩形的高度。

</Parameter>
</ParameterList>

<a id="a864ee572d2fe0c42a090f5d63748998d"></a>

### getAnimationMode() [#getanimationmode]

<ApiSignature>

AnimationMode getAnimationMode()

</ApiSignature>

获取视觉矩形的动画模式。

<h4 data-toc-hidden="true" id={"返回值-4"}>返回值</h4>

视觉矩形的动画模式，详见 [`AnimationMode`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-animation-mode)。

<a id="ad088be5a85d563e287938467a86aae20"></a>

### setAnimationMode() [#setanimationmode]

<ApiSignature>

void setAnimationMode(AnimationMode animationMode)

</ApiSignature>

设置视觉矩形的动画模式。

<ParameterList title="参数">
<Parameter name="animationMode">

视觉矩形的动画模式，详见 [`AnimationMode`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-animation-mode)。

</Parameter>
</ParameterList>