Class WalkThroughCameraController

WalkThroughCameraController is a camera controller that allows the user to walk through a scene.

Hierarchy (View Summary)

AbstractCameraController
- WalkThroughCameraController

Implements

ICameraController

Constructors

constructor

new WalkThroughCameraController(
    cameraControllerComponent: CameraControllerComponent,
    options?: {
        eventTargetDom: Document;
        horizontalSpeed: number;
        inverseHorizontalRotating: boolean;
        inverseVerticalRotating: boolean;
        mouseWheelSpeedScale: number;
        turnSpeed: number;
        verticalSpeed: number;
    },
): WalkThroughCameraController
Parameters
- cameraControllerComponent: CameraControllerComponent
- options: {
      eventTargetDom: Document;
      horizontalSpeed: number;
      inverseHorizontalRotating: boolean;
      inverseVerticalRotating: boolean;
      mouseWheelSpeedScale: number;
      turnSpeed: number;
      verticalSpeed: number;
  } = ...
Returns WalkThroughCameraController
Overrides AbstractCameraController.constructor
- Defined in foundation/cameras/WalkThroughCameraController.ts:68

Properties

`Protected`__targetEntities

__targetEntities: ISceneGraphEntity[] = []

aabbWithSkeletal

aabbWithSkeletal: boolean = true

autoCalculateZNearAndZFar

autoCalculateZNearAndZFar: boolean = true

zFarScalingFactor

zFarScalingFactor: number = 100000

zNearMax

zNearMax: number = 0.1

Accessors

allInfo

get allInfo(): any
Gets all camera controller information for serialization.

Returns any
Object containing all controller state information
- Defined in foundation/cameras/WalkThroughCameraController.ts:612
set allInfo(arg: any): void
Sets all camera controller information from serialized data.
Parameters
- arg: any
  Object or JSON string containing controller state information
Returns void
- Defined in foundation/cameras/WalkThroughCameraController.ts:637

horizontalSpeed

get horizontalSpeed(): number
Gets the current horizontal movement speed.

Returns number
The current horizontal speed
- Defined in foundation/cameras/WalkThroughCameraController.ts:524
set horizontalSpeed(value: number): void
Sets the horizontal movement speed.
Parameters
- value: number
  The new horizontal speed value
Returns void
- Defined in foundation/cameras/WalkThroughCameraController.ts:516

mouseWheelSpeed

get mouseWheelSpeed(): number
Gets the current mouse wheel speed scale.

Returns number
The current mouse wheel speed scale
- Defined in foundation/cameras/WalkThroughCameraController.ts:556
set mouseWheelSpeed(value: number): void
Sets the mouse wheel speed scale.
Parameters
- value: number
  The new mouse wheel speed scale
Returns void
- Defined in foundation/cameras/WalkThroughCameraController.ts:548

updateCount

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

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

verticalSpeed

get verticalSpeed(): number
Gets the current vertical movement speed.

Returns number
The current vertical speed
- Defined in foundation/cameras/WalkThroughCameraController.ts:540
set verticalSpeed(value: number): void
Sets the vertical movement speed.
Parameters
- value: number
  The new vertical speed value
Returns void
- Defined in foundation/cameras/WalkThroughCameraController.ts:532

Methods

`Protected`_calcZFarInner

_calcZFarInner(camera: CameraComponent): 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:57

`Protected`_calcZNearInner

_calcZNearInner(
    camera: CameraComponent,
    eyePosition: Vector3,
    eyeDirection: Vector3,
): 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:24

getDirection

getDirection(): MutableVector3 | null
Gets the current camera direction.

Returns MutableVector3 | null
The current direction vector or null if not available
- Defined in foundation/cameras/WalkThroughCameraController.ts:508

getTargets

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

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

logic

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

registerEventListeners

registerEventListeners(eventTargetDom?: Document): void
Registers event listeners for mouse and keyboard input handling.
Parameters
- eventTargetDom: Document = document
  The DOM element to attach event listeners to, defaults to document
Returns void
Implementation of ICameraController.registerEventListeners
- Defined in foundation/cameras/WalkThroughCameraController.ts:130

reset

reset(): void
Resets the camera controller to its initial state.

Returns void
- Defined in foundation/cameras/WalkThroughCameraController.ts:344

setTarget

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

setTargets

setTargets(targetEntities: ISceneGraphEntity[]): void
Sets multiple target entities for the camera to focus on. Automatically adjusts movement speeds based on the size of the targets.
Parameters
- targetEntities: ISceneGraphEntity[]
  Array of entities to set as targets
Returns void
Implementation of ICameraController.setTargets
Overrides AbstractCameraController.setTargets
- Defined in foundation/cameras/WalkThroughCameraController.ts:586

tryReset

tryReset(): void
Attempts to reset the controller state. Currently not implemented.

Returns void
- Defined in foundation/cameras/WalkThroughCameraController.ts:339

unregisterEventListeners

unregisterEventListeners(): void
Unregisters all event listeners for this camera controller.

Returns void
Implementation of ICameraController.unregisterEventListeners
- Defined in foundation/cameras/WalkThroughCameraController.ts:242

Class WalkThroughCameraController

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WalkThroughCameraController

Properties

Protected__targetEntities

aabbWithSkeletal

autoCalculateZNearAndZFar

zFarScalingFactor

zNearMax

Accessors

allInfo

Returns any

Parameters

Returns void

horizontalSpeed

Returns number

Parameters

Returns void

mouseWheelSpeed

Returns number

Parameters

Returns void

updateCount

Returns number

verticalSpeed

Returns number

Parameters

Returns void

Methods

Protected_calcZFarInner

Parameters

Returns void

Protected_calcZNearInner

Parameters

Returns void

getDirection

Returns MutableVector3 | null

getTargets

Returns ISceneGraphEntity[]

logic

Parameters

Returns void

registerEventListeners

Parameters

Returns void

reset

Returns void

setTarget

Parameters

Returns void

setTargets

Parameters

Returns void

tryReset

Returns void

unregisterEventListeners

Returns void

Settings

On This Page

`Protected`__targetEntities

`Protected`_calcZFarInner

`Protected`_calcZNearInner