@stereograph/teiaviewer - v17.8.0-dev
    Preparing search index...

    Class ClippingPlane

    SceneMesh can contain triangles and/or lines representing the edges.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    children diffuseColor edgesColor edgesOpacity emissiveColor isClippingPlane isMovable isRaycastable isSceneMesh isSceneObject isSelectable mesh metalness name parent plane planeType roughness showInfoboxOnClick signals userData uuid xRay TRANSPARENCY_THRESHOLD

    Accessors

    active areEdgesTransparent isTransparent opacity selected type visible

    Methods

    addChild applyMatrix copyMaterials dispose getBoundingBox getBoundingSphere getGizmoController getMatrix getPosition getStateController parentsGenerator raycast removeFromParent setMatrix setPosition setSize showBoundingBoxHelper showNormalsHelper toJson

    Constructors

    Properties

    children: SceneObject[] = ...
    diffuseColor: ColorRepresentation = 0xffffff
    edgesColor: 0 = 0x000000
    edgesOpacity: 1
    emissiveColor: 0 = 0x000000

    Basic material doesn't have an emissive color

    isClippingPlane: true
    isMovable: true

    Indicates whether the object can be transformed in the scene

    isRaycastable: true
    isSceneMesh: true
    isSceneObject: true
    isSelectable: boolean = true

    Indicates whether the object is selectable in the scene

    mesh: Mesh
    metalness: 0

    Basic material doesn't have a metalness

    name: "Clipping plane object" = 'Clipping plane object'
    parent: null | SceneObject = null
    plane: Plane
    planeType: ClippingPlaneType
    roughness: 1

    Basic material doesn't have a roughness

    showInfoboxOnClick: false

    Indicates whether the object should open an infobox on click

    signals: {
        onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
        onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
    } = ...
    userData: Record<string, any> = {}
    uuid: string

    Unique identifier of the object

    xRay: boolean = false
    TRANSPARENCY_THRESHOLD: 0.95

    Accessors

    • get active(): boolean

      Returns boolean

    • get areEdgesTransparent(): boolean

      Returns boolean

    • get isTransparent(): boolean

      Returns boolean

    • get opacity(): number

      Returns number

    • set opacity(value: number): void

      Parameters

      • value: number

      Returns void

    • get selected(): boolean

      Returns boolean

    • set selected(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get type(): string

      Returns string

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Parameters

      • matrix: Matrix4

      Returns void

    • Returns void

    • Parameters

      • box: Box3

      Returns Box3

    • Parameters

      • sphere: Sphere

      Returns Sphere

    • Parameters

      • target: Matrix4

      Returns Matrix4

    • Parameters

      • target: Vector3

      Returns Vector3

    • Returns void

    • Parameters

      • matrix: Matrix4

      Returns void

    • Parameters

      • position: Vector3

      Returns void

    • Parameters

      • size: number

      Returns void

    • Parameters

      • helperGroup: Group
      • value: boolean

      Returns void

    • Parameters

      • helperGroup: Group
      • value: boolean

      Returns void

    • Returns Record<string, any>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods