NodeEntitySelectionItem

class Communicator.Selection.NodeEntitySelectionItem()

A SelectionItem that is guaranteed to have a valid NodeId and entity.


Methods

equals

NodeEntitySelectionItem.equals(selectionItem)

Determines if two selection items are equal.

Arguments
Return type

boolean

Returns

whether or not the two items are equal.

forJson

NodeEntitySelectionItem.forJson()
Deprecated

Use toJson instead.

Return type

Object

getFaceEntity

NodeEntitySelectionItem.getFaceEntity()

Gets the face entity for this selection.

Return type

FaceEntity() | null

Returns

the face entity if one was selected, otherwise null

getIncludeId

NodeEntitySelectionItem.getIncludeId()
Deprecated

Use getInclusionKey instead.

Return type

SC.InclusionKey | null

getInclusionKey

NodeEntitySelectionItem.getInclusionKey()

Gets the include id for this selection.

Return type

SC.InclusionKey | null

Returns

the inclusion key associated with this selection item

getLineEntity

NodeEntitySelectionItem.getLineEntity()

Gets the line entity for this selection.

Return type

LineEntity() | null

Returns

the line entity if one was selected, otherwise null

getNodeId

NodeEntitySelectionItem.getNodeId()
Return type

NodeId

getPointEntity

NodeEntitySelectionItem.getPointEntity()

Gets the point entity for this selection.

Return type

PointEntity() | null

Returns

the point entity if one was selected, otherwise null

getPosition

NodeEntitySelectionItem.getPosition()
Return type

Point3()

getSelectionType

NodeEntitySelectionItem.getSelectionType()
Return type

SelectionType

isEntitySelection

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

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

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

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

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

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

NodeEntitySelectionItem.overlayIndex()
Return type

OverlayIndex

toJson

NodeEntitySelectionItem.toJson()

Creates an object ready for JSON serialization.

Return type

Object

Returns

The prepared object.

static create

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

Create a new FaceSelectionItem

Arguments
Return type

FaceSelectionItem()

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

Create a new LineSelectionItem

Arguments
Return type

LineSelectionItem()

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

Create a new PointSelectionItem

Arguments
Return type

PointSelectionItem()

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

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

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

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

Create a new NodeSelectionItem

Arguments
Return type

NodeSelectionItem()

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