W-CF Documentation - v11.0.0
    Preparing search index...

    Implements

    Index
    controlsEnabled: boolean
    dblClickZoomToFitEnabled: boolean
    dblClickZoomToFitOptions: CameraZoomToFitOptions
    eventCameraChanged: ListenableEvent<void, CameraControl> = ...
    eventCameraModeChanged: ListenableEvent<void, CameraControl> = ...
    leftMouseButtonEnabled: boolean

    Can be used to disable camera navigation with left mouse button. This way the left mouse button is free to use for other interactions. Note: One finger touch navigation or LMB + SHIFT will still be possible. (Default: true)

    orbitEnabled: boolean
    orbitSpeed: number
    orthoOrbitSnappingEnabled: boolean

    Enables snapping for the orthographic camera mode during orbit. (Default: false)

    panningEnabled: boolean
    pitchMax: number
    pitchMin: number
    touchZoomSpeed: number
    wheelZoomSpeed: number
    yawMax: number
    yawMin: number
    zoomEnabled: boolean
    DEFAULT_CAMERA_ORTHO: number = 3.0

    Default camera ortho/zoom. Used for all camera modes except Perspective.

    DEFAULT_CAMERA_POSITION: Vector3 = ...

    Default camera position. Used for camera modes Orthographic and Perspective.

    • get direction(): Vector3

      Returns Vector3

    • get fixedTarget(): Vector3 | null

      Returns Vector3 | null

    • Returns { center: Vector3; radius: number }

    • get orbitInertia(): number

      Returns number

    • set orbitInertia(pValue: number): void

      Parameters

      • pValue: number

      Returns void

    • get position(): Vector3

      Returns Vector3

    • get right(): Vector3

      Returns Vector3

    • get transformMatrix(): Matrix

      Returns Matrix

    • get viewPlane(): Plane

      Returns Plane

    • Returns void

    • Copies the camera settings (position, direction, target, mode ...) from the given CameraControl to this.

      Parameters

      Returns void

    • Returns void

    • Returns Plane[]

    • Parameters

      • pTriggerChangeEvent: boolean = true

      Returns void

    • Parameters

      • pResetOrthoZoom: boolean
      • pResetCameraModeSettings: boolean

      Returns void

    • Parameters

      • pOrthoTop: number

      Returns void

    • Parameters

      • pDirection: Vector3
      • OptionalpUpVector: Vector3

      Returns boolean

    • Parameters

      • pFixedTarget: Vector3 | null

      Returns boolean

    • Parameters

      • pFov: number

      Returns void

    • The navigation area is used to limit certain camera interactions. E.g. the maximum camera distance (zoom) depends on it. The area will not be updated automatically, it should be defined by the host application.

      Parameters

      • pRadius: number
      • pCenter: Vector3 = ...

      Returns void

    • Parameters

      • pPosition: Vector3
      • pKeepFixedTarget: boolean = true

      Returns void

    • Parameters

      • pTarget: Vector3
      • OptionalpUpVector: Vector3

      Returns boolean

    • Returns void

    • Performs a zoom step targeting the view center with the given amount. Use a positive amount to zoom out and a negative amount to zoom in. The amount typically should be in range [-1.0, 1.0]. 0.15 can be used as a reference value.

      Parameters

      • pAmount: number

      Returns void

    • Parameters

      • pMesh: AbstractMesh

      Returns number | null

    • Parameters

      • pMesh: AbstractMesh
      • pMask: number | null

      Returns void