FaceSelectionItem
- class Communicator.Selection.FaceSelectionItem()
A
SelectionItemthat is guaranteed to have a validNodeIdandFaceEntity
Methods
Methods
equals
- Communicator.Selection.FaceSelectionItem.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.FaceSelectionItem.forJson()
Note
forJson is deprecated: Use
toJsoninstead.- Return type
Object
getFaceEntity
- Communicator.Selection.FaceSelectionItem.getFaceEntity()
- Return type
Communicator.Selection.FaceEntity
getIncludeId
- Communicator.Selection.FaceSelectionItem.getIncludeId()
Note
getIncludeId is deprecated: Use
getInclusionKeyinstead.- Return type
{ }
getInclusionKey
- Communicator.Selection.FaceSelectionItem.getInclusionKey()
Gets the include id for this selection.
- Return type
{ }- Returns
the inclusion key associated with this selection item
getLineEntity
- Communicator.Selection.FaceSelectionItem.getLineEntity()
Gets the line entity for this selection.
- Return type
{ }- Returns
the line entity if one was selected, otherwise null
getPointEntity
- Communicator.Selection.FaceSelectionItem.getPointEntity()
Gets the point entity for this selection.
- Return type
{ }- Returns
the point entity if one was selected, otherwise null
getPosition
- Communicator.Selection.FaceSelectionItem.getPosition()
- Return type
Communicator.Point3
getSelectionType
- Communicator.Selection.FaceSelectionItem.getSelectionType()
- Return type
Communicator.SelectionType
isEntitySelection
- Communicator.Selection.FaceSelectionItem.isEntitySelection()
- Return type
unknown- Returns
true if the object has the fields required for an
EntitySelectionItemThis function can be used as a TypeScript type guard.
isFaceSelection
- Communicator.Selection.FaceSelectionItem.isFaceSelection()
- Return type
unknown- Returns
true if the object has the fields required for a
FaceSelectionItemThis function can be used as a TypeScript type guard.
isLineSelection
- Communicator.Selection.FaceSelectionItem.isLineSelection()
- Return type
unknown- Returns
true if the object has the fields required for a
LineSelectionItemThis function can be used as a TypeScript type guard.
isNodeEntitySelection
- Communicator.Selection.FaceSelectionItem.isNodeEntitySelection()
- Return type
unknown- Returns
true if the object has the fields required for a
NodeEntitySelectionItemThis function can be used as a TypeScript type guard.
isNodeSelection
- Communicator.Selection.FaceSelectionItem.isNodeSelection()
- Return type
unknown- Returns
true if the object has the fields required for a
NodeSelectionItemThis function can be used as a TypeScript type guard.
isPointSelection
- Communicator.Selection.FaceSelectionItem.isPointSelection()
- Return type
unknown- Returns
true if the object has the fields required for a
PointSelectionItemThis function can be used as a TypeScript type guard.
overlayIndex
- Communicator.Selection.FaceSelectionItem.overlayIndex()
- Return type
Communicator.OverlayIndex
toJson
- Communicator.Selection.FaceSelectionItem.toJson()
Creates an object ready for JSON serialization.
- Return type
Object- Returns
The prepared object.
create
- Communicator.Selection.FaceSelectionItem.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.FaceSelectionItem.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.FaceSelectionItem.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.FaceSelectionItem.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.FaceSelectionItem.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.FaceSelectionItem.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.FaceSelectionItem.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.FaceSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)
Create a new
SelectionItem- Arguments
nodeId (
{ }()) –inclusionKey (
{ }()) –faceEntity (
{ }()) –lineEntity (
{ }()) –pointEntity (
{ }()) –
- Return type
Communicator.Selection.SelectionItem