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
Methods
Constructors
- CompositeSelectionItem.constructor(faceItem, lineItem, pointItem)
- Arguments
faceItem (
FaceSelectionItem()
| null) –lineItem (
LineSelectionItem()
| null) –pointItem (
PointSelectionItem()
| null) –
- Return type
Properties
- CompositeSelectionItem.faceItem
- Type
FaceSelectionItem()
| null
- CompositeSelectionItem.lineItem
- Type
LineSelectionItem()
| null
- CompositeSelectionItem.pointItem
- Type
PointSelectionItem()
| null
Methods
fetchMostRelevant
- 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 (SelectionMask) – a selection mask used to indicate the relevancy of the item to retrieve.
- Return type
NodeEntitySelectionItem()
| null- Returns
the most relevant selection item if one exists. If no relevant item is found, null is returned.