SelectionItem

class Communicator.Selection.SelectionItem()

Methods

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

Methods

equals

SelectionItem.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

SelectionItem.forJson()

Deprecated: Use toJson instead.
Return type: Object

getFaceEntity

SelectionItem.getFaceEntity()

Gets the face entity for this selection.

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

getIncludeId

SelectionItem.getIncludeId()

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

getInclusionKey

SelectionItem.getInclusionKey()

Gets the include id for this selection.

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

getLineEntity

SelectionItem.getLineEntity()

Gets the line entity for this selection.

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

getNodeId

SelectionItem.getNodeId()

Gets the part id for this selection.

Return type: NodeId | null
Returns: the part id associated with this selection item

getPointEntity

SelectionItem.getPointEntity()

Gets the point entity for this selection.

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

getPosition

SelectionItem.getPosition()

Convenience method for getting the world space position of the selection point. SelectionItem with a type of SelectionType.Part will not have a position and null will be returned.

Return type: Point3() | null
Returns: World space position of the selection point if it can be determined.

getSelectionType

SelectionItem.getSelectionType()

Return type: SelectionType

isEntitySelection

SelectionItem.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

SelectionItem.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

SelectionItem.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

SelectionItem.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

SelectionItem.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

SelectionItem.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

SelectionItem.overlayIndex()

Gets the overlay index for this selection.

Return type: OverlayIndex | null
Returns: the overlay index associated with this selection item

toJson

SelectionItem.toJson()

Creates an object ready for JSON serialization.

Return type: Object
Returns: The prepared object.

static create

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

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

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

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

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

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

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

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