Skip to main content

LCC for Web Manual · v0.6.3 · Page 33 of 68

LCCObject::setClipBox

Performs box clipping on a single LCC model.

Can be used to clip irregular edges of the LCC model, or to control the display/hide of local scene areas, such as height clipping.

Version Requirement

SDK v0.5.2+

Engine Support

Three.js / CesiumJS

API

LCCObject::setClipBox(param?: ClipBoxParam): void

Parameters

ParameterTypeRequiredDefaultDescription
param.position{ x: number, y: number, z: number } / [number, number, number]No-Translate the clip box.
param.rotation{ x: number, y: number, z: number } / [number, number, number]No-Rotate the clip box, in radians.
param.scale{ x: number, y: number, z: number } / [number, number, number]No-Scale the clip box.
param.clipSide1 / -1No-Clip direction. 1: clip outside the box; -1: clip inside the box.

Return Value

void

Usage Example

Set Box Clipping

lccObject.setClipBox({
    scale: { x: 1, y: 1, z: 1 }, // or [1, 1, 1]
    position: { x: 0, y: 0, z: 0 }, // or [0, 0, 0]
    rotation: {
        x: Math.PI / 3,
        y: 0,
        z: 0
    }, // or [Math.PI / 3, 0, 0]
    clipSide: 1 // or -1
});

Clear Box Clipping

Set param to undefined to clear the current clipping.

lccObject.setClipBox(undefined);

Notes

  • This method can be called synchronously immediately after LCCRender.load().
  • LCCObject::setClipPlane()

XGRIDS documentation, reproduced as published and captured on October 27, 2026. Read this page on docs.xgrids.com

Stuck on a Step?

QRC supports every scanner and software seat it sells. Send us the page you are on and we will walk you through it.

Contact Us
Request a Quote