NodeEntitySelectionItem

class Selection.NodeEntitySelectionItem()

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

Methods

Selection.NodeEntitySelectionItem.equals()

inherited

equals(selectionItem: SelectionItem): boolean

Determines if two selection items are equal.

Parameters

selectionItem: SelectionItem

The selection item to test against.

Returns: boolean

whether or not the two items are equal.
Selection.NodeEntitySelectionItem.getFaceEntity()

inherited

getFaceEntity(): (None | FaceEntity)

Gets the face entity for this selection.

Returns: (None | FaceEntity)

the face entity if one was selected, otherwise null
Selection.NodeEntitySelectionItem.getInclusionKey()

inherited

getInclusionKey(): (None | InclusionKey)

Gets the include id for this selection.

Returns: (None | InclusionKey)

the inclusion key associated with this selection item
Selection.NodeEntitySelectionItem.getLineEntity()

inherited

getLineEntity(): (None | LineEntity)

Gets the line entity for this selection.

Returns: (None | LineEntity)

the line entity if one was selected, otherwise null
Selection.NodeEntitySelectionItem.getNodeId()
getNodeId(): number

Gets the part id for this selection.

Returns: number

the part id associated with this selection item
Selection.NodeEntitySelectionItem.getPointEntity()

inherited

getPointEntity(): (None | PointEntity)

Gets the point entity for this selection.

Returns: (None | PointEntity)

the point entity if one was selected, otherwise null
Selection.NodeEntitySelectionItem.getPosition()
getPosition(): Point3

Convenience method for getting the world space position of the selection point. [[SelectionItem]]s with a type of [[SelectionType.Part]] will not have a position and null will be returned.

Returns: Point3

World space position of the selection point if it can be determined.
Selection.NodeEntitySelectionItem.getSelectionType()

inherited

getSelectionType(): SelectionType

Returns: SelectionType

Selection.NodeEntitySelectionItem.isEntitySelection()

inherited

isEntitySelection(): this is EntitySelectionItem

Returns: this is EntitySelectionItem

true if the object has the fields required for an [[EntitySelectionItem]]. This function can be used as a TypeScript type guard.
Selection.NodeEntitySelectionItem.isFaceSelection()

inherited

isFaceSelection(): this is FaceSelectionItem

Returns: this is FaceSelectionItem

true if the object has the fields required for a [[FaceSelectionItem]]. This function can be used as a TypeScript type guard.
Selection.NodeEntitySelectionItem.isLineSelection()

inherited

isLineSelection(): this is LineSelectionItem

Returns: this is LineSelectionItem

true if the object has the fields required for a [[LineSelectionItem]]. This function can be used as a TypeScript type guard.
Selection.NodeEntitySelectionItem.isNodeEntitySelection()

inherited

isNodeEntitySelection(): this is NodeEntitySelectionItem

Returns: this is NodeEntitySelectionItem

true if the object has the fields required for a [[NodeEntitySelectionItem]]. This function can be used as a TypeScript type guard.
Selection.NodeEntitySelectionItem.isNodeSelection()

inherited

isNodeSelection(): this is NodeSelectionItem

Returns: this is NodeSelectionItem

true if the object has the fields required for a [[NodeSelectionItem]]. This function can be used as a TypeScript type guard.
Selection.NodeEntitySelectionItem.isPointSelection()

inherited

isPointSelection(): this is PointSelectionItem

Returns: this is PointSelectionItem

true if the object has the fields required for a [[PointSelectionItem]]. This function can be used as a TypeScript type guard.
Selection.NodeEntitySelectionItem.overlayIndex()
overlayIndex(): number

Gets the overlay index for this selection.

Returns: number

the overlay index associated with this selection item
Selection.NodeEntitySelectionItem.toJson()

inherited

toJson(): object

Creates an object ready for JSON serialization.

Returns: object

The prepared object.