Interface SectionPlaneParams

interface SectionPlaneParams {
    active?: boolean;
    capColor?: Vec3;
    dir?: Vec3;
    id?: string;
    pos?: Vec3;
}

Properties

active?: boolean

Whether the SectionPlane is active or not.

Default value is true.

capColor?: Vec3

Optional RGB colour to use as a "cap fill" on the cross-section surface. Each channel in [0, 1]. When unset (the default), the plane behaves as a pure clipping plane — back-faces in the clipped half-space are discarded along with front-faces and the cut-away is empty.

When set, back-facing fragments in the clipped region survive and are recoloured with this value, producing a visible "fill" on the cut surface. The material's hatch pattern (if any) still applies, so masonry / steel / etc. cross-sections retain their conventional fill.

dir?: Vec3

3D direction of the SectionPlane.

Range is [-1..1, -1..1, -1..1].

Default value is [0.0, 0.0, -1.0].

id?: string

The unique ID of the SectionPlane.

pos?: Vec3

The World-space 3D position of the SectionPlane.

Default value is [0, 0, 0].