Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

ClipPlaneProperties

Type Alias ClipPlaneProperties

ClipPlaneProperties: {
    animation?: { name: string } & AnimationOptions | null;
    clippedNodes?: number[];
    enabled?: boolean;
    excludedNodes?: number[];
    invisible?: boolean;
    name?: string;
    normal?: [number, number, number] | Float32Array;
    position?: [number, number, number] | Float32Array;
    tangent?: [number, number, number] | Float32Array;
    thickness?: number;
    transform?:
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]
        | Float32Array;
}

Type declaration

  • Optionalanimation?: { name: string } & AnimationOptions | null

    TODO

  • OptionalclippedNodes?: number[]

    List of node IDs which should be exclusively clipped. The properties clippedNodes and excludedNodes are mutually exclusive.

    Default

    []
  • Optionalenabled?: boolean

    The enabled state of the clip plane.

    Default

    false
  • OptionalexcludedNodes?: number[]

    List of node IDs which should be excluded from the clipping. The properties clippedNodes and excludedNodes are mutually exclusive.

    Default

    []
  • Optionalinvisible?: boolean

    The invisible state of the clip plane.

    Default

    false
  • Optionalname?: string

    The name of the clip plane.

    Default

    undefined
  • Optionalnormal?: [number, number, number] | Float32Array

    The normal vector of the clip plane.

    Default

    [0, 1, 0]
  • Optionalposition?: [number, number, number] | Float32Array

    The position of the clip plane.

    Default

    [0,0,0]
  • Optionaltangent?: [number, number, number] | Float32Array

    The tangent vector of the clip plane.

    Default

    [1, 0, 0]
  • Optionalthickness?: number

    The thickness of the clip plane.

    Default

    0
  • Optionaltransform?:
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]
        | Float32Array

    The transformation matrix of the clip plane.

    Default

    [1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]