SectionPlaneRef

A lightweight placeholder for a SectionPlane that hasn’t been fully loaded yet.

When you create section planes inside a SketchupOperation, the API returns SectionPlaneRef objects immediately, before SketchUp has finished processing the geometry. You can often pass these refs to other operation methods, but if you need the full SectionPlane instance, you can request it with entityForRef().

Section planes cut through the model to reveal internal structure — like slicing a building to show a floor plan. The plane is defined by coefficients [a, b, c, d] that describe the equation ax + by + cz + d = 0.

Think of a ref as a “claim ticket” — it guarantees a section plane will exist after the operation commits, but it doesn’t carry the plane’s properties (active state, plane coefficients, etc.) yet. A ref is only valid inside the performOperation callback that created it — do not return it or use it after the operation commits.

Example

let model = await SketchUpApi.getActiveModel();

// Make section cuts visible in the viewport
await model.updateRenderingOptions({
  DisplaySectionCuts: true,
  DisplaySectionPlanes: true,
});

await model.performOperation(async op => {
  // Plane equation: ax + by + cz + d = 0
  // [0, 0, 1, -30] = horizontal cut at z = 30
  const planeRef = op.createSectionPlane(
    model, [0, 0, 1, -30]
  );
  op.sectionPlaneActivate(planeRef);
}, 'Create active section plane');

See

Since

SDK 2.16.0 Protocol 1.13.0

Properties

sketchupId

readonly sketchupId: SketchupId

type

readonly type: SectionPlane = EntityType.SectionPlane

Accessors

typeName

Get Signature

get typeName(): string

Returns a named variant of the type field.

Since

SDK 2.35.0

Returns

string

Methods

toString()

toString(): string

Returns

string