#include <hps.h>

Public Member Functions | |
void | Assign (HighlightState const &in_that) |
bool | Equals (HighlightState const &in_that) const |
bool | GetDirectlyHighlighted () const |
bool | GetInheritsHighlight () const |
bool | GetOnHighlightPath () const |
bool | GetSubentityHighlighted () const |
HighlightState () | |
HighlightState (HighlightState const &in_that) | |
HighlightState (HighlightState &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (HighlightState const &in_that) const |
HighlightState & | operator= (HighlightState &&in_that) |
HighlightState & | operator= (HighlightState const &in_that) |
bool | operator== (HighlightState const &in_that) const |
void | Set (bool in_directly_highlighted, bool in_subentity_highlighted, bool in_inherits_highlight, bool in_on_highlight_path) |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::HighlightState |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The HighlightState class is a user space object. It is used to return highlight information from HighlightControl::ShowHighlightState or HighlightControl::ShowHighlightStates.
Constructor & Destructor Documentation
◆ HighlightState() [1/3]
HPS::HighlightState::HighlightState | ( | ) |
The default constructor creates an empty HighlightState object.
◆ HighlightState() [2/3]
HPS::HighlightState::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.
◆ HighlightState() [3/3]
HPS::HighlightState::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.
Member Function Documentation
◆ Assign()
void HPS::HighlightState::Assign | ( | HighlightState const & | in_that | ) |
Copies the source HighlightState into this HighlightState.
- Parameters
-
in_that The source HighlightState to copy.
◆ Equals()
bool HPS::HighlightState::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.
◆ GetDirectlyHighlighted()
bool HPS::HighlightState::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.
◆ GetInheritsHighlight()
bool HPS::HighlightState::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.
◆ GetOnHighlightPath()
bool HPS::HighlightState::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.
◆ GetSubentityHighlighted()
bool HPS::HighlightState::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.
◆ ObjectType()
|
inlinevirtual |
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.
Reimplemented from HPS::Object.
◆ operator!=()
bool HPS::HighlightState::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.
◆ operator=() [1/2]
HighlightState& HPS::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.
◆ operator=() [2/2]
HighlightState& HPS::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.
◆ operator==()
bool HPS::HighlightState::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.
◆ Set()
void HPS::HighlightState::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.
The documentation for this class was generated from the following file:
- include/hps.h