com.herewhite.sdk.domain.CameraBound class 参考
- Android
更新时间不可用
详细描述
适用版本:Whiteboard Android SDK 2.16.134。
CameraBound 类,用于设置视角边界。
视角边界指白板场景内,用户可以移动视角的范围。当视角超出视角边界时,视角会被拉回。
@since 2.5.0
父类:WhiteObject;继承接口详见父类。
属性与 JSON 字段
Java 非公开字段通过对应 getter/setter 访问;可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值;其他构造参数以签名为准。
| 字段 | 声明 | 源码初值 | 说明 |
|---|---|---|---|
| damping | Double damping | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| centerX | Double centerX | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| centerY | Double centerY | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| width | Double width | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| height | Double height | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| maxContentMode | ContentModeConfig maxContentMode | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| minContentMode | ContentModeConfig minContentMode | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| 公开成员签名 | |
|---|---|
| CameraBound () | |
| CameraBound (Double miniScale, Double maxScale) | |
| Double | getCenterX () |
| void | setCenterX (Double centerX) |
| Double | getCenterY () |
| void | setCenterY (Double centerY) |
| Double | getWidth () |
| void | setWidth (Double width) |
| Double | getHeight () |
| void | setHeight (Double height) |
| ContentModeConfig | getMaxContentMode () |
| void | setMaxContentMode (ContentModeConfig maxContentMode) |
| ContentModeConfig | getMinContentMode () |
| void | setMinContentMode (ContentModeConfig minContentMode) |
| Double | getDamping () |
| void | setDamping (Double damping) |
变量说明
damping
Double damping源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
centerX
Double centerX源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
centerY
Double centerY源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
width
Double width源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
height
Double height源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
maxContentMode
ContentModeConfig maxContentMode源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
minContentMode
ContentModeConfig minContentMode源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
函数说明
CameraBound()
CameraBound()CameraBound:com.herewhite.sdk.domain.CameraBound 的公开成员。参数和返回类型见下方签名。
CameraBound()
CameraBound(Double miniScale, Double maxScale)初始化视角边界。
| 参数名 | 描述 |
|---|---|
miniScale | 视角边界的最小缩放比例。 |
maxScale | 视角边界的最大缩放比例。 |
getCenterX()
Double getCenterX()获取视角边界的中心点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。
返回值
视角边界的中心点在世界坐标系中的 X 轴坐标。
setCenterX()
void setCenterX(Double centerX)设置视角边界的中心点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 X 轴坐标。
| 参数名 | 描述 |
|---|---|
centerX | 视角边界的中心点在世界坐标系的 X 轴坐标。默认值为 0.0。 |
getCenterY()
Double getCenterY()获取视角边界的中心点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。
返回值
视角边界的中心点在世界坐标系中的 Y 轴坐标。
setCenterY()
void setCenterY(Double centerY)设置视角边界的中心点在世界坐标系(以白板初始化时的中心点为原点的坐标系)中的 Y 轴坐标。
| 参数名 | 描述 |
|---|---|
centerY | 视角边界的中心点在世界坐标系中的 Y 轴坐标。默认值为 0.0。 |
getWidth()
Double getWidth()获取视角边界的宽度。
返回值
视角边界的宽度,单位为像素。
setWidth()
void setWidth(Double width)设置视角边界的宽度。
| 参数名 | 描述 |
|---|---|
width | 视角边界的宽度,单位为像素。如果不填,则表示无限制。 |
getHeight()
Double getHeight()获取视角边界的宽度。
返回值
视角边界的宽度,单位为像素。
setHeight()
void setHeight(Double height)设置视角边界的高度。
| 参数名 | 描述 |
|---|---|
height | 视角边界的高度,单位为像素。如果不填,则表示无限制。 |
getMaxContentMode()
ContentModeConfig getMaxContentMode()获取视角边界的缩放模式和最大缩放比例。
返回值
视角边界的缩放模式和最大缩放比例,详见 ContentModeConfig。
setMaxContentMode()
void setMaxContentMode(ContentModeConfig maxContentMode)设置视角边界的缩放模式和最大缩放比例。
| 参数名 | 描述 |
|---|---|
maxContentMode | 视角边界的最大缩放比例,详见 |
getMinContentMode()
ContentModeConfig getMinContentMode()获取视角边界的缩放模式和最小缩放比例。
返回值
视角边界的缩放模式和最小缩放比例,详见 ContentModeConfig。
setMinContentMode()
void setMinContentMode(ContentModeConfig minContentMode)设置视角边界的缩放模式和最小缩放比例。
| 参数名 | 描述 |
|---|---|
minContentMode | 视角边界的缩放模式和最小缩放比例,详见 |
getDamping()
Double getDamping()获取用户将视角移出视角边界时感受到的阻力。
返回值
用户将视角移出视角边界时感受到的阻力。返回值范围为 [0.0,1.0]。数值越大,用户感受到的阻力越大。
setDamping()
void setDamping(Double damping)设置用户将视角移出视角边界时感受到的阻力。
| 参数名 | 描述 |
|---|---|
damping | 阻力大小,取值范围为 [0.0,1.0]。取值越大,用户感受到的阻力越大。
|