Skip to main content

ClipEdges

The ClipEdges class is responsible for managing and rendering clipped edges and fills in a ThreeJS scene based on specified styles and models. 📕 Tutorial. 📘 API.

Implements

  • Disposable_2

Properties

plane

readonly plane: Plane

A readonly property representing the ThreeJS plane used to created the edges and fills.


three

readonly three: Group<Object3DEventMap>

The ThreeJS group that holds all the edges and fills together


world

world: null | World = null

The world in which the edges and fills will be placed.

Accessors

visible

set visible(value): void

Sets the visibility of the object in the scene. When set to true, the object is added to the scene if the world property is defined. When set to false, the object is removed from its parent.

Parameters

ParameterType
valueboolean

Methods

dispose()

dispose(): void

OBC.Disposable.dispose

Returns

void

Implementation of

OBC.Disposable.dispose


update()

update(groups?): Promise<void>

Updates the clip edges based on the provided groups and their associated styles and data. If no groups are specified, all items will be updated.

Parameters

ParameterTypeDescription
groups?string[]An optional array of group names to filter which items should be updated.

Returns

Promise<void>

A promise that resolves when the update process is complete.