SelectionItem

class Selection.SelectionItem()

Methods

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

Methods

equals

SelectionItem.equals(selectionItem)

Arguments

selectionItem (SelectionItem()) – The selection item to test against.

Determines if two selection items are equal.

Returns: whether or not the two items are equal.
Return type: boolean

getFaceEntity

SelectionItem.getFaceEntity()

Gets the face entity for this selection.

Returns: the face entity if one was selected, otherwise null
Return type: null | FaceEntity

getInclusionKey

SelectionItem.getInclusionKey()

Gets the include id for this selection.

Returns: the inclusion key associated with this selection item
Return type: null | InclusionKey

getLineEntity

SelectionItem.getLineEntity()

Gets the line entity for this selection.

Returns: the line entity if one was selected, otherwise null
Return type: null | LineEntity

getNodeId

SelectionItem.getNodeId()

Gets the part id for this selection.

Returns: the part id associated with this selection item
Return type: number

getPointEntity

SelectionItem.getPointEntity()

Gets the point entity for this selection.

Returns: the point entity if one was selected, otherwise null
Return type: null | PointEntity

getPosition

SelectionItem.getPosition()

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: World space position of the selection point if it can be determined.
Return type: null | Point3

getSelectionType

SelectionItem.getSelectionType()

Return type: SelectionType

isEntitySelection

SelectionItem.isEntitySelection()

Returns: true if the object has the fields required for an [[EntitySelectionItem]]. This function can be used as a TypeScript [type guard](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards).
Return type: this

isFaceSelection

SelectionItem.isFaceSelection()

Returns: true if the object has the fields required for a [[FaceSelectionItem]]. This function can be used as a TypeScript [type guard](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards).
Return type: this

isLineSelection

SelectionItem.isLineSelection()

Returns: true if the object has the fields required for a [[LineSelectionItem]]. This function can be used as a TypeScript [type guard](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards).
Return type: this

isNodeEntitySelection

SelectionItem.isNodeEntitySelection()

Returns: true if the object has the fields required for a [[NodeEntitySelectionItem]]. This function can be used as a TypeScript [type guard](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards).
Return type: this

isNodeSelection

SelectionItem.isNodeSelection()

Returns: true if the object has the fields required for a [[NodeSelectionItem]]. This function can be used as a TypeScript [type guard](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards).
Return type: this

isPointSelection

SelectionItem.isPointSelection()

Returns: true if the object has the fields required for a [[PointSelectionItem]]. This function can be used as a TypeScript [type guard](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards).
Return type: this

overlayIndex

SelectionItem.overlayIndex()

Gets the overlay index for this selection.

Returns: the overlay index associated with this selection item
Return type: null | number

toJson

SelectionItem.toJson()

Creates an object ready for JSON serialization.

Returns: The prepared object.
Return type: object

static create

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

Arguments

nodeId (number()) – None
inclusionKey (undefined | null | InclusionKey()) – None
faceEntity (FaceEntity()) – None
lineEntity (null | LineEntity()) – optional None
pointEntity (null | PointEntity()) – optional None

Create a new [[FaceSelectionItem]].

Return type: FaceSelectionItem

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

Arguments

nodeId (number()) – None
inclusionKey (undefined | null | InclusionKey()) – None
faceEntity (undefined | null | FaceEntity()) – None
lineEntity (LineEntity()) – None
pointEntity (null | PointEntity()) – optional None

Create a new [[LineSelectionItem]].

Return type: LineSelectionItem

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

Arguments

nodeId (number()) – None
inclusionKey (undefined | null | InclusionKey()) – None
faceEntity (undefined | null | FaceEntity()) – None
lineEntity (undefined | null | LineEntity()) – None
pointEntity (PointEntity()) – None

Create a new [[PointSelectionItem]].

Return type: PointSelectionItem

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

Arguments

nodeId (undefined | null | number()) – None
inclusionKey (undefined | null | InclusionKey()) – None
faceEntity (FaceEntity()) – None
lineEntity (null | LineEntity()) – optional None
pointEntity (null | PointEntity()) – optional None

Create a new [[EntitySelectionItem]].

Return type: EntitySelectionItem

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

Arguments

nodeId (undefined | null | number()) – None
inclusionKey (undefined | null | InclusionKey()) – None
faceEntity (undefined | null | FaceEntity()) – None
lineEntity (LineEntity()) – None
pointEntity (null | PointEntity()) – optional None

Create a new [[EntitySelectionItem]].

Return type: EntitySelectionItem

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

Arguments

nodeId (undefined | null | number()) – None
inclusionKey (undefined | null | InclusionKey()) – None
faceEntity (undefined | null | FaceEntity()) – None
lineEntity (undefined | null | LineEntity()) – None
pointEntity (PointEntity()) – None

Create a new [[EntitySelectionItem]].

Return type: EntitySelectionItem

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

Arguments

nodeId (number()) – None
inclusionKey (null | InclusionKey()) – optional None
faceEntity (null | FaceEntity()) – optional None
lineEntity (null | LineEntity()) – optional None
pointEntity (null | PointEntity()) – optional None

Create a new [[NodeSelectionItem]].

Return type: NodeSelectionItem

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

Arguments

nodeId (null | number()) – optional None
inclusionKey (null | InclusionKey()) – optional None
faceEntity (null | FaceEntity()) – optional None
lineEntity (null | LineEntity()) – optional None
pointEntity (null | PointEntity()) – optional None

Create a new [[SelectionItem]].

Return type: SelectionItem