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

  • Optional animation?: {
        name: string;
    } & AnimationOptions | null

    TODO

  • Optional clippedNodes?: number[]

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

    Default

    []
  • Optional enabled?: boolean

    The enabled state of the clip plane.

    Default

    false
  • Optional excludedNodes?: number[]

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

    Default

    []
  • Optional invisible?: boolean

    The invisible state of the clip plane.

    Default

    false
  • Optional name?: string

    The name of the clip plane.

    Default

    undefined
  • Optional normal?: [number, number, number] | Float32Array

    The normal vector of the clip plane.

    Default

    [0, 1, 0]
  • Optional position?: [number, number, number] | Float32Array

    The position of the clip plane.

    Default

    [0,0,0]
  • Optional tangent?: [number, number, number] | Float32Array

    The tangent vector of the clip plane.

    Default

    [1, 0, 0]
  • Optional thickness?: number

    The thickness of the clip plane.

    Default

    0
  • Optional transform?: [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]