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(HighlightState const &in_that)

Copies the source HighlightState into this HighlightState.

Parameters: in_that – The source HighlightState to copy.

bool Equals(HighlightState const &in_that) const

Check if the source HighlightState is equivalent to this HighlightState.

Parameters: in_kit – The source HighlightState to compare to this HighlightState.
Returns: true if the objects are equivalent, false otherwise.

bool GetDirectlyHighlighted() const

Indicates if a highlight exists on the queried key or key path.

Returns: Whether a highlight exists on the queried key or key path.

bool GetInheritsHighlight() const

Indicates if a highlight exists above the queried key or key path.

Returns: Whether a highlight exists above the queried key or key path.

bool GetOnHighlightPath() const

Indicates if a highlight exists below the queried key or key path.

Returns: Whether a highlight exists below the queried key or key path.

bool GetSubentityHighlighted() const

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.

Returns: Whether a subentity highlight exists on the queried key or key path.

HighlightState(): The default constructor creates an empty HighlightState object.

HighlightState(HighlightState &&in_that)

The move constructor creates a HighlightState by transferring the underlying impl of the rvalue reference to this HighlightState thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a HighlightState to take the impl from.

HighlightState(HighlightState const &in_that)

The copy constructor creates a new HighlightState object that contains the same settings as the source HighlightState.

Parameters: in_that – The source HighlightState to copy.

inline virtual HPS::Type ObjectType() const

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

Returns: The declared type of the object in question, which may differ from the true, underlying type.

bool operator!=(HighlightState const &in_that) const

Check if the source HighlightState is not equivalent to this HighlightState.

Parameters: in_kit – The source HighlightState to compare to this HighlightState.
Returns: true if the objects are not equivalent, false otherwise.

HighlightState &operator=(HighlightState &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightState thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a HighlightState to take the impl from.
Returns: A reference to this HighlightState.

HighlightState &operator=(HighlightState const &in_that)

Copies the source HighlightState into this HighlightState.

Parameters: in_that – The source HighlightState to copy.
Returns: A reference to this HighlightState.

bool operator==(HighlightState const &in_that) const

Check if the source HighlightState is equivalent to this HighlightState.

Parameters: in_kit – The source HighlightState to compare to this HighlightState.
Returns: true if the objects are equivalent, false otherwise.

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.

~HighlightState()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::HighlightState