CompositeSelectionItem

class Selection.CompositeSelectionItem()

This class is used to represent the result of a composite picking operation. Each of its fields may be populated with a [[NodeEntitySelectionItem]].

Index

Constructors

• constructor

Properties

• faceItem
• lineItem
• pointItem

Methods

• fetchMostRelevant

Constructors

Selection.CompositeSelectionItem.constructor()

CompositeSelectionItem(faceItem: (None | FaceSelectionItem), lineItem: (None | LineSelectionItem), pointItem: (None | PointSelectionItem)): CompositeSelectionItem

Parameters

faceItem: (None | FaceSelectionItem)

lineItem: (None | LineSelectionItem)

pointItem: (None | PointSelectionItem)

Returns: CompositeSelectionItem

Properties

Selection.CompositeSelectionItem.faceItem

faceItem: (None | FaceSelectionItem)

Selection.CompositeSelectionItem.lineItem

lineItem: (None | LineSelectionItem)

Selection.CompositeSelectionItem.pointItem

pointItem: (None | PointSelectionItem)

Methods

Selection.CompositeSelectionItem.fetchMostRelevant()

fetchMostRelevant(mask: SelectionMask): (None | NodeEntitySelectionItem)

Returns the most relevant selection item for the provided selection mask. The priority used by this method is points -> lines -> faces. For example, if your selection mask was Faces | Lines and this item contained and all fields were populated, this method would return its lineItem.

Parameters

mask: SelectionMask

a selection mask used to indicate the relevancy of the item to retrieve.

Returns: (None | NodeEntitySelectionItem)

the most relevant selection item if one exists. If no relevant item is found, null is returned.