LineSelectionItem

class Communicator.Selection.LineSelectionItem()

A SelectionItem that is guaranteed to have a valid NodeId and LineEntity

Methods

equals()

forJson()

getFaceEntity()

getIncludeId()

getInclusionKey()

getLineEntity()

getNodeId()

getPointEntity()

getPosition()

getSelectionType()

isEntitySelection()

isFaceSelection()

isLineSelection()

isNodeEntitySelection()

isNodeSelection()

isPointSelection()

overlayIndex()

toJson()

create()


Methods

equals

Communicator.Selection.LineSelectionItem.equals(selectionItem)

Determines if two selection items are equal.

Arguments
Return type

boolean

Returns

whether or not the two items are equal.

forJson

Communicator.Selection.LineSelectionItem.forJson()

Note

forJson is deprecated: Use toJson instead.

Return type

Object

getFaceEntity

Communicator.Selection.LineSelectionItem.getFaceEntity()

Gets the face entity for this selection.

Return type

{  }

Returns

the face entity if one was selected, otherwise null

getIncludeId

Communicator.Selection.LineSelectionItem.getIncludeId()

Note

getIncludeId is deprecated: Use getInclusionKey instead.

Return type

{  }

getInclusionKey

Communicator.Selection.LineSelectionItem.getInclusionKey()

Gets the include id for this selection.

Return type

{  }

Returns

the inclusion key associated with this selection item

getLineEntity

Communicator.Selection.LineSelectionItem.getLineEntity()
Return type

Communicator.Selection.LineEntity

getNodeId

Communicator.Selection.LineSelectionItem.getNodeId()
Return type

Communicator.NodeId

getPointEntity

Communicator.Selection.LineSelectionItem.getPointEntity()

Gets the point entity for this selection.

Return type

{  }

Returns

the point entity if one was selected, otherwise null

getPosition

Communicator.Selection.LineSelectionItem.getPosition()
Return type

Communicator.Point3

getSelectionType

Communicator.Selection.LineSelectionItem.getSelectionType()
Return type

Communicator.SelectionType

isEntitySelection

Communicator.Selection.LineSelectionItem.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.LineSelectionItem.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.LineSelectionItem.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.LineSelectionItem.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.LineSelectionItem.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.LineSelectionItem.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.LineSelectionItem.overlayIndex()
Return type

Communicator.OverlayIndex

toJson

Communicator.Selection.LineSelectionItem.toJson()

Creates an object ready for JSON serialization.

Return type

Object

Returns

The prepared object.

create

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

Create a new FaceSelectionItem

Arguments
Return type

Communicator.Selection.FaceSelectionItem

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

Create a new LineSelectionItem

Arguments
Return type

Communicator.Selection.LineSelectionItem

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

Create a new PointSelectionItem

Arguments
Return type

Communicator.Selection.PointSelectionItem

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

Create a new EntitySelectionItem

Arguments
Return type

Communicator.Selection.EntitySelectionItem

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

Create a new EntitySelectionItem

Arguments
Return type

Communicator.Selection.EntitySelectionItem

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

Create a new EntitySelectionItem

Arguments
Return type

Communicator.Selection.EntitySelectionItem

Communicator.Selection.LineSelectionItem.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.LineSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity, pointEntity)

Create a new SelectionItem

Arguments
  • nodeId ({  }()) –

  • inclusionKey ({  }()) –

  • faceEntity ({  }()) –

  • lineEntity ({  }()) –

  • pointEntity ({  }()) –

Return type

Communicator.Selection.SelectionItem