API Search || Global Search

More...

Inheritance diagram for HPS.HighlightState:
HPS.Object

Public Member Functions

void Assign (HPS.HighlightState in_that)
 Copies the source HighlightState into this HighlightState. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HighlightState in_that)
 Check if the source HighlightState is equivalent to this HighlightState. More...
 
bool GetDirectlyHighlighted ()
 Indicates if a highlight exists on the queried key or key path. More...
 
override int GetHashCode ()
 
bool GetInheritsHighlight ()
 Indicates if a highlight exists above the queried key or key path. More...
 
bool GetOnHighlightPath ()
 Indicates if a highlight exists below the queried key or key path. More...
 
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. More...
 
 HighlightState ()
 The default constructor creates an empty HighlightState object. More...
 
 HighlightState (HPS.HighlightState in_that)
 The copy constructor creates a new HighlightState object that contains the same settings as the source HighlightState. More...
 
override HPS.Type ObjectType ()
 
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. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

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

HPS.HighlightState.HighlightState ( )
inline

The default constructor creates an empty HighlightState object.

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

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

Copies the source HighlightState into this HighlightState.

Parameters
in_thatThe source HighlightState to copy.
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.
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.
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.
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.
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.
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