Class CameraLerp

Hierarchy

CameraMovement
- CameraLerp

Index

Constructors

Properties

_camera _clock _duration _movement onProgress

Methods

animate cancel easeOutCubic frame frameSphere init move1 move2 move3 orbit orbitTowards reset rotate set setDistance target update zoom

Constructors

constructor

new CameraLerp(camera: Camera, movement: CameraMovementSnap): CameraLerp
Parameters
- camera: Camera
- movement: CameraMovementSnap
Returns CameraLerp
Overrides CameraMovement.constructor
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:20

Properties

`Protected` _camera

_camera: Camera

_clock

_clock: Clock = ...

_duration

_duration: number = 1

_movement

_movement: CameraMovementSnap

onProgress

onProgress: ((progress: number) => void)

Type declaration

- (progress: number): void
- Parameters
  - progress: number
  Returns void

Methods

animate

animate(): void
Returns void
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:37

cancel

cancel(): void
Returns void
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:32

easeOutCubic

easeOutCubic(x: number): number
Parameters
- x: number
Returns number
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:44

frame

frame(target: "all" | Box3 | Sphere | Vim | IObject, forward?: Vector3): void
Sets the camera's orientation and position to focus on the specified target.
Parameters
- target: "all" | Box3 | Sphere | Vim | IObject
  
  The target object, or 'all' to frame all objects.
- Optional forward: Vector3
  
  Optional forward direction after framing.
Returns void
Inherited from CameraMovement.frame
- Defined in src/vim-webgl-viewer/camera/cameraMovement.ts:144

`Protected` frameSphere

frameSphere(sphere: Sphere, forward?: Vector3): void
Parameters
- sphere: Sphere
- Optional forward: Vector3
Returns void
Inherited from CameraMovement.frameSphere
- Defined in src/vim-webgl-viewer/camera/cameraMovement.ts:166

init

init(duration: number): void
Parameters
- duration: number
Returns void
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:25

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
Inherited from CameraMovement.move1
- Defined in src/vim-webgl-viewer/camera/cameraMovement.ts:46

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
Inherited from CameraMovement.move2
- Defined in src/vim-webgl-viewer/camera/cameraMovement.ts:30

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
Overrides CameraMovement.move3
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:59

orbit

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

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
Inherited from CameraMovement.orbitTowards
- Defined in src/vim-webgl-viewer/camera/cameraMovement.ts:84

reset

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

Returns void
Overrides CameraMovement.reset
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:141

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
Overrides CameraMovement.rotate
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:73

set

set(position: Vector3, target?: Vector3): void
Moves both the camera and its target to the given positions.
Parameters
- position: Vector3
  
  The new position of the camera.
- Optional target: Vector3
  
  The new position of the target (optional).
Returns void
Overrides CameraMovement.set
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:145

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
Overrides CameraMovement.setDistance
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:102

target

target(target: Vector3 | Object): void
Rotates the camera without moving so that it looks at the specified target.
Parameters
- target: Vector3 | Object
  
  The target object or position to look at.
Returns void
Overrides CameraMovement.target
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:127

update

update(): void
Returns void
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:48

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
Overrides CameraMovement.zoom
- Defined in src/vim-webgl-viewer/camera/cameraMovementLerp.ts:97

Class CameraLerp

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

camera: Camera

movement: CameraMovementSnap

Returns CameraLerp

Properties

Protected _camera

_clock

_duration

_movement

onProgress

Type declaration

Parameters

progress: number

Returns void

Methods

animate

Returns void

cancel

Returns void

easeOutCubic

Parameters

x: number

Returns number

frame

Parameters

target: "all" | Box3 | Sphere | Vim | IObject

Optional forward: Vector3

Returns void

Protected frameSphere

Parameters

sphere: Sphere

Optional forward: Vector3

Returns void

init

Parameters

duration: number

Returns void

move1

Parameters

amount: number

axis: "X" | "Y" | "Z"

Returns void

move2

Parameters

vector: Vector2

axes: "XY" | "XZ"

Returns void

move3

Parameters

vector: Vector3

Returns void

orbit

Parameters

angle: Vector2

Returns void

orbitTowards

Parameters

direction: Vector3

Returns void

reset

Returns void

rotate

Parameters

angle: Vector2

Returns void

set

Parameters

position: Vector3

Optional target: Vector3

Returns void

setDistance

Parameters

`Protected` _camera

`Optional` forward: Vector3

`Protected` frameSphere

`Optional` forward: Vector3

`Optional` target: Vector3