TwinfinityCameraExtensions

Includes methods and properties for querying and manipulating a Camera instance.

Hierarchy

• TwinfinityCameraExtensions
  • TwinfinityTargetCameraExtensions

Index

Properties

• hasMovedInCurrentFrame
• perspectiveDistanceFromOrtho

Accessors

• viewer

Methods

• clearHasMovedInCurrentFrame
• createPickingRayToRef
• getFrustumToRef
• getOrthoFrustumSizeToRef
• pick
• setOrtho
• stateSnapshot

Properties

readonlyhasMovedInCurrentFrame

hasMovedInCurrentFrame: boolean

true if the camera has somehow moved during this frame. Otherwise false. Will automatically be reset to false after each frame has rendered (if camera is used by TwinfinityViewer).

readonlyperspectiveDistanceFromOrtho

perspectiveDistanceFromOrtho: number

Gets the distance that the camera has to be positioned at (perpendicular to pivot plane) when in perspective mode to get approximately the same view. The objects in the center of the frustum will appear to have almost the same size.

Accessors

viewer

• get viewer(): undefined | TwinfinityViewer

• Twinfinity viewer instance.

  ---

  Returns undefined | TwinfinityViewer

Methods

clearHasMovedInCurrentFrame

• clearHasMovedInCurrentFrame(): void

• Sets hasMovedInCurrentFrame to false.

  ---

  Returns void

createPickingRayToRef

• createPickingRayToRef(dst: Ray, o: CanvasPosition): Ray

• Creates a ray from the camera through the screen coordinate defined by screenPos. This ray is useful for pick operations.

  ---

  Parameters

  • dst: Ray

    Ray is written here.

  • o: CanvasPosition

  Returns Ray

getFrustumToRef

• getFrustumToRef(dst: FrustumPlanes): FrustumPlanes

• Gets the camera frustum planes

  ---

  Parameters

  • dst: FrustumPlanes

    Camera frustum planes are written

  Returns FrustumPlanes

  Frustum planes (same reference as dst)

getOrthoFrustumSizeToRef

• getOrthoFrustumSizeToRef(dst: Vertex2): Vertex2

• Gets the size of the orthographic frustm (defined by Camera.orthoBottom, Camera.orthoTop, Camera.orthoLeft, Camera.orthoRight).

  ---

  Parameters

  • dst: Vertex2

    Size is written here,. x is width and yi is height.

  Returns Vertex2

  dst.

pick

• pick(o: PickOption): PickResult

• Performs intersection testing against objects in the scene from the cameras point of view.

  ---

  Parameters

  • o: PickOption

    See PickOption.

  Returns PickResult

setOrtho

• setOrtho(o: { distance: number } | { height: number }): void

• Sets the orthographic frustum based on either distance or height

  ---

  Parameters

  • o: { distance: number } | { height: number }

    Sets orthographic frustum based on either distance or height. If height then Camera.orthoBottom = -height / 2 and Camera.orthoTop is set to height / 2. Camera.orthoLeft and Camera.orthoRight is then calculated using the aspect ratio.- If distance then frustum is sized optimally so a object in center of camera at distance will get approx the same size as it would with the perspective camera.

  Returns void

stateSnapshot

• stateSnapshot(): TwinfinityCameraStateSnapshot

• Gets a TwinfinityState instance which can be used to check if a camera has changed since a previous check.

  ---

  Returns TwinfinityCameraStateSnapshot