SelectionItem

class SelectionItem()

Methods

equals()
getFaceEntity()
getInclusionKey()
getLineEntity()
getNodeId()
getPointEntity()
getPosition()
getSelectionType()
isEntitySelection()
isFaceSelection()
isLineSelection()
isNodeEntitySelection()
isNodeSelection()
isPointSelection()
overlayIndex()
toJson()
create()

Methods

equals

SelectionItem.equals(selectionItem)

Arguments:	selectionItem (`SelectionItem()`) –
Return type:	boolean

getFaceEntity

SelectionItem.getFaceEntity()

Return type:	`FaceEntity()` \| null

getInclusionKey

SelectionItem.getInclusionKey()

Return type:	InclusionKey \| null

getLineEntity

SelectionItem.getLineEntity()

Return type:	`LineEntity()` \| null

getNodeId

SelectionItem.getNodeId()

Return type:	NodeId

getPointEntity

SelectionItem.getPointEntity()

Return type:	`PointEntity()` \| null

getPosition

SelectionItem.getPosition()

Return type:	Point3 \| null

getSelectionType

SelectionItem.getSelectionType()

Return type:	SelectionType

isEntitySelection

SelectionItem.isEntitySelection()

Return type:	this

isFaceSelection

SelectionItem.isFaceSelection()

Return type:	this

isLineSelection

SelectionItem.isLineSelection()

Return type:	this

isNodeEntitySelection

SelectionItem.isNodeEntitySelection()

Return type:	this

isNodeSelection

SelectionItem.isNodeSelection()

Return type:	this

isPointSelection

SelectionItem.isPointSelection()

Return type:	this

overlayIndex

SelectionItem.overlayIndex()

Return type:	OverlayIndex \| null

toJson

SelectionItem.toJson()

Return type:	object

static create

SelectionItem.create(nodeId, inclusionKey, faceEntity[, lineEntity[, pointEntity]])

Arguments:	nodeId (NodeId) – None inclusionKey (`InclusionKey \| null \| undefined()`) – None faceEntity (`FaceEntity()`) – None lineEntity (`LineEntity()` \| null) – optional None pointEntity (`PointEntity()` \| null) – optional None
Return type:	`FaceSelectionItem()`

SelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity[, pointEntity])

Arguments:	nodeId (NodeId) – None inclusionKey (`InclusionKey \| null \| undefined()`) – None faceEntity (`FaceEntity()` \| null \| undefined) – None lineEntity (`LineEntity()`) – None pointEntity (`PointEntity()` \| null) – optional None
Return type:	`LineSelectionItem()`

SelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Arguments:	nodeId (NodeId) – None inclusionKey (`InclusionKey \| null \| undefined()`) – None faceEntity (`FaceEntity()` \| null \| undefined) – None lineEntity (`LineEntity()` \| null \| undefined) – None pointEntity (`PointEntity()`) – None
Return type:	`PointSelectionItem()`

SelectionItem.create(nodeId, inclusionKey, faceEntity[, lineEntity[, pointEntity]])

Arguments:	nodeId (NodeId \| null \| undefined) – None inclusionKey (`InclusionKey \| null \| undefined()`) – None faceEntity (`FaceEntity()`) – None lineEntity (`LineEntity()` \| null) – optional None pointEntity (`PointEntity()` \| null) – optional None
Return type:	`EntitySelectionItem()`

SelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity[, pointEntity])

Arguments:	nodeId (NodeId \| null \| undefined) – None inclusionKey (`InclusionKey \| null \| undefined()`) – None faceEntity (`FaceEntity()` \| null \| undefined) – None lineEntity (`LineEntity()`) – None pointEntity (`PointEntity()` \| null) – optional None
Return type:	`EntitySelectionItem()`

SelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Arguments:	nodeId (NodeId \| null \| undefined) – None inclusionKey (`InclusionKey \| null \| undefined()`) – None faceEntity (`FaceEntity()` \| null \| undefined) – None lineEntity (`LineEntity()` \| null \| undefined) – None pointEntity (`PointEntity()`) – None
Return type:	`EntitySelectionItem()`

SelectionItem.create(nodeId[, inclusionKey[, faceEntity[, lineEntity[, pointEntity]]]])

Arguments:	nodeId (NodeId) – None inclusionKey (`InclusionKey \| null()`) – optional None faceEntity (`FaceEntity()` \| null) – optional None lineEntity (`LineEntity()` \| null) – optional None pointEntity (`PointEntity()` \| null) – optional None
Return type:	`NodeSelectionItem()`

SelectionItem.create([nodeId[, inclusionKey[, faceEntity[, lineEntity[, pointEntity]]]]])

Arguments:	nodeId (NodeId \| null) – optional None inclusionKey (`InclusionKey \| null()`) – optional None faceEntity (`FaceEntity()` \| null) – optional None lineEntity (`LineEntity()` \| null) – optional None pointEntity (`PointEntity()` \| null) – optional None
Return type:	`SelectionItem()`