CuttingSection

class CuttingSection()

Methods

activate

CuttingSection.activate()
Return type:Promise <void>

addPlane

CuttingSection.addPlane(plane, referenceGeometry[, options])
Arguments:
  • plane (Plane) –
  • referenceGeometry ([Point3] | null()) –
  • options (function()) – optional
Return type:

Promise <boolean>

applyPlaneOpacity

CuttingSection.applyPlaneOpacity(index[, opacity])
Arguments:
  • index (number()) –
  • opacity (number()) – optional
Return type:

void

clear

CuttingSection.clear()
Return type:Promise <void>

deactivate

CuttingSection.deactivate()
Return type:Promise <void>

fromJson

CuttingSection.fromJson(json)
Arguments:
  • json (object()) – None
Return type:

Promise <void>

getCount

CuttingSection.getCount()
Return type:number

getCuttingPlanes

CuttingSection.getCuttingPlanes()
Return type:[CuttingPlane()]

getNodeId

CuttingSection.getNodeId(index)
Arguments:
  • index (number()) –
Return type:

NodeId | null

getPlane

CuttingSection.getPlane(index)
Arguments:
  • index (number()) –
Return type:

Plane | null

getPlaneColor

CuttingSection.getPlaneColor(index)
Arguments:
  • index (number()) – None
Return type:

Color | undefined

getPlaneIndexByNodeId

CuttingSection.getPlaneIndexByNodeId(id)
Arguments:
Return type:

number | null

getPlaneLineColor

CuttingSection.getPlaneLineColor(index)
Arguments:
  • index (number()) –
Return type:

Color | undefined

getPlaneOpacity

CuttingSection.getPlaneOpacity(index)
Arguments:
  • index (number()) –
Return type:

number | undefined

getReferenceGeometry

CuttingSection.getReferenceGeometry(index)
Arguments:
  • index (number()) –
Return type:

[Point3] | null

isActive

CuttingSection.isActive()
Return type:boolean

removePlane

CuttingSection.removePlane(index)
Arguments:
  • index (number()) –
Return type:

Promise <void>

resetPlanesOpacity

CuttingSection.resetPlanesOpacity()
Return type:void

setColor

CuttingSection.setColor(color)
Arguments:
Return type:

Promise <void>

setOpacity

CuttingSection.setOpacity(opacity)
Arguments:
  • opacity (number()) –
Return type:

void

setPlane

CuttingSection.setPlane(index, plane, referenceGeometry[, options])
Arguments:
  • index (number()) –
  • plane (Plane) –
  • referenceGeometry ([Point3] | null()) –
  • options (function()) – optional
Return type:

Promise <void>

setPlaneColor

CuttingSection.setPlaneColor(index, color)
Arguments:
  • index (number()) –
  • color (Color) –
Return type:

void

setPlaneLineColor

CuttingSection.setPlaneLineColor(index, color)
Arguments:
  • index (number()) –
  • color (Color) –
Return type:

void

setPlaneOpacity

CuttingSection.setPlaneOpacity(index, opacity)
Arguments:
  • index (number()) –
  • opacity (number()) –
Return type:

void

toJson

CuttingSection.toJson()
Return type:object

updatePlane

CuttingSection.updatePlane(index, plane, geometryMatrix, finalizePosition, resetTranslation)
Arguments:
  • index (number()) –
  • plane (Plane) –
  • geometryMatrix (any()) –
  • finalizePosition (boolean()) –
  • resetTranslation (boolean()) –
Return type:

Promise <void>