EntitySelectionItem

class EntitySelectionItem()

Methods

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

---

Methods

equals

EntitySelectionItem.equals(selectionItem)

Arguments:

• selectionItem (SelectionItem()) –

Return type:

boolean

getFaceEntity

EntitySelectionItem.getFaceEntity()

Return type:FaceEntity() | null

getInclusionKey

EntitySelectionItem.getInclusionKey()

Return type:InclusionKey | null

getLineEntity

EntitySelectionItem.getLineEntity()

Return type:LineEntity() | null

getNodeId

EntitySelectionItem.getNodeId()

Return type:NodeId

getPointEntity

EntitySelectionItem.getPointEntity()

Return type:PointEntity() | null

getPosition

EntitySelectionItem.getPosition()

Return type:Point3

getSelectionType

EntitySelectionItem.getSelectionType()

Return type:SelectionType

isEntitySelection

EntitySelectionItem.isEntitySelection()

Return type:this

isFaceSelection

EntitySelectionItem.isFaceSelection()

Return type:this

isLineSelection

EntitySelectionItem.isLineSelection()

Return type:this

isNodeEntitySelection

EntitySelectionItem.isNodeEntitySelection()

Return type:this

isNodeSelection

EntitySelectionItem.isNodeSelection()

Return type:this

isPointSelection

EntitySelectionItem.isPointSelection()

Return type:this

overlayIndex

EntitySelectionItem.overlayIndex()

Return type:OverlayIndex

toJson

EntitySelectionItem.toJson()

Return type:object

static create

EntitySelectionItem.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()

EntitySelectionItem.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()

EntitySelectionItem.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()

EntitySelectionItem.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()

EntitySelectionItem.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()

EntitySelectionItem.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()

EntitySelectionItem.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()

EntitySelectionItem.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()