NodeSelectionItem

class Communicator.Selection.NodeSelectionItem()

A SelectionItem that is guaranteed to have a valid NodeId

Methods

• equals()

• forJson()

• getFaceEntity()

• getIncludeId()

• getInclusionKey()

• getLineEntity()

• getNodeId()

• getPointEntity()

• getPosition()

• getSelectionType()

• isEntitySelection()

• isFaceSelection()

• isLineSelection()

• isNodeEntitySelection()

• isNodeSelection()

• isPointSelection()

• overlayIndex()

• toJson()

• create()

---

Methods

equals

Communicator.Selection.NodeSelectionItem.equals(selectionItem)

Determines if two selection items are equal.

Arguments

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

Return type

boolean

Returns

whether or not the two items are equal.

forJson

Communicator.Selection.NodeSelectionItem.forJson()

Note

forJson is deprecated: Use toJson instead.

Return type

Object

getFaceEntity

Communicator.Selection.NodeSelectionItem.getFaceEntity()

Gets the face entity for this selection.

Return type

{  }

Returns

the face entity if one was selected, otherwise null

getIncludeId

Communicator.Selection.NodeSelectionItem.getIncludeId()

Note

getIncludeId is deprecated: Use getInclusionKey instead.

Return type

{  }

getInclusionKey

Communicator.Selection.NodeSelectionItem.getInclusionKey()

Gets the include id for this selection.

Return type

{  }

Returns

the inclusion key associated with this selection item

getLineEntity

Communicator.Selection.NodeSelectionItem.getLineEntity()

Gets the line entity for this selection.

Return type

{  }

Returns

the line entity if one was selected, otherwise null

getNodeId

Communicator.Selection.NodeSelectionItem.getNodeId()

Return type

Communicator.NodeId

getPointEntity

Communicator.Selection.NodeSelectionItem.getPointEntity()

Gets the point entity for this selection.

Return type

{  }

Returns

the point entity if one was selected, otherwise null

getPosition

Communicator.Selection.NodeSelectionItem.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

{  }

Returns

World space position of the selection point if it can be determined.

getSelectionType

Communicator.Selection.NodeSelectionItem.getSelectionType()

Return type

Communicator.SelectionType

isEntitySelection

Communicator.Selection.NodeSelectionItem.isEntitySelection()

Return type

unknown

Returns

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

isFaceSelection

Communicator.Selection.NodeSelectionItem.isFaceSelection()

Return type

unknown

Returns

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

isLineSelection

Communicator.Selection.NodeSelectionItem.isLineSelection()

Return type

unknown

Returns

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

isNodeEntitySelection

Communicator.Selection.NodeSelectionItem.isNodeEntitySelection()

Return type

unknown

Returns

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

isNodeSelection

Communicator.Selection.NodeSelectionItem.isNodeSelection()

Return type

unknown

Returns

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

isPointSelection

Communicator.Selection.NodeSelectionItem.isPointSelection()

Return type

unknown

Returns

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

overlayIndex

Communicator.Selection.NodeSelectionItem.overlayIndex()

Gets the overlay index for this selection.

Return type

{  }

Returns

the overlay index associated with this selection item

toJson

Communicator.Selection.NodeSelectionItem.toJson()

Creates an object ready for JSON serialization.

Return type

Object

Returns

The prepared object.

create

Communicator.Selection.NodeSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new FaceSelectionItem

Arguments

• nodeId (Communicator.NodeId()) –

• inclusionKey ({  }()) –

• faceEntity (Communicator.Selection.FaceEntity()) –

• lineEntity ({  }()) –

• pointEntity ({  }()) –

Return type

Communicator.Selection.FaceSelectionItem

Communicator.Selection.NodeSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new LineSelectionItem

Arguments

• nodeId (Communicator.NodeId()) –

• inclusionKey ({  }()) –

• faceEntity ({  }()) –

• lineEntity (Communicator.Selection.LineEntity()) –

• pointEntity ({  }()) –

Return type

Communicator.Selection.LineSelectionItem

Communicator.Selection.NodeSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new PointSelectionItem

Arguments

• nodeId (Communicator.NodeId()) –

• inclusionKey ({  }()) –

• faceEntity ({  }()) –

• lineEntity ({  }()) –

• pointEntity (Communicator.Selection.PointEntity()) –

Return type

Communicator.Selection.PointSelectionItem

Communicator.Selection.NodeSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new EntitySelectionItem

Arguments

• nodeId ({  }()) –

• inclusionKey ({  }()) –

• faceEntity (Communicator.Selection.FaceEntity()) –

• lineEntity ({  }()) –

• pointEntity ({  }()) –

Return type

Communicator.Selection.EntitySelectionItem

Communicator.Selection.NodeSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new EntitySelectionItem

Arguments

• nodeId ({  }()) –

• inclusionKey ({  }()) –

• faceEntity ({  }()) –

• lineEntity (Communicator.Selection.LineEntity()) –

• pointEntity ({  }()) –

Return type

Communicator.Selection.EntitySelectionItem

Communicator.Selection.NodeSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new EntitySelectionItem

Arguments

• nodeId ({  }()) –

• inclusionKey ({  }()) –

• faceEntity ({  }()) –

• lineEntity ({  }()) –

• pointEntity (Communicator.Selection.PointEntity()) –

Return type

Communicator.Selection.EntitySelectionItem

Communicator.Selection.NodeSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new NodeSelectionItem

Arguments

• nodeId (Communicator.NodeId()) –

• inclusionKey ({  }()) –

• faceEntity ({  }()) –

• lineEntity ({  }()) –

• pointEntity ({  }()) –

Return type

Communicator.Selection.NodeSelectionItem

Communicator.Selection.NodeSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new SelectionItem

Arguments

• nodeId ({  }()) –

• inclusionKey ({  }()) –

• faceEntity ({  }()) –

• lineEntity ({  }()) –

• pointEntity ({  }()) –

Return type

Communicator.Selection.SelectionItem