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

    Class Default

    Hierarchy (View Summary)

    Index
    automaticInteractorVisibility: boolean

    if enabled visibility of move and rotate interactors depend on camera view angle (default: true)

    deselectionEnabled: boolean

    if false deselection is not possible, atleast one element always stays selected

    eventBackgroundClick: ListenableEvent<void, SelectionDefault> = ...

    Will be triggered (after the double click delay) if the user clicks/tabs on the background and there is currently no selection.

    eventBackgroundClickImmediate: ListenableEvent<void, SelectionDefault> = ...

    Will be triggered immediately if the user clicks/tabs on the background and there is currently no selection.

    eventElementClick: ListenableEvent<SceneElement, SelectionDefault> = ...

    Will be triggered if the user clicks/tabs on a SceneElement.

    eventMultiSelectModeChanged: ListenableEvent<void, SelectionDefault> = ...

    Will be triggered if the state of the multi selection mode has changed.

    eventRectangleSelectFinished: ListenableEvent<void, SelectionDefault> = ...
    eventStarted: ListenableEvent<void, Tool> = ...
    eventStopped: ListenableEvent<void, Tool> = ...
    groundYPosition: number

    Y position of the ground

    leftMouseButtonRectangleSelectEnabled: boolean

    If true the rectangle selection will be started using with left mouse button. (default: false) The flag view.CameraControl.leftMouseButtonEnabled should be set to false in this case. Note: One finger touch will not start rectangle selection.

    moveLimitMax: Vector3

    Defines the limit for the object movement in positive direction for each axis. (default: [20, 20, 20])

    moveLimitMin: Vector3

    Defines the limit for the object movement in negative direction for each axis. (default: [-20, -20, -20])

    moveXZEnabled: boolean

    enable/disable move on XZ-plane

    moveYBelowGroundEnabled: boolean

    if disabled it is not possible to move the object below the ground

    moveYEnabled: boolean

    enable/disable move along Y-axis

    mPickedElement: SceneElement | null
    mPickedPos: Vector3
    mSelection: SceneElement[]
    mSelectionInfo: SelectionInfo
    multiSelectAutoStartEnabled: boolean

    if true the multi selection mode is started automatically if the user pressed ctrl or used long touch on an element (default: false)

    multiSelectDeselectAllEnabled: boolean

    if false its not possible to deselect all elements by clicking on the background in multi select mode (default: true)

    mView: View
    rectangleSelectMode: RectangleSelectMode

    Selection mode of the rectangle select tool (default: Complete)

    rotateXEnabled: boolean

    enable/disable rotation around X-axis

    rotateYEnabled: boolean

    enable/disable rotation around Y-axis

    rotateZEnabled: boolean

    enable/disable rotation around Z-axis

    subElementSelectionEnabled: boolean

    enable/disable selection of sub elements

    • get multiSelectMode(): boolean

      Returns boolean

    • set multiSelectMode(pEnabled: boolean): void

      Parameters

      • pEnabled: boolean

      Returns void

    • get showElementInteractors(): boolean

      Returns boolean

    • set showElementInteractors(pShow: boolean): void

      Parameters

      • pShow: boolean

      Returns void

    • get showMainElementSelection(): boolean

      Returns boolean

    • set showMainElementSelection(pShow: boolean): void

      Parameters

      • pShow: boolean

      Returns void

    • get showSubElementSelection(): boolean

      Returns boolean

    • set showSubElementSelection(pShow: boolean): void

      Parameters

      • pShow: boolean

      Returns void

    • Parameters

      • pEvent: MouseEvent | KeyboardEvent

      Returns boolean

    • Should return true if the tool is running. False should be returned after a call to stop() or if the tool is finished with its operations.

      Returns boolean

    • Starts the tool. Returns false if the start was canceled/aborted.

      Parameters

      • pParameter: unknown

      Returns boolean