ICuttingSection

class ICuttingSection()

Methods

_getInstanceNodeIds

ICuttingSection._getInstanceNodeIds()

Return type:	[NodeId]

activate

ICuttingSection.activate()

Return type:	Promise <void>

addPlane

ICuttingSection.addPlane(plane, referenceGeometry[, options])

Arguments:	plane (Plane) – None referenceGeometry (`[Point3] \| null()`) – None options (`function()`) – optional None
Return type:	Promise <boolean>

applyPlaneOpacity

ICuttingSection.applyPlaneOpacity(index[, opacity])

Arguments:	index (`number()`) – None opacity (`number()`) – optional None
Return type:	void

clear

ICuttingSection.clear()

Return type:	Promise <void>

deactivate

ICuttingSection.deactivate()

Return type:	Promise <void>

fromJson

ICuttingSection.fromJson(json)

Arguments:	json (`object()`) – None
Return type:	Promise <void>

getCount

ICuttingSection.getCount()

Return type:	number

getCuttingPlanes

ICuttingSection.getCuttingPlanes()

Return type:	[`CuttingPlane()`]

getNodeId

ICuttingSection.getNodeId(index)

Arguments:	index (`number()`) – None
Return type:	NodeId \| null

getPlane

ICuttingSection.getPlane(index)

Arguments:	index (`number()`) – None
Return type:	Plane \| null

getPlaneColor

ICuttingSection.getPlaneColor(index)

Arguments:	index (`number()`) – None
Return type:	Color \| undefined

getPlaneIndexByNodeId

ICuttingSection.getPlaneIndexByNodeId(id)

Arguments:	id (NodeId) – None
Return type:	number \| null

getPlaneLineColor

ICuttingSection.getPlaneLineColor(index)

Arguments:	index (`number()`) – None
Return type:	Color \| undefined

getPlaneOpacity

ICuttingSection.getPlaneOpacity(index)

Arguments:	index (`number()`) – None
Return type:	number \| undefined

getReferenceGeometry

ICuttingSection.getReferenceGeometry(index)

Arguments:	index (`number()`) – None
Return type:	[Point3] \| null

isActive

ICuttingSection.isActive()

Return type:	boolean

removePlane

ICuttingSection.removePlane(index)

Arguments:	index (`number()`) – None
Return type:	Promise <void>

resetPlanesOpacity

ICuttingSection.resetPlanesOpacity()

Return type:	void

setColor

ICuttingSection.setColor(color)

Arguments:	color (Color) – None
Return type:	Promise <void>

setOpacity

ICuttingSection.setOpacity(opacity)

Arguments:	opacity (`number()`) – None
Return type:	void

setPlane

ICuttingSection.setPlane(index, plane, referenceGeometry[, options])

Arguments:	index (`number()`) – None plane (Plane) – None referenceGeometry (`[Point3] \| null()`) – None options (`function()`) – optional None
Return type:	Promise <void>

setPlaneColor

ICuttingSection.setPlaneColor(index, color)

Arguments:	index (`number()`) – None color (Color) – None
Return type:	void

setPlaneLineColor

ICuttingSection.setPlaneLineColor(index, color)

Arguments:	index (`number()`) – None color (Color) – None
Return type:	void

setPlaneOpacity

ICuttingSection.setPlaneOpacity(index, opacity)

Arguments:	index (`number()`) – None opacity (`number()`) – None
Return type:	void

toJson

ICuttingSection.toJson()

Return type:	object

updatePlane

ICuttingSection.updatePlane(index, plane, geometryMatrix, finalizePosition, resetTranslation)

Arguments:	index (`number()`) – None plane (Plane) – None geometryMatrix (`Matrix()`) – None finalizePosition (`boolean()`) – None resetTranslation (`boolean()`) – None
Return type:	Promise <void>