FaceSelectionItem

class Communicator.Selection.FaceSelectionItem(): A SelectionItem that is guaranteed to have a valid NodeId and FaceEntity

Methods

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

Methods

equals

FaceSelectionItem.equals(selectionItem)

Determines if two selection items are equal.

Arguments

selectionItem (SelectionItem()) – The selection item to test against.

Return type

boolean

Returns

whether or not the two items are equal.

forJson

FaceSelectionItem.forJson()

Deprecated: Use toJson instead.
Return type: Object

getFaceEntity

FaceSelectionItem.getFaceEntity()

Return type: FaceEntity()

getIncludeId

FaceSelectionItem.getIncludeId()

Deprecated: Use getInclusionKey instead.
Return type: SC.InclusionKey | null

getInclusionKey

FaceSelectionItem.getInclusionKey()

Gets the include id for this selection.

Return type: SC.InclusionKey | null
Returns: the inclusion key associated with this selection item

getLineEntity

FaceSelectionItem.getLineEntity()

Gets the line entity for this selection.

Return type: LineEntity() | null
Returns: the line entity if one was selected, otherwise null

getNodeId

FaceSelectionItem.getNodeId()

Return type: NodeId

getPointEntity

FaceSelectionItem.getPointEntity()

Gets the point entity for this selection.

Return type: PointEntity() | null
Returns: the point entity if one was selected, otherwise null

getPosition

FaceSelectionItem.getPosition()

Return type: Point3()

getSelectionType

FaceSelectionItem.getSelectionType()

Return type: SelectionType

isEntitySelection

FaceSelectionItem.isEntitySelection()

Return type: this
Returns: true if the object has the fields required for an EntitySelectionItem This function can be used as a TypeScript type guard.

isFaceSelection

FaceSelectionItem.isFaceSelection()

Return type: this
Returns: true if the object has the fields required for a FaceSelectionItem This function can be used as a TypeScript type guard.

isLineSelection

FaceSelectionItem.isLineSelection()

Return type: this
Returns: true if the object has the fields required for a LineSelectionItem This function can be used as a TypeScript type guard.

isNodeEntitySelection

FaceSelectionItem.isNodeEntitySelection()

Return type: this
Returns: true if the object has the fields required for a NodeEntitySelectionItem This function can be used as a TypeScript type guard.

isNodeSelection

FaceSelectionItem.isNodeSelection()

Return type: this
Returns: true if the object has the fields required for a NodeSelectionItem This function can be used as a TypeScript type guard.

isPointSelection

FaceSelectionItem.isPointSelection()

Return type: this
Returns: true if the object has the fields required for a PointSelectionItem This function can be used as a TypeScript type guard.

overlayIndex

FaceSelectionItem.overlayIndex()

Return type: OverlayIndex

toJson

FaceSelectionItem.toJson()

Creates an object ready for JSON serialization.

Return type: Object
Returns: The prepared object.

static create

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

Create a new FaceSelectionItem

Arguments

nodeId (NodeId) –
inclusionKey (SC.InclusionKey | null | undefined()) –
faceEntity (FaceEntity()) –
lineEntity (LineEntity() | null) – optional
pointEntity (PointEntity() | null) – optional

Return type

FaceSelectionItem()

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

Create a new LineSelectionItem

Arguments

nodeId (NodeId) –
inclusionKey (SC.InclusionKey | null | undefined()) –
faceEntity (FaceEntity() | null | undefined) –
lineEntity (LineEntity()) –
pointEntity (PointEntity() | null) – optional

Return type

LineSelectionItem()

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

Create a new PointSelectionItem

Arguments

nodeId (NodeId) –
inclusionKey (SC.InclusionKey | null | undefined()) –
faceEntity (FaceEntity() | null | undefined) –
lineEntity (LineEntity() | null | undefined) –
pointEntity (PointEntity()) –

Return type

PointSelectionItem()

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

Create a new EntitySelectionItem

Arguments

nodeId (NodeId | null | undefined) –
inclusionKey (SC.InclusionKey | null | undefined()) –
faceEntity (FaceEntity()) –
lineEntity (LineEntity() | null) – optional
pointEntity (PointEntity() | null) – optional

Return type

EntitySelectionItem()

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

Create a new EntitySelectionItem

Arguments

nodeId (NodeId | null | undefined) –
inclusionKey (SC.InclusionKey | null | undefined()) –
faceEntity (FaceEntity() | null | undefined) –
lineEntity (LineEntity()) –
pointEntity (PointEntity() | null) – optional

Return type

EntitySelectionItem()

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

Create a new EntitySelectionItem

Arguments

nodeId (NodeId | null | undefined) –
inclusionKey (SC.InclusionKey | null | undefined()) –
faceEntity (FaceEntity() | null | undefined) –
lineEntity (LineEntity() | null | undefined) –
pointEntity (PointEntity()) –

Return type

EntitySelectionItem()

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

Create a new NodeSelectionItem

Arguments

nodeId (NodeId) –
inclusionKey (SC.InclusionKey | null()) – optional
faceEntity (FaceEntity() | null) – optional
lineEntity (LineEntity() | null) – optional
pointEntity (PointEntity() | null) – optional

Return type

NodeSelectionItem()

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

Create a new SelectionItem

Arguments

nodeId (NodeId | null) – optional
inclusionKey (SC.InclusionKey | null()) – optional
faceEntity (FaceEntity() | null) – optional
lineEntity (LineEntity() | null) – optional
pointEntity (PointEntity() | null) – optional

Return type

SelectionItem()