HPS.SmoothTransitionCompleteEvent Class Reference
Inheritance diagram for HPS.SmoothTransitionCompleteEvent:

Public Member Functions | |
override HPS.Event | Clone () |
Allocates and returns a copy of this SmoothTransitionCompleteEvent. More... | |
override void | Dispose () |
override bool | Drop (HPS.Event in_that_event) |
Determines if this SmoothTransitionCompleteEvent can be drop in favor of the following event of the same type. More... | |
SmoothTransitionCompleteEvent () | |
The default constructor creates a SmoothTransitionCompleteEvent object. More... | |
SmoothTransitionCompleteEvent (HPS.View in_view) | |
This constructor creates a SmoothTransitionCompleteEvent object and associates it with a View. More... | |
SmoothTransitionCompleteEvent (HPS.Event in_event) | |
This constructor converts an Event Object to a SmoothTransitionCompleteEvent object. More... | |
SmoothTransitionCompleteEvent (HPS.SmoothTransitionCompleteEvent in_that) | |
delegate IntPtr | SmoothTransitionCompleteEventDelegate_0 (IntPtr cPtr) |
delegate bool | SmoothTransitionCompleteEventDelegate_1 (IntPtr cPtr, IntPtr in_that_event) |
delegate IntPtr | SmoothTransitionCompleteEventDelegate_2 (IntPtr cPtr) |
![]() | |
delegate void | DtorDelegate (IntPtr cPtr) |
Event (IntPtr in_channel) | |
A constructor for generating events from built-in or custom event ID's. More... | |
Event () | |
A constructor for generating events from built-in or custom event ID's. More... | |
Event (HPS.Event in_that) | |
delegate IntPtr | EventDelegate_0 (IntPtr cPtr) |
delegate bool | EventDelegate_1 (IntPtr cPtr, IntPtr in_that_event) |
delegate IntPtr | EventDelegate_2 (IntPtr cPtr) |
virtual IntPtr | Freshen () |
This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available. More... | |
IntPtr | GetChannel () |
Returns the channel ID assigned to an event. More... | |
IntPtr | GetClassID () |
double | GetTimeStamp () |
Returns the time an event was injected into the event queue. More... | |
bool | IsConsumable () |
Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More... | |
Properties | |
HPS.View | view [get, set] |
Additional Inherited Members | |
![]() | |
enum | Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 } |
Event Status - returned from a notifier to give the status of the event. More... | |
![]() | |
static void | DtorCallback (IntPtr p) |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
![]() | |
static Dictionary< IntPtr, Event > | cachedObjects = new Dictionary<IntPtr, Event>() |
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
Detailed Description
The SmoothTransitionCompleteEvent class is the event that will be triggered when a Smooth Transition ends.
Constructor & Destructor Documentation
◆ SmoothTransitionCompleteEvent() [1/3]
|
inline |
The default constructor creates a SmoothTransitionCompleteEvent object.
◆ SmoothTransitionCompleteEvent() [2/3]
|
inline |
This constructor creates a SmoothTransitionCompleteEvent object and associates it with a View.
- Parameters
-
in_view The View that initiated the smooth transition.
◆ SmoothTransitionCompleteEvent() [3/3]
|
inline |
This constructor converts an Event Object to a SmoothTransitionCompleteEvent object.
Member Function Documentation
◆ Clone()
|
inlinevirtual |
Allocates and returns a copy of this SmoothTransitionCompleteEvent.
- Returns
- A copy of this SmoothTransitionCompleteEvent.
Implements HPS.Event.
◆ Drop()
|
inlinevirtual |
Determines if this SmoothTransitionCompleteEvent can be drop in favor of the following event of the same type.
- Parameters
-
in_that_event Event to compare with this SmoothTransitionCompleteEvent.
- Returns
- true is this event can be dropped.
Reimplemented from HPS.Event.
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.SmoothTransitionCompleteEvent.cs