xr-frame / Exports / CameraOrbitControl

# Class: CameraOrbitControl

# Hierarchy

• Component<ICameraOrbitControlData>

  ↳ CameraOrbitControl

# Table of contents

# Constructors

• constructor

# Events

• onAdd
• onRelease
• onRemove
• onTick
• onUpdate

# Properties

• dampingFactor
• enableDamping
• isEnabled
• isLockMove
• isLockRotate
• isLockX
• isLockY
• isLockZoom
• panMax
• panMin
• panSpeed
• priority
• rotateSpeed
• schema
• zoomMax
• zoomMin
• zoomSpeed
• EVENTS

# Accessors

• damping
• el
• scene
• target
• version

# Methods

• disable
• enable
• getData
• setData
• setDataOne

# Constructors

# constructor

• new CameraOrbitControl()

# Inherited from

Component.constructor

# Events

# onAdd

▸ onAdd(parent, data): void

添加到世界，继承请先super.onAdd()。

# Parameters

# Returns

void

# Inherited from

Component.onAdd

---

# onRelease

▸ onRelease(data): void

从被挂载的element上被移除，或是element被销毁时，触发的回调。 一般用于释放持有的资源。

# Parameters

# Returns

void

# Inherited from

Component.onRelease

---

# onRemove

▸ onRemove(): void

销毁，继承请先super.onUpdate()。

# Returns

void

# Inherited from

Component.onRemove

---

# onTick

▸ onTick(deltaTime, data): void

渲染每帧触发的回调。

# Parameters

# Returns

void

# Inherited from

Component.onTick

---

# onUpdate

▸ onUpdate(data): void

每一帧更新，继承请先super.onUpdate()。

# Parameters

# Returns

void

# Inherited from

Component.onUpdate

# Properties

# dampingFactor

• dampingFactor: number = 0.1

阻尼系数。

---

# enableDamping

• enableDamping: boolean = true

开启阻尼缓动。

---

# isEnabled

• isEnabled: boolean = false

是否已经开启。

---

# isLockMove

• isLockMove: boolean = false

是否锁定移动。

---

# isLockRotate

• isLockRotate: boolean = false

是否锁定旋转。

---

# isLockX

• isLockX: boolean = false

是否锁定横向旋转。

---

# isLockY

• isLockY: boolean = false

是否锁定纵向旋转。

---

# isLockZoom

• isLockZoom: boolean = false

是否锁定缩放。

---

# panMax

• panMax: Vector3

允许的最大平移边界。

---

# panMin

• panMin: Vector3

允许的最小平移边界。

---

# panSpeed

• panSpeed: number = 1

平移速度。

---

# priority

• Readonly priority: number

自定义组件的更新优先级。

# Inherited from

Component.priority

---

# rotateSpeed

• rotateSpeed: number = 1

旋转速度。

---

# schema

• Readonly schema: IComponentSchema

详见CameraOrbitControlSchema。

# Overrides

Component.schema

---

# zoomMax

• zoomMax: number

允许的最大缩放值。

---

# zoomMin

• zoomMin: number = -Infinity

允许的最小缩放值。

---

# zoomSpeed

• zoomSpeed: number = 1

缩放速度。

---

# EVENTS

▪ Static EVENTS: string[] = []

# Inherited from

Component.EVENTS

# Accessors

# damping

• get damping(): boolean

当前是否正在缓动。

# Returns

boolean

---

# el

• get el(): Element

挂载的元素。

# Returns

Element

---

# scene

• get scene(): Scene

当前场景。

# Returns

Scene

---

# target

• get target(): Vector3

获取当前目标。

# Returns

Vector3

---

# version

• get version(): number

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

# Returns

number

# Methods

# disable

▸ disable(): void

关闭控制器。

# Returns

void

---

# enable

▸ enable(): void

启动控制器。

# Returns

void

---

# getData

▸ getData<T>(key): ICameraOrbitControlData[T]

获取一个当前值。

# Type parameters

# Parameters

# Returns

ICameraOrbitControlData[T]

# Inherited from

Component.getData

---

# setData

▸ setData(data): void

不通过xml而是直接设置data，注意值的类型需要和schema中一致。

# Parameters

# Returns

void

# Inherited from

Component.setData

---

# setDataOne

▸ setDataOne<T>(key, value): void

设置一个数据。

# Type parameters

# Parameters

# Returns

void

# Inherited from

Component.setDataOne