Documentation - v20.0.0-dev
    Preparing search index...

    A plane cutting the scene: its plane, placed by its matrix (its local z axis the normal, its position a point of the plane). In the scene, it holds its engine plane (proxy, added by its controller), which cuts the scene and which the engine scene's cuttingPlanesHelper draws (see ClippingPlaneController).

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    children: SceneObject[] = ...
    controller: SceneObjectController<SceneObject> | null = null

    The controller handling it while it is in the scene, set when that controller adds it (see SceneObjectController.addObject); null out of the scene.

    isClippingPlane: true
    isRaycastable: boolean = true

    Whether the viewport's picking may hit it.

    isSceneObject: true
    isSelectable: boolean = true

    Indicates whether the object is selectable in the scene

    isTransformable: boolean = true
    name: "ClippingPlane" = 'ClippingPlane'
    parent: SceneObject | null = null
    plane: Plane = ...

    The plane cutting the scene, in world coordinates.

    The axis its normal is the nearest to.

    userData: Record<string, any> = {}
    uuid: string

    Unique identifier of the object

    Accessors

    • get active(): boolean

      Returns boolean

    • get layer(): MeshLayer

      The layer it is drawn in (the engine's MeshLayer, Layer1 by default): a layer is drawn over the layers below it, whatever their depth. Given to its engine objects; kept only by an object without.

      Returns MeshLayer

    • set layer(value: MeshLayer): void

      Parameters

      Returns void

    • get proxy(): CuttingPlaneProxy | null

      Its engine plane while in the scene (its owner this plane); null out of it.

      Returns CuttingPlaneProxy | null

    • get selected(): boolean

      Returns boolean

    • set selected(value: boolean): void

      Whether it is selected; its controller's onObjectSelectedChanged tells a change.

      Parameters

      • value: boolean

      Returns void

    • get type(): string

      Returns string

    • get visible(): boolean

      Whether it is shown; its controller's onObjectVisibilityChanged tells a change.

      Returns boolean

    • set visible(value: boolean): void

      Whether its plane is drawn; it cuts either way.

      Parameters

      • value: boolean

      Returns void

    Methods

    • Its state for toJson: a subclass adds its own after these.

      Returns Record<string, unknown>

    • The sections of its type for toJson, after its transform: none here.

      Returns Record<string, unknown>

    • Returns void

    • Its bounds as drawn across the scene's (see ClippingPlaneController.getPlaneBoundingBox); its position alone out of the scene.

      Parameters

      Returns Box3

    • Returns void

    • Places it, without scale; cuts the scene there.

      Parameters

      Returns void

    • Everything about it for a debug view (the infobox's 3D data), in sections and in this order: identity, state, transform, its type's own sections (_getTypeJson: a mesh's material, edges and engine objects), userData, and its children by name, uuid and type. Not a persistence format.

      Returns Record<string, any>