HPS.HighlightState
- class HPS.HighlightState : public HPS.Object
The HighlightState class is a user space object. It is used to return highlight information from HighlightControl.ShowHighlightState or HighlightControl.ShowHighlightStates.
Public Functions
- void Assign (HPS.HighlightState in_that)
Copies the source HighlightState into this HighlightState.
- Param in_that
The source HighlightState to copy.
- bool Equals (HPS.HighlightState in_that)
Check if the source HighlightState is equivalent to this HighlightState.
- Return
true if the objects are equivalent, false otherwise.
- bool GetDirectlyHighlighted ()
Indicates if a highlight exists on the queried key or key path.
- Return
Whether a highlight exists on the queried key or key path.
- bool GetInheritsHighlight ()
Indicates if a highlight exists above the queried key or key path.
- Return
Whether a highlight exists above the queried key or key path.
- bool GetOnHighlightPath ()
Indicates if a highlight exists below the queried key or key path.
- Return
Whether a highlight exists below the queried key or key path.
- bool GetSubentityHighlighted ()
Indicates if a sub-entity highlight exists on the queried key or key path. This value is only meaningful if the queried key or leaf of the key path is a shell or mesh since these are the only geometries for which it is possible to have subentity highlights.
- Return
Whether a subentity highlight exists on the queried key or key path.
- HighlightState ()
The default constructor creates an empty HighlightState object.
- HighlightState (HPS.HighlightState in_that)
The copy constructor creates a new HighlightState object that contains the same settings as the source HighlightState.
- Param in_that
The source HighlightState to copy.
- override HPS.Type ObjectType ()
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void Set (bool in_directly_highlighted, bool in_subentity_highlighted, bool in_inherits_highlight, bool in_on_highlight_path)
Sets the flags for this HighlightState. This facilitates the return of highlight state data to the user, and is not meant to be used outside of that use case.