Class: ClipPlaneSet

Defined in: utils/ClipPlane.ts:277

Manages multiple clip planes for a surface.

Provides convenience methods for common clipping operations and synchronizes with both CPU and GPU rendering modes.

Constructors

Constructor

new ClipPlaneSet(): ClipPlaneSet;

Defined in: utils/ClipPlane.ts:286

Returns

ClipPlaneSet

Properties

x

readonly x: ClipPlane;

Defined in: utils/ClipPlane.ts:279

Clip planes indexed by axis

---

y

readonly y: ClipPlane;

Defined in: utils/ClipPlane.ts:280

---

z

readonly z: ClipPlane;

Defined in: utils/ClipPlane.ts:281

Methods

setClipPlane()

setClipPlane(
   axis, 
   distance, 
   enabled?, 
   flip?
): this;

Defined in: utils/ClipPlane.ts:301

Set a clip plane by axis.

Parameters

axis

ClipAxis

Which axis to clip

distance

number

Distance from origin

enabled?

boolean = true

Whether to enable (default: true)

flip?

boolean = false

Flip clipping direction (default: false)

Returns

this

---

getClipPlane()

getClipPlane(axis): ClipPlane;

Defined in: utils/ClipPlane.ts:316

Get clip plane by axis.

Parameters

axis

ClipAxis

Returns

ClipPlane

---

enableClipPlane()

enableClipPlane(axis): this;

Defined in: utils/ClipPlane.ts:323

Enable a clip plane.

Parameters

axis

ClipAxis

Returns

this

---

disableClipPlane()

disableClipPlane(axis): this;

Defined in: utils/ClipPlane.ts:331

Disable a clip plane.

Parameters

axis

ClipAxis

Returns

this

---

clearClipPlanes()

clearClipPlanes(): this;

Defined in: utils/ClipPlane.ts:339

Disable all clip planes.

Returns

this

---

getThreePlanes()

getThreePlanes(): Plane[];

Defined in: utils/ClipPlane.ts:348

Get all enabled clip planes as Three.js Plane array. For use with material.clippingPlanes.

Returns

Plane[]

---

getAllPlanes()

getAllPlanes(): ClipPlane[];

Defined in: utils/ClipPlane.ts:357

Get all clip planes (enabled and disabled).

Returns

ClipPlane[]

---

getEnabledPlanes()

getEnabledPlanes(): ClipPlane[];

Defined in: utils/ClipPlane.ts:364

Get enabled planes only.

Returns

ClipPlane[]

---

hasEnabledPlanes()

hasEnabledPlanes(): boolean;

Defined in: utils/ClipPlane.ts:371

Check if any clip plane is enabled.

Returns

boolean

---

toStateJSON()

toStateJSON(): object[];

Defined in: utils/ClipPlane.ts:375

Returns

object[]

---

getShaderUniforms()

getShaderUniforms(): object;

Defined in: utils/ClipPlane.ts:382

Get shader uniforms for all three planes.

Returns

object

clipPlaneX

clipPlaneX: object;

clipPlaneX.normal

normal: Vector3;

clipPlaneX.point

point: Vector3;

clipPlaneX.enabled

enabled: boolean;

clipPlaneY

clipPlaneY: object;

clipPlaneY.normal

normal: Vector3;

clipPlaneY.point

point: Vector3;

clipPlaneY.enabled

enabled: boolean;

clipPlaneZ

clipPlaneZ: object;

clipPlaneZ.normal

normal: Vector3;

clipPlaneZ.point

point: Vector3;

clipPlaneZ.enabled

enabled: boolean;