FaceSelectionItem

class FaceSelectionItem()

Methods

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

Methods

equals

FaceSelectionItem.equals(selectionItem)

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

getFaceEntity

FaceSelectionItem.getFaceEntity()

Return type:	`FaceEntity()`

getInclusionKey

FaceSelectionItem.getInclusionKey()

Return type:	InclusionKey \| null

getLineEntity

FaceSelectionItem.getLineEntity()

Return type:	`LineEntity()` \| null

getNodeId

FaceSelectionItem.getNodeId()

Return type:	NodeId

getPointEntity

FaceSelectionItem.getPointEntity()

Return type:	`PointEntity()` \| null

getPosition

FaceSelectionItem.getPosition()

Return type:	Point3

getSelectionType

FaceSelectionItem.getSelectionType()

Return type:	SelectionType

isEntitySelection

FaceSelectionItem.isEntitySelection()

Return type:	this

isFaceSelection

FaceSelectionItem.isFaceSelection()

Return type:	this

isLineSelection

FaceSelectionItem.isLineSelection()

Return type:	this

isNodeEntitySelection

FaceSelectionItem.isNodeEntitySelection()

Return type:	this

isNodeSelection

FaceSelectionItem.isNodeSelection()

Return type:	this

isPointSelection

FaceSelectionItem.isPointSelection()

Return type:	this

overlayIndex

FaceSelectionItem.overlayIndex()

Return type:	OverlayIndex

toJson

FaceSelectionItem.toJson()

Return type:	object

static create

FaceSelectionItem.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()`

FaceSelectionItem.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()`

FaceSelectionItem.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()`

FaceSelectionItem.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()`

FaceSelectionItem.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()`

FaceSelectionItem.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()`

FaceSelectionItem.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()`

FaceSelectionItem.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()`