ClipPlaneProperties

Interface ClipPlaneProperties

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

Properties

animation? clippedNodes? enabled? excludedNodes? invisible? name? normal? position? tangent? thickness? transform?

Properties

Optionalanimation

animation?: { name: string } & AnimationOptions

TODO

OptionalclippedNodes

clippedNodes?: number[]

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

Default

[]

Optionalenabled

enabled?: boolean

The enabled state of the clip plane.

Default

false

OptionalexcludedNodes

excludedNodes?: number[]

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

Default

[]

Optionalinvisible

invisible?: boolean

The invisible state of the clip plane.

Default

false

Optionalname

name?: string

The name of the clip plane.

Default

undefined

Optionalnormal

normal?: Float32Array<ArrayBufferLike> | [number, number, number]

The normal vector of the clip plane.

Default

[0, 1, 0]

Optionalposition

position?: Float32Array<ArrayBufferLike> | [number, number, number]

The position of the clip plane.

Default

[0,0,0]

Optionaltangent

tangent?: Float32Array<ArrayBufferLike> | [number, number, number]

The tangent vector of the clip plane.

Default

[1, 0, 0]

Optionalthickness

thickness?: number

The thickness of the clip plane.

Default

0

Optionaltransform

transform?:
    | Float32Array<ArrayBufferLike>
    | [
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
    ]

The transformation matrix of the clip plane.

Default

[1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]
Did you find this page useful? Please give it a rating:
★ ★ ★ ★ ★
Thank you for rating this page!
Any issues or feedback?
What kind of problem would you like to report?
Please tell us more about what's wrong: