Documentation - v19.12.0-dev
    Preparing search index...

    Controller owning every ClippingPlane in the scene: creates them, adds their mesh to the internal three.js group, keeps the box tree in sync, and notifies the scene whenever the active set of clipping planes changes.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _objects: Map<string, ClippingPlane> = ...
    _viewer: Viewer
    isClippingPlaneController: true
    isSceneObjectController: true
    planeSize: number = 0
    signals: {
        onObjectAdded: ViewerSignal<(object: ClippingPlane) => void>;
        onObjectRemoved: ViewerSignal<(object: ClippingPlane) => void>;
        onObjectUpdated: ViewerSignal<(object: ClippingPlane) => void>;
        onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
    } = ...

    Accessors

    • get count(): number

      Controller objects count

      Returns number

    • get firstObject(): TObject | null

      Returns TObject | null

    • get uuids(): MapIterator<string>

      Iterator over all the uuids contained in the controller.

      Returns MapIterator<string>

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Controller visibility (independant from object own visibility).

      Hiding a controller will hide all its children without modifying their own visibility.

      Parameters

      • value: boolean

      Returns void

    Methods

    • To be implemented by controllers to set global visibility (at controller level)

      Parameters

      • value: boolean

      Returns void

    • Indicates whether the controller accepts the SceneObject as a potential child.

      Parameters

      Returns boolean

    • Adds the given object to the controller. Controllers may not support object hierarchy.

      Parameters

      • object: ClippingPlane

        The object to add.

      • parentUuid: string | null

        The parent uuid of the object if the controller supports it.

      Returns void

    • Clears all objects from the controller

      Returns void

    • Disposes the controller and destroy its data

      Returns void

    • Returns a generator of hidden object uuids of this controller

      Returns Generator<string>

    • Returns a generator of object uuids of this controller

      Returns Generator<string>

    • Returns a generator if visible object uuids of this controller

      Returns Generator<string>

    • Returns whether the controller has the given uuid

      Parameters

      • uuid: string

      Returns boolean

    • Returns Generator<Plane, void, unknown>