CompositeSelectionItem

class Communicator.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

constructor

Communicator.Selection.CompositeSelectionItem.constructor(faceItem, lineItem, pointItem)

Arguments

faceItem ({ }()) –
lineItem ({ }()) –
pointItem ({ }()) –

Return type

Communicator.Selection.CompositeSelectionItem

Properties

Communicator.Selection.CompositeSelectionItem.faceItem

Communicator.Selection.CompositeSelectionItem.lineItem

Communicator.Selection.CompositeSelectionItem.pointItem

Methods

fetchMostRelevant

Communicator.Selection.CompositeSelectionItem.fetchMostRelevant(mask)

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.

Arguments

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

Return type

{ }

Returns

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