PointSelectionItem
- class Communicator.Selection.PointSelectionItem()
A
SelectionItem
that is guaranteed to have a validNodeId
andPointEntity
Methods
Methods
equals
- Communicator.Selection.PointSelectionItem.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.PointSelectionItem.forJson()
Note
forJson is deprecated: Use
toJson
instead.- Return type
Object
getFaceEntity
- Communicator.Selection.PointSelectionItem.getFaceEntity()
Gets the face entity for this selection.
- Return type
{ }
- Returns
the face entity if one was selected, otherwise null
getIncludeId
- Communicator.Selection.PointSelectionItem.getIncludeId()
Note
getIncludeId is deprecated: Use
getInclusionKey
instead.- Return type
{ }
getInclusionKey
- Communicator.Selection.PointSelectionItem.getInclusionKey()
Gets the include id for this selection.
- Return type
{ }
- Returns
the inclusion key associated with this selection item
getLineEntity
- Communicator.Selection.PointSelectionItem.getLineEntity()
Gets the line entity for this selection.
- Return type
{ }
- Returns
the line entity if one was selected, otherwise null
getPointEntity
- Communicator.Selection.PointSelectionItem.getPointEntity()
- Return type
Communicator.Selection.PointEntity
getPosition
- Communicator.Selection.PointSelectionItem.getPosition()
- Return type
Communicator.Point3
getSelectionType
- Communicator.Selection.PointSelectionItem.getSelectionType()
- Return type
Communicator.SelectionType
isEntitySelection
- Communicator.Selection.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.overlayIndex()
- Return type
Communicator.OverlayIndex
toJson
- Communicator.Selection.PointSelectionItem.toJson()
Creates an object ready for JSON serialization.
- Return type
Object
- Returns
The prepared object.
create
- Communicator.Selection.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.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.PointSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)
Create a new
SelectionItem
- Arguments
nodeId (
{ }()
) –inclusionKey (
{ }()
) –faceEntity (
{ }()
) –lineEntity (
{ }()
) –pointEntity (
{ }()
) –
- Return type
Communicator.Selection.SelectionItem