SelectionItem

class Selection.SelectionItem()

Index

Methods

• equals
• getFaceEntity
• getInclusionKey
• getLineEntity
• getNodeId
• getPointEntity
• getPosition
• getSelectionType
• isEntitySelection
• isFaceSelection
• isLineSelection
• isNodeEntitySelection
• isNodeSelection
• isPointSelection
• overlayIndex
• toJson
• create

Methods

Selection.SelectionItem.equals()

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.SelectionItem.getFaceEntity()

getFaceEntity(): (None | FaceEntity)

Gets the face entity for this selection.

Returns: (None | FaceEntity)

the face entity if one was selected, otherwise null

Selection.SelectionItem.getInclusionKey()

getInclusionKey(): (None | InclusionKey)

Gets the include id for this selection.

Returns: (None | InclusionKey)

the inclusion key associated with this selection item

Selection.SelectionItem.getLineEntity()

getLineEntity(): (None | LineEntity)

Gets the line entity for this selection.

Returns: (None | LineEntity)

the line entity if one was selected, otherwise null

Selection.SelectionItem.getNodeId()

getNodeId(): number

Gets the part id for this selection.

Returns: number

the part id associated with this selection item

Selection.SelectionItem.getPointEntity()

getPointEntity(): (None | PointEntity)

Gets the point entity for this selection.

Returns: (None | PointEntity)

the point entity if one was selected, otherwise null

Selection.SelectionItem.getPosition()

getPosition(): (None | 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: (None | Point3)

World space position of the selection point if it can be determined.

Selection.SelectionItem.getSelectionType()

getSelectionType(): SelectionType

Returns: SelectionType

Selection.SelectionItem.isEntitySelection()

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.SelectionItem.isFaceSelection()

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.SelectionItem.isLineSelection()

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.SelectionItem.isNodeEntitySelection()

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.SelectionItem.isNodeSelection()

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.SelectionItem.isPointSelection()

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.SelectionItem.overlayIndex()

overlayIndex(): (None | number)

Gets the overlay index for this selection.

Returns: (None | number)

the overlay index associated with this selection item

Selection.SelectionItem.toJson()

toJson(): object

Creates an object ready for JSON serialization.

Returns: object

The prepared object.

static Selection.SelectionItem.create()

static

create(nodeId: number, inclusionKey: (undefined | None | InclusionKey), faceEntity: FaceEntity, lineEntity: (None | LineEntity), pointEntity: (None | PointEntity)): FaceSelectionItem

Create a new [[FaceSelectionItem]].

Parameters

nodeId: number

inclusionKey: (undefined | None | InclusionKey)

faceEntity: FaceEntity

lineEntity: (None | LineEntity)

pointEntity: (None | PointEntity)

Returns: FaceSelectionItem

create(nodeId: number, inclusionKey: (undefined | None | InclusionKey), faceEntity: (undefined | None | FaceEntity), lineEntity: LineEntity, pointEntity: (None | PointEntity)): LineSelectionItem

Create a new [[LineSelectionItem]].

Parameters

nodeId: number

inclusionKey: (undefined | None | InclusionKey)

faceEntity: (undefined | None | FaceEntity)

lineEntity: LineEntity

pointEntity: (None | PointEntity)

Returns: LineSelectionItem

create(nodeId: number, inclusionKey: (undefined | None | InclusionKey), faceEntity: (undefined | None | FaceEntity), lineEntity: (undefined | None | LineEntity), pointEntity: PointEntity): PointSelectionItem

Create a new [[PointSelectionItem]].

Parameters

nodeId: number

inclusionKey: (undefined | None | InclusionKey)

faceEntity: (undefined | None | FaceEntity)

lineEntity: (undefined | None | LineEntity)

pointEntity: PointEntity

Returns: PointSelectionItem

create(nodeId: (undefined | None | number), inclusionKey: (undefined | None | InclusionKey), faceEntity: FaceEntity, lineEntity: (None | LineEntity), pointEntity: (None | PointEntity)): EntitySelectionItem

Create a new [[EntitySelectionItem]].

Parameters

nodeId: (undefined | None | number)

inclusionKey: (undefined | None | InclusionKey)

faceEntity: FaceEntity

lineEntity: (None | LineEntity)

pointEntity: (None | PointEntity)

Returns: EntitySelectionItem

create(nodeId: (undefined | None | number), inclusionKey: (undefined | None | InclusionKey), faceEntity: (undefined | None | FaceEntity), lineEntity: LineEntity, pointEntity: (None | PointEntity)): EntitySelectionItem

Create a new [[EntitySelectionItem]].

Parameters

nodeId: (undefined | None | number)

inclusionKey: (undefined | None | InclusionKey)

faceEntity: (undefined | None | FaceEntity)

lineEntity: LineEntity

pointEntity: (None | PointEntity)

Returns: EntitySelectionItem

create(nodeId: (undefined | None | number), inclusionKey: (undefined | None | InclusionKey), faceEntity: (undefined | None | FaceEntity), lineEntity: (undefined | None | LineEntity), pointEntity: PointEntity): EntitySelectionItem

Create a new [[EntitySelectionItem]].

Parameters

nodeId: (undefined | None | number)

inclusionKey: (undefined | None | InclusionKey)

faceEntity: (undefined | None | FaceEntity)

lineEntity: (undefined | None | LineEntity)

pointEntity: PointEntity

Returns: EntitySelectionItem

create(nodeId: number, inclusionKey: (None | InclusionKey), faceEntity: (None | FaceEntity), lineEntity: (None | LineEntity), pointEntity: (None | PointEntity)): NodeSelectionItem

Create a new [[NodeSelectionItem]].

Parameters

nodeId: number

inclusionKey: (None | InclusionKey)

faceEntity: (None | FaceEntity)

lineEntity: (None | LineEntity)

pointEntity: (None | PointEntity)

Returns: NodeSelectionItem

create(nodeId: (None | number), inclusionKey: (None | InclusionKey), faceEntity: (None | FaceEntity), lineEntity: (None | LineEntity), pointEntity: (None | PointEntity)): SelectionItem

Create a new [[SelectionItem]].

Parameters

nodeId: (None | number)

inclusionKey: (None | InclusionKey)

faceEntity: (None | FaceEntity)

lineEntity: (None | LineEntity)

pointEntity: (None | PointEntity)

Returns: SelectionItem