Inheritance diagram for HPS.ComponentHighlightEvent:
HPS.Event

Public Types

enum  Action { None = 0, Highlight = 1, Unhighlight = 2 }
 
- Public Types inherited from HPS.Event
enum  Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }
 

Public Member Functions

override HPS.Event Clone ()
 
 ComponentHighlightEvent ()
 
 ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.Canvas in_canvas, ulong in_layer, HPS.ComponentPath in_path, HPS.HighlightOptionsKit in_options)
 
 ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.Canvas in_canvas, ulong in_layer, HPS.ComponentPath in_path)
 
 ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.Canvas in_canvas, ulong in_layer)
 
 ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.Canvas in_canvas)
 
 ComponentHighlightEvent (HPS.Event in_event)
 
 ComponentHighlightEvent (HPS.ComponentHighlightEvent in_that)
 
override void Dispose ()
 
- Public Member Functions inherited from HPS.Event
virtual bool Drop (HPS.Event in_that_event)
 
delegate void DtorDelegate (IntPtr cPtr)
 
 Event (IntPtr in_channel)
 
 Event ()
 
 Event (HPS.Event in_that)
 
virtual IntPtr Freshen ()
 
IntPtr GetChannel ()
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 
bool IsConsumable ()
 

Protected Member Functions

override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Properties

HPS.ComponentHighlightEvent.Action action [get, set]
 
HPS.Canvas canvas [get, set]
 
ulong layer [get, set]
 
HPS.HighlightOptionsKit options [get, set]
 
HPS.ComponentPath path [get, set]
 

Additional Inherited Members

- Static Protected Member Functions inherited from HPS.Event
static void DtorCallback (IntPtr p)
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Event
static Dictionary< IntPtr, EventcachedObjects = new Dictionary<IntPtr, Event>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The ComponentHighlightEvent class is the event that will be triggered for each highlight or unhighlight call.

Constructor & Destructor Documentation

◆ ComponentHighlightEvent() [1/2]

HPS.ComponentHighlightEvent.ComponentHighlightEvent ( )
inline

The default constructor creates an empty ComponentHighlightEvent object.

◆ ComponentHighlightEvent() [2/2]

HPS.ComponentHighlightEvent.ComponentHighlightEvent ( HPS.Event  in_event)
inline

This constructor converts an Event Object to a ComponentHighlightEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

override HPS.Event HPS.ComponentHighlightEvent.Clone ( )
inlinevirtual

Allocates and returns a copy of this ComponentHighlightEvent.

Returns
A copy of this ComponentHighlightEvent.

Implements HPS.Event.


The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.ComponentHighlightEvent.cs