@orillusion/core

---

Class: OrbitController

Defined in: src/components/controller/OrbitController.ts:14

Orbit Camera Controller

Extends

• ComponentBase

Constructors

Constructor

new OrbitController(): OrbitController

Defined in: src/components/controller/OrbitController.ts:58

Returns

OrbitController

Overrides

ComponentBase.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

ComponentBase.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

ComponentBase.isDestroyed

---

autoRotate

autoRotate: boolean = false

Defined in: src/components/controller/OrbitController.ts:22

Whether to enable automatic rotation

---

autoRotateSpeed

autoRotateSpeed: number = 0.1

Defined in: src/components/controller/OrbitController.ts:26

Automatic rotation speed coefficient

---

rotateFactor

rotateFactor: number = 0.5

Defined in: src/components/controller/OrbitController.ts:30

Rotation speed coefficient

---

zoomFactor

zoomFactor: number = 0.1

Defined in: src/components/controller/OrbitController.ts:34

Scale speed coefficient

---

panFactor

panFactor: number = 0.25

Defined in: src/components/controller/OrbitController.ts:38

Angle translation velocity coefficient

Accessors

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

ComponentBase.visibleLayer

---

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

ComponentBase.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

ComponentBase.isStart

---

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

ComponentBase.transform

---

enable

Get Signature

get enable(): boolean

Defined in: src/components/ComponentBase.ts:113

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/ComponentBase.ts:96

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

value

boolean

Returns

void

Inherited from

ComponentBase.enable

---

target

Get Signature

get target(): Vector3

Defined in: src/components/controller/OrbitController.ts:64

Get the target position

Returns

Vector3

Set Signature

set target(v): void

Defined in: src/components/controller/OrbitController.ts:70

Set the target position

Parameters

v

Vector3

Returns

void

---

smooth

Get Signature

get smooth(): number

Defined in: src/components/controller/OrbitController.ts:77

Get smoothing coefficient of controller

Returns

number

Set Signature

set smooth(v): void

Defined in: src/components/controller/OrbitController.ts:83

Set smoothing coefficient of controller

Parameters

v

number

Returns

void

---

minDistance

Get Signature

get minDistance(): number

Defined in: src/components/controller/OrbitController.ts:90

Get the minimum distance between the camera and the target coordinate

Default Value

1

Returns

number

Set Signature

set minDistance(v): void

Defined in: src/components/controller/OrbitController.ts:98

Set the minimum distance between the camera and the target position min value: 0.000002 max value: this._maxDistance maxDistance

Parameters

v

number

Returns

void

---

maxDistance

Get Signature

get maxDistance(): number

Defined in: src/components/controller/OrbitController.ts:105

Get the max distance between the camera and the target position

Default Value

100000

Returns

number

Set Signature

set maxDistance(v): void

Defined in: src/components/controller/OrbitController.ts:113

Set the max distance between the camera and the target position min - this._maxDistance max - Infinity

Parameters

v

number

Returns

void

---

minPolarAngle

Get Signature

get minPolarAngle(): number

Defined in: src/components/controller/OrbitController.ts:121

Get the lower elevation limit of the camera from the xz plane

Default Value

-90

Returns

number

Set Signature

set minPolarAngle(v): void

Defined in: src/components/controller/OrbitController.ts:129

Set the lower elevation limit of the camera from the xz plane min - -90 max - maxPolarAngle

Parameters

v

number

Returns

void

---

maxPolarAngle

Get Signature

get maxPolarAngle(): number

Defined in: src/components/controller/OrbitController.ts:136

Get the upper elevation limit of the camera from the xz plane

Default Value

90

Returns

number

Set Signature

set maxPolarAngle(v): void

Defined in: src/components/controller/OrbitController.ts:144

Set the upper elevation limit of the camera to the xz plane min - less than minPolarAngle
max - 90

Parameters

v

number

Returns

void

---

spherical

Get Signature

get spherical(): Spherical

Defined in: src/components/controller/OrbitController.ts:148

Returns

Spherical

Methods

init()

init(param?): void

Defined in: src/components/ComponentBase.ts:161

Parameters

param?

any

Returns

void

Inherited from

ComponentBase.init

---

stop()

stop(): void

Defined in: src/components/ComponentBase.ts:163

Returns

void

Inherited from

ComponentBase.stop

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onBeforeUpdate

---

onCompute()?

optional onCompute(view?, command?): any

Defined in: src/components/ComponentBase.ts:169

Parameters

view?

View3D

command?

GPUCommandEncoder

Returns

any

Inherited from

ComponentBase.onCompute

---

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onGraphic

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

ComponentBase.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

ComponentBase.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

ComponentBase.onRemoveChild

---

cloneTo()

cloneTo(obj): void

Defined in: src/components/ComponentBase.ts:180

clone component data to target object3D

Parameters

obj

Object3D

target object3D

Returns

void

Inherited from

ComponentBase.cloneTo

---

copyComponent()

copyComponent(from): this

Defined in: src/components/ComponentBase.ts:182

Parameters

from

this

Returns

this

Inherited from

ComponentBase.copyComponent

---

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/ComponentBase.ts:249

before release this component, object refrences are not be set null now.

Parameters

force?

boolean

Returns

void

Inherited from

ComponentBase.beforeDestroy

---

destroy()

destroy(force?): void

Defined in: src/components/ComponentBase.ts:256

release this component

Parameters

force?

boolean

Returns

void

Inherited from

ComponentBase.destroy