Class OrbitCameraController

OrbitCameraController is a camera controller that allows the user to orbit around a target.

Hierarchy (view full)

AbstractCameraController
- OrbitCameraController

Implements

ICameraController

Index

Constructors

constructor

new OrbitCameraController(cameraControllerComponent): OrbitCameraController
Parameters
- cameraControllerComponent: CameraControllerComponent
Returns OrbitCameraController
Overrides AbstractCameraController.constructor
- Defined in foundation/cameras/OrbitCameraController.ts:116

Properties

`Protected`__targetEntities

__targetEntities: ISceneGraphEntity[] = []

aabbWithSkeletal

aabbWithSkeletal: boolean = true

autoCalculateZNearAndZFar

autoCalculateZNearAndZFar: boolean = true

autoUpdate

autoUpdate: boolean = true

dollyScale

dollyScale: number = 2.0

followTargetAABB

followTargetAABB: boolean = false

moveSpeed

moveSpeed: number = 1

scaleOfLengthCenterToCamera

scaleOfLengthCenterToCamera: number = 1.0

useInitialTargetAABBForLength

useInitialTargetAABBForLength: boolean = false

zFarScalingFactor

zFarScalingFactor: number = 100000

zNearMax

zNearMax: number = 0.1

Accessors

doPreventDefault

get doPreventDefault(): boolean
Gets whether default behavior is prevented on events.

Returns boolean
True if default is prevented, false otherwise
- Defined in foundation/cameras/OrbitCameraController.ts:188
set doPreventDefault(flag): void
Sets whether to prevent default behavior on events.
Parameters
- flag: boolean
  True to prevent default, false otherwise
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:180

dolly

get dolly(): number
Gets the dolly (zoom) value with gamma correction.

Returns number
The dolly value (0-1)
- Defined in foundation/cameras/OrbitCameraController.ts:604
set dolly(value): void
Sets the dolly (zoom) value with gamma correction.
Parameters
- value: number
  The dolly value (0-1)
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:592

isMouseDown

get isMouseDown(): boolean
Gets whether the mouse is currently pressed down.

Returns boolean
True if mouse is down, false otherwise
- Defined in foundation/cameras/OrbitCameraController.ts:1139

lastMouseDownTimeStamp

get lastMouseDownTimeStamp(): number
Gets the timestamp of the last mouse down event.

Returns number
The timestamp in milliseconds
- Defined in foundation/cameras/OrbitCameraController.ts:1147

lastMouseUpTimeStamp

get lastMouseUpTimeStamp(): number
Gets the timestamp of the last mouse up event.

Returns number
The timestamp in milliseconds
- Defined in foundation/cameras/OrbitCameraController.ts:1155

maximumY

set maximumY(maximum_y): void
Sets the maximum Y rotation angle limit.
Parameters
- maximum_y: number
  The maximum Y rotation angle
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:407

minimumY

set minimumY(minimum_y): void
Sets the minimum Y rotation angle limit.
Parameters
- minimum_y: number
  The minimum Y rotation angle
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:415

rotX

get rotX(): number
Gets the X-axis rotation value.

Returns number
The rotation value in degrees
- Defined in foundation/cameras/OrbitCameraController.ts:381
set rotX(value): void
Sets the X-axis rotation value.
Parameters
- value: number
  The rotation value in degrees
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:371

rotY

get rotY(): number
Gets the Y-axis rotation value.

Returns number
The rotation value in degrees
- Defined in foundation/cameras/OrbitCameraController.ts:399
set rotY(value): void
Sets the Y-axis rotation value.
Parameters
- value: number
  The rotation value in degrees
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:389

scaleOfZNearAndZFar

get scaleOfZNearAndZFar(): number
Gets the scale factor for zNear and zFar calculations.

Returns number
The scale factor
- Defined in foundation/cameras/OrbitCameraController.ts:1131
set scaleOfZNearAndZFar(value): void
Sets the scale factor for zNear and zFar calculations.
Parameters
- value: number
  The scale factor
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:1121

updateCount

get updateCount(): number
Gets the current update count.

Returns number
The current update count
Implementation of ICameraController.updateCount
- Defined in foundation/cameras/OrbitCameraController.ts:126

Methods

__calculateInfluenceOfController

__calculateInfluenceOfController(): void
Internal
calculate up, eye, center and tangent vector with controller influence

Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:997

__contextMenu

__contextMenu(evt): void
Internal
Handles context menu events.
Parameters
- evt: Event
  The context menu event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:584

__getFovyFromCamera

__getFovyFromCamera(camera): number
Internal
Gets the field of view Y value from the camera component.
Parameters
- camera: CameraComponent
  The camera component
Returns number
The fovy value in degrees
- Defined in foundation/cameras/OrbitCameraController.ts:891

__getTouchesDistance

__getTouchesDistance(e): number
Internal
Calculates the distance between two touch points.
Parameters
- e: TouchEvent
  The touch event
Returns number
The distance between touch points
- Defined in foundation/cameras/OrbitCameraController.ts:502

__mouseDblClick

__mouseDblClick(evt): void
Internal
Handles mouse double-click events for resetting camera state.
Parameters
- evt: MouseEvent
  The mouse event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:613

__mouseDown

__mouseDown(e): void
Internal
Handles mouse down events.
Parameters
- e: MouseEvent
  The mouse event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:197

__mouseMove

__mouseMove(e): void
Internal
Handles mouse move events for camera control.
Parameters
- e: MouseEvent
  The mouse event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:221

__mouseUp

__mouseUp(e): void
Internal
Handles mouse up events.
Parameters
- e: MouseEvent
  The mouse event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:273

__mouseWheel

__mouseWheel(evt): void
Internal
Handles mouse wheel events for zoom control.
Parameters
- evt: WheelEvent
  The wheel event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:572

__parallelTranslateControl

__parallelTranslateControl(originalX, originalY, currentX, currentY): void
Internal
Controls parallel translation based on mouse/touch movement.
Parameters
- originalX: number
  Original X position
- originalY: number
  Original Y position
- currentX: number
  Current X position
- currentY: number
  Current Y position
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:473

__pinchInOut

__pinchInOut(e): void
Internal
Handles pinch in/out gestures for zoom control.
Parameters
- e: TouchEvent
  The touch event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:516

__pinchInOutEnd

__pinchInOutEnd(e): void
Internal
Handles the end of pinch in/out gestures.
Parameters
- e: TouchEvent
  The touch event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:547

__pressCtrl

__pressCtrl(e): void
Internal
Handles ctrl key press events.
Parameters
- e: KeyboardEvent
  The keyboard event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:670

__pressShift

__pressShift(e): void
Internal
Handles shift key press events.
Parameters
- e: KeyboardEvent
  The keyboard event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:648

__releaseCtrl

__releaseCtrl(e): void
Internal
Handles ctrl key release events.
Parameters
- e: KeyboardEvent
  The keyboard event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:681

__releaseShift

__releaseShift(e): void
Internal
Handles shift key release events.
Parameters
- e: KeyboardEvent
  The keyboard event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:659

__resetDollyAndPosition

__resetDollyAndPosition(e): void
Internal
Resets dolly and position on double tap for touch devices.
Parameters
- e: TouchEvent
  The touch event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:629

__rotateControl

__rotateControl(originalX, originalY, currentX, currentY): void
Internal
Controls rotation based on mouse/touch movement.
Parameters
- originalX: number
  Original X position
- originalY: number
  Original Y position
- currentX: number
  Current X position
- currentY: number
  Current Y position
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:427

__touchDown

__touchDown(e): void
Internal
Handles touch down events.
Parameters
- e: TouchEvent
  The touch event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:289

__touchMove

__touchMove(e): void
Internal
Handles touch move events for camera control.
Parameters
- e: TouchEvent
  The touch event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:313

__touchUp

__touchUp(e): void
Internal
Handles touch up events.
Parameters
- e: TouchEvent
  The touch event
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:347

__updateCameraComponent

__updateCameraComponent(camera): void
Internal
Updates the camera component with new calculated values.
Parameters
- camera: CameraComponent
  The camera component to update
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:1089

__updateTargeting

__updateTargeting(camera): void
Internal
update center, eye and up vectors of OrbitCameraController
Parameters
- camera: CameraComponent
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:932

__zoomControl

__zoomControl(originalValue, currentValue): void
Internal
Controls zoom/dolly based on mouse movement.
Parameters
- originalValue: number
  Original position value
- currentValue: number
  Current position value
Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:461

`Protected`_calcZFarInner

_calcZFarInner(camera): void
Calculates the far clipping plane (zFar) for the camera based on the near clipping plane and a scaling factor. This method is used when autoCalculateZNearAndZFar is enabled.
Parameters
- camera: CameraComponent
  The camera component to update.
Returns void
Inherited from AbstractCameraController._calcZFarInner
- Defined in foundation/cameras/AbstractCameraController.ts:61

`Protected`_calcZNearInner

_calcZNearInner(camera, eyePosition, eyeDirection): void
Calculates the near clipping plane (zNear) for the camera based on the target entities' bounding boxes. This method is used when autoCalculateZNearAndZFar is enabled and there are target entities.
Parameters
- camera: CameraComponent
  The camera component to update.
- eyePosition: Vector3
  The position of the camera's eye in world space.
- eyeDirection: Vector3
  The direction the camera is facing.
Returns void
Inherited from AbstractCameraController._calcZNearInner
- Defined in foundation/cameras/AbstractCameraController.ts:27

getTargets

getTargets(): ISceneGraphEntity[]
Gets the current target entities.

Returns ISceneGraphEntity[]
Array of target entities
Implementation of ICameraController.getTargets
Overrides AbstractCameraController.getTargets
- Defined in foundation/cameras/OrbitCameraController.ts:172

logic

logic(cameraComponent): void
Main logic method that updates the camera based on controller state.
Parameters
- cameraComponent: CameraComponent
  The camera component to update
Returns void
Implementation of ICameraController.logic
- Defined in foundation/cameras/OrbitCameraController.ts:905

registerEventListeners

registerEventListeners(): void
Registers event listeners for mouse, touch, and keyboard events.

Returns void
Implementation of ICameraController.registerEventListeners
- Defined in foundation/cameras/OrbitCameraController.ts:690

resetDollyAndTranslation

resetDollyAndTranslation(): void
Resets the dolly and translation values to their default state.

Returns void
- Defined in foundation/cameras/OrbitCameraController.ts:142

setTarget

setTarget(targetEntity): void
Sets a single target entity for the camera to focus on.
Parameters
- targetEntity: ISceneGraphEntity
  The entity to set as target
Returns void
Implementation of ICameraController.setTarget
Overrides AbstractCameraController.setTarget
- Defined in foundation/cameras/OrbitCameraController.ts:153

setTargets

setTargets(targetEntities): void
Sets multiple target entities for the camera to focus on.
Parameters
- targetEntities: ISceneGraphEntity[]
  Array of entities to set as targets
Returns void
Implementation of ICameraController.setTargets
Overrides AbstractCameraController.setTargets
- Defined in foundation/cameras/OrbitCameraController.ts:161

unregisterEventListeners

unregisterEventListeners(): void
Unregisters all event listeners.

Returns void
Implementation of ICameraController.unregisterEventListeners
- Defined in foundation/cameras/OrbitCameraController.ts:881

Class OrbitCameraController

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OrbitCameraController

Properties

Protected__targetEntities

aabbWithSkeletal

autoCalculateZNearAndZFar

autoUpdate

dollyScale

followTargetAABB

moveSpeed

scaleOfLengthCenterToCamera

useInitialTargetAABBForLength

zFarScalingFactor

zNearMax

Accessors

doPreventDefault

Returns boolean

Parameters

Returns void

dolly

Returns number

Parameters

Returns void

isMouseDown

Returns boolean

lastMouseDownTimeStamp

Returns number

lastMouseUpTimeStamp

Returns number

maximumY

Parameters

Returns void

minimumY

Parameters

Returns void

rotX

Returns number

Parameters

Returns void

rotY

Returns number

Parameters

Returns void

scaleOfZNearAndZFar

Returns number

Parameters

Returns void

updateCount

Returns number

Methods

__calculateInfluenceOfController

Returns void

__contextMenu

Parameters

Returns void

__getFovyFromCamera

Parameters

Returns number

__getTouchesDistance

Parameters

Returns number

__mouseDblClick

Parameters

Returns void

__mouseDown

Parameters

Returns void

__mouseMove

Parameters

Returns void

`Protected`__targetEntities

`Protected`_calcZFarInner

`Protected`_calcZNearInner