Inheritance diagram for HPS.HighlightState:
HPS.Object

Public Member Functions

void Assign (HPS.HighlightState in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HighlightState in_that)
 
bool GetDirectlyHighlighted ()
 
override int GetHashCode ()
 
bool GetInheritsHighlight ()
 
bool GetOnHighlightPath ()
 
bool GetSubentityHighlighted ()
 
 HighlightState ()
 
 HighlightState (HPS.HighlightState in_that)
 
override HPS.Type ObjectType ()
 
void Set (bool in_directly_highlighted, bool in_subentity_highlighted, bool in_inherits_highlight, bool in_on_highlight_path)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.HighlightState a, HPS.HighlightState b)
 
static bool operator== (HPS.HighlightState a, HPS.HighlightState b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.HighlightState.HighlightState ( )
inline

The default constructor creates an empty HighlightState object.

◆ HighlightState() [2/2]

HPS.HighlightState.HighlightState ( HPS.HighlightState  in_that)
inline

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

Parameters
in_thatThe source HighlightState to copy.

Member Function Documentation

◆ Assign()

void HPS.HighlightState.Assign ( HPS.HighlightState  in_that)
inline

Copies the source HighlightState into this HighlightState.

Parameters
in_thatThe source HighlightState to copy.

◆ Equals()

bool HPS.HighlightState.Equals ( HPS.HighlightState  in_that)
inline

Check if the source HighlightState is equivalent to this HighlightState.

Returns
true if the objects are equivalent, false otherwise.

◆ GetDirectlyHighlighted()

bool HPS.HighlightState.GetDirectlyHighlighted ( )
inline

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 ( )
inline

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 ( )
inline

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 ( )
inline

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

override HPS.Type HPS.HighlightState.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.

◆ Set()

void HPS.HighlightState.Set ( bool  in_directly_highlighted,
bool  in_subentity_highlighted,
bool  in_inherits_highlight,
bool  in_on_highlight_path 
)
inline

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:
  • internals/hps_core/source/cs/HPS.HighlightState.cs