BimCamera

Index

Accessors

• cameraOptions
• mode
• pivotOptions

Methods

• attachBehavior
• defaultView
• detachBehavior
• forwardVector
• getViewAsString
• lock
• lookAt
• lookFrom
• setLock
• setMode
• setPivot
• setProjection
• setViewFromString
• unlock
• zoomToExtent

Accessors

publiccameraOptions

• get cameraOptions(): CameraOptions

• Gets or sets options for camera pivot control.

  ---

  Returns CameraOptions

publicmode

• get mode(): CameraMode
• set mode(mode: CameraMode): void

• Gets the camera mode (pivot, fps or all). See CameraMode for more information

  ---

  Returns CameraMode

• Sets the camera mode (pivot, fps or all). See CameraMode for more information

  ---

  Parameters

  • mode: CameraMode

  Returns void

publicpivotOptions

• get pivotOptions(): CameraOptions

• @deprecated

  Same as cameraOptions.

  ---

  Returns CameraOptions

Methods

publicattachBehavior

• attachBehavior(behavior: TwinfinityCameraBehavior): boolean

• Attaches a behavior to the camera.

  ---

  Parameters

  • behavior: TwinfinityCameraBehavior

    The behavior to be attached to the camera.

  Returns boolean

  true if the behavior was successfully attached to the camera, otherwise false.

publicdefaultView

• defaultView(direction?: CameraDirection): void

• Resets the camera to the default view. Camera is positioned to view entire building

  ---

  Parameters

  • optionaldirection: CameraDirection

    Optional. Direction camera should look at building from. Default is a angled top position.

  Returns void

publicdetachBehavior

• detachBehavior(behavior: TwinfinityCameraBehavior): boolean

• Detaches a behavior from the camera.

  ---

  Parameters

  • behavior: TwinfinityCameraBehavior

    The behavior to be detached from the camera.

  Returns boolean

  true if the behavior was successfully detached to the camera, otherwise false.

publicforwardVector

• forwardVector(): Vector3

• Returns camera forward vector.

  ---

  Returns Vector3

publicgetViewAsString

• getViewAsString(): string

• Returns the current camera position and target as a string

  ---

  Returns string

publiclock

• lock(): void

• @deprecated

  Use cameraOptions instead Locks camera to prevent user interaction.

  ---

  Returns void

publiclookAt

• lookAt(eye: Vector3, target: Vector3): void

• Sets camera position at eye and rotation to look towards target.

  ---

  Parameters

  • eye: Vector3

    Point to look from.

  • target: Vector3

    Point to look towards.

  Returns void

publiclookFrom

• lookFrom(direction: CameraDirection): void

• Sets camera rotation to look towards the specified direction and zooms to extent of visible objects.

  ---

  Parameters

  • direction: CameraDirection

    The direction to look from (top = -Z, bottom = +Z, front = +Y, back = -Y, left = +X, right = -X).

  Returns void

publicsetLock

• setLock(locked: boolean): void

• @deprecated

  Use cameraOptions instead Sets whether camera should prevent user interaction or not.

  ---

  Parameters

  • locked: boolean

    Whether camera should be locked or not.

  Returns void

publicsetMode

• setMode(mode: CameraMode): void

• @deprecated

  Use the mode property instead Sets camera mode.

  ---

  Parameters

  • mode: CameraMode

    The camera mode to set.

  Returns void

publicsetPivot

• setPivot(mode: Auto): void
• setPivot(mode: Fixed, pivot: Vector3 | BimIfcObject): void

• Sets the pivot point to be either based on mouse cursor position (Auto) or a fixed point (Fixed).

  ---

  Parameters

  • mode: Auto

    Whether to use a cursor-based pivot point (Auto) or a fixed pivot point (Fixed).

  Returns void

publicsetProjection

• setProjection(projection: CameraProjection): void

• Sets camera projection.

  ---

  Parameters

  • projection: CameraProjection

    The camera projection to set.

  Returns void

publicsetViewFromString

• setViewFromString(viewString: string): void

• Sets the camera’s position and target from given string

  ---

  Parameters

  • viewString: string

    A string generated by getViewAsString

  Returns void

publicunlock

• unlock(): void

• @deprecated

  Use Use cameraOptions instead Unlocks camera to allow for user interaction.

  ---

  Returns void

publiczoomToExtent

• zoomToExtent(extent: Bound, direction?: CameraDirection): void

• Zooms camera to the extent of the specified bounding box.

  ---

  Parameters

  • extent: Bound

    Bounding box in format [minX, minY, minZ, maxX, maxY, maxZ].

  • optionaldirection: CameraDirection

    [Optional]. If set, the camera is positioned according to the direction during zoom. Otherwise, the current direction is kept.

  Returns void