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

Constructors

constructor()

Properties

faceItem
lineItem
pointItem

Methods

fetchMostRelevant()

Constructors

CompositeSelectionItem.constructor(faceItem, lineItem, pointItem)

Arguments

faceItem (null | FaceSelectionItem()) – None
lineItem (null | LineSelectionItem()) – None
pointItem (null | PointSelectionItem()) – None

Return type

CompositeSelectionItem

Properties

CompositeSelectionItem.faceItem

Type: null | FaceSelectionItem

CompositeSelectionItem.lineItem

Type: null | LineSelectionItem

CompositeSelectionItem.pointItem

Type: null | PointSelectionItem

Methods

fetchMostRelevant

CompositeSelectionItem.fetchMostRelevant(mask)

Arguments

mask (SelectionMask()) – a selection mask used to indicate the relevancy of the item to retrieve.

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.

Returns: the most relevant selection item if one exists. If no relevant item is found, null is returned.
Return type: null | NodeEntitySelectionItem