|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HighlightState class is a user space object. It is used to return highlight information from HighlightControl.ShowHighlightState or HighlightControl.ShowHighlightStates.
◆ HighlightState() [1/2]
HPS.HighlightState.HighlightState |
( |
| ) |
|
|
inline |
◆ HighlightState() [2/2]
◆ Assign()
◆ Equals()
◆ 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