ClipplaneAPI

Description

Clip planes are used to spatially exclude parts of the geometry from the visualization by defining a separating plane.
changeClipPlane(clipPlaneID, normal, point, name, thickness, tangent, disabled, invisible, exclusive)
Changes the properties of the clip plane defined by the clipPlaneID with the optional parameters normal, points and name.
Arguments
  • clipPlaneID (number()) – The ID of an existing clip plane which should be changed

  • normal (Float32Array|Array) – The new normal of the clip plane Optional

  • point (Float32Array|Array) – An arbitrary new point in space which lies on the clip plane Optional

  • name (string()) – The new name for the clip plane Optional

  • thickness (number()) – The thickness for the clip plane Optional

  • tangent (Float32Array|Array) – The tangent of the clip plane Optional

  • disabled (boolean()) – The enabled state of the clip plane Optional

  • invisible (boolean()) – Invisible on the UI Optional

  • exclusive (boolean()) – set the exclusive flag to clip geometry when using exclusiveClipplanes property Optional

Returns

void

changeClippingRoom(name, size, transformation, disabled, invisible)
Arguments
  • name (string()) – Optional

  • size (Float32Array|Array) – Optional

  • transformation (Float32Array|Array) – Optional

  • disabled (boolean()) – Optional

  • invisible (boolean()) – Optional

Returns

void

clipOtherParts(target)
Arguments
  • target (number|Array) –

Returns

void

createCapping(clipPlaneID)
Arguments
  • clipPlaneID (number()) –

Returns

Promise<void>

createClipPlane(normal, point, name, thickness, tangent, disabled, invisible, exclusive)
Creates a clip plane defined by the plane’s normal, positioned at an optional point (otherwise at the world space origin) and an optional name. Returns the ID of the clip plane.
Arguments
  • normal (Float32Array|Array) – The normal of the clip plane Optional

  • point (Float32Array|Array) – An arbitrary point in space which lies on the clip plane Optional

  • name (string()) – The name of the clip plane Optional

  • thickness (number()) – The thickness of the clip plane Optional

  • tangent (Float32Array|Array) – The tangent of the clip plane Optional

  • disabled (boolean()) – The state of the clip plane Optional

  • invisible (boolean()) – Invisible on the UI Optional

  • exclusive (boolean()) – set the exclusive flag to clip geometry when using exclusiveClipplanes property Optional

Returns

number – The ID of the newly created clip plane

createClippingRoom(name, size, transformation, disabled, invisible)
Creates six clip planes around the bounding box of the specified node.
Arguments
  • name (string()) – Optional

  • size (Float32Array|Array) – Optional

  • transformation (Float32Array|Array) – Optional

  • disabled (boolean()) – Optional

  • invisible (boolean()) – Optional

Returns

number

disableCapping(clipPlaneId)
Arguments
  • clipPlaneId (number()) –

Returns

Promise<void>

enableCapping(clipPlaneId)
Arguments
  • clipPlaneId (number()) –

Returns

Promise<void>

removeCapping(clipPlaneId)
Arguments
  • clipPlaneId (number()) –

Returns

Promise<void>

removeClipPlane(clipPlaneID)
Removes the clip plane for the given clipPlaneID.
Arguments
  • clipPlaneID (number()) – The ID of the clip plane which should be removed

Returns

void

removeClippingRoom()
Returns

void