LineSelectionItem

class Communicator.Selection.LineSelectionItem()

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


Methods

equals

LineSelectionItem.equals(selectionItem)

Determines if two selection items are equal.

Arguments
Return type

boolean

Returns

whether or not the two items are equal.

forJson

LineSelectionItem.forJson()
Deprecated

Use toJson instead.

Return type

Object

getFaceEntity

LineSelectionItem.getFaceEntity()

Gets the face entity for this selection.

Return type

FaceEntity() | null

Returns

the face entity if one was selected, otherwise null

getIncludeId

LineSelectionItem.getIncludeId()
Deprecated

Use getInclusionKey instead.

Return type

SC.InclusionKey | null

getInclusionKey

LineSelectionItem.getInclusionKey()

Gets the include id for this selection.

Return type

SC.InclusionKey | null

Returns

the inclusion key associated with this selection item

getLineEntity

LineSelectionItem.getLineEntity()
Return type

LineEntity()

getNodeId

LineSelectionItem.getNodeId()
Return type

NodeId

getPointEntity

LineSelectionItem.getPointEntity()

Gets the point entity for this selection.

Return type

PointEntity() | null

Returns

the point entity if one was selected, otherwise null

getPosition

LineSelectionItem.getPosition()
Return type

Point3()

getSelectionType

LineSelectionItem.getSelectionType()
Return type

SelectionType

isEntitySelection

LineSelectionItem.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

LineSelectionItem.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

LineSelectionItem.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

LineSelectionItem.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

LineSelectionItem.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

LineSelectionItem.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

LineSelectionItem.overlayIndex()
Return type

OverlayIndex

toJson

LineSelectionItem.toJson()

Creates an object ready for JSON serialization.

Return type

Object

Returns

The prepared object.

static create

LineSelectionItem.create(nodeId, inclusionKey, faceEntity[, lineEntity[, pointEntity]])

Create a new FaceSelectionItem

Arguments
Return type

FaceSelectionItem()

LineSelectionItem.create(nodeId, inclusionKey, faceEntity, lineEntity[, pointEntity])

Create a new LineSelectionItem

Arguments
Return type

LineSelectionItem()

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

Create a new PointSelectionItem

Arguments
Return type

PointSelectionItem()

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

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

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

LineSelectionItem.create(nodeId[, inclusionKey[, faceEntity[, lineEntity[, pointEntity]]]])

Create a new NodeSelectionItem

Arguments
Return type

NodeSelectionItem()

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