Class CameraMovement`Abstract`

Hierarchy (View Summary)

CameraMovement
- CameraLerp
- CameraMovementSnap

Index

Constructors

constructor

Methods

frame move1 move2 move3 orbit orbitTowards reset rotate set setDistance target zoom

Constructors

constructor

new CameraMovement(
    camera: Core.Webgl.Camera,
    savedState: CameraSaveState,
    getBoundingBox: () => Box3,
): CameraMovement
Parameters
- camera: Core.Webgl.Camera
- savedState: CameraSaveState
- getBoundingBox: () => Box3
Returns CameraMovement
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:20

Methods

frame

frame(
target: "all" | Box3 | Sphere | Core.Webgl.Vim | Selectable,
forward?: Vector3,
): Promise<void>
Sets the camera's orientation and position to focus on the specified target.
Parameters
- target: "all" | Box3 | Sphere | Core.Webgl.Vim | Selectable
  The target object, or 'all' to frame all objects.
- Optionalforward: Vector3
  Optional forward direction after framing.
Returns Promise<void>
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:153

move1

move1(amount: number, axis: "X" | "Y" | "Z"): void
Moves the camera along a specified axis by a given amount.
Parameters
- amount: number
  The amount to move the camera.
- axis: "X" | "Y" | "Z"
  The axis along which to move the camera ('X', 'Y', or 'Z').
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:53

move2

move2(vector: Vector2, axes: "XY" | "XZ"): void
Moves the camera in a specified 2D direction within a plane defined by the given axes.
Parameters
- vector: Vector2
  The 2D vector representing the direction of movement.
- axes: "XY" | "XZ"
  The axes defining the plane of movement ('XY' or 'XZ').
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:37

`Abstract`move3

move3(vector: Vector3): void
Moves the camera by the specified 3D vector.
Parameters
- vector: Vector3
  The 3D vector representing the direction and distance of movement.
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:30

`Abstract`orbit

orbit(vector: Vector2): void
Orbits the camera around its target by the given angle while maintaining the distance.
Parameters
- vector: Vector2
  The 2D vector representing the orbit angles around the X and Y axes.
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:85

orbitTowards

orbitTowards(direction: Vector3): void
Orbits the camera around its target to align with the given direction.
Parameters
- direction: Vector3
  The direction towards which the camera should be oriented.
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:91

reset

reset(): void
Resets the camera to its last saved position and orientation.

Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:137

`Abstract`rotate

rotate(angle: Vector2): void
Rotates the camera by the specified angles.
Parameters
- angle: Vector2
  The 2D vector representing the rotation angles around the X and Y axes.
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:67

`Abstract`set

set(position: Vector3, target?: Vector3): any
Moves both the camera and its target to the given positions.
Parameters
- position: Vector3
  The new position of the camera.
- Optionaltarget: Vector3
  The new position of the target (optional).
Returns any
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:146

`Abstract`setDistance

setDistance(dist: number): void
Sets the distance between the camera and its target to the specified value.
Parameters
- dist: number
  The new distance between the camera and its target.
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:79

`Abstract`target

target(target: Vector3 | Core.Webgl.Element3D): void
Rotates the camera without moving so that it looks at the specified target.
Parameters
- target: Vector3 | Core.Webgl.Element3D
  The target object or position to look at.
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:132

`Abstract`zoom

zoom(amount: number): void
Changes the distance between the camera and its target by a specified factor.
Parameters
- amount: number
  The factor by which to change the distance (e.g., 0.5 for halving the distance, 2 for doubling the distance).
Returns void
- Defined in src/vim-web/core-viewers/webgl/viewer/camera/cameraMovement.ts:73

Class CameraMovementAbstract

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CameraMovement

Methods

frame

Parameters

Returns Promise<void>

move1

Parameters

Returns void

move2

Parameters

Returns void

Abstractmove3

Parameters

Returns void

Abstractorbit

Parameters

Returns void

orbitTowards

Parameters

Returns void

reset

Returns void

Abstractrotate

Parameters

Returns void

Abstractset

Parameters

Returns any

AbstractsetDistance

Parameters

Returns void

Abstracttarget

Parameters

Returns void

Abstractzoom

Parameters

Returns void

Settings

On This Page

Class CameraMovement`Abstract`

`Abstract`move3

`Abstract`orbit

`Abstract`rotate

`Abstract`set

`Abstract`setDistance

`Abstract`target

`Abstract`zoom