HPS.SmoothTransitionCompleteEvent Class Reference

The SmoothTransitionCompleteEvent class is the event that will be triggered when a Smooth Transition ends. More...

Inheritance diagram for HPS.SmoothTransitionCompleteEvent:
HPS.Event

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)
 
- Public Member Functions inherited from HPS.Event
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 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
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...
 

Protected Member Functions

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

Properties

HPS.View view [get, set]
 

Additional Inherited Members

- Public Types inherited from HPS.Event
enum  Status { Status.InProgress = 0, Status.Completed = 1, Status.Failed = 2 }
 Event Status - returned from a notifier to give the status of the event. More...
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The SmoothTransitionCompleteEvent class is the event that will be triggered when a Smooth Transition ends.

Constructor & Destructor Documentation

HPS.SmoothTransitionCompleteEvent.SmoothTransitionCompleteEvent ( )
inline

The default constructor creates a SmoothTransitionCompleteEvent object.

HPS.SmoothTransitionCompleteEvent.SmoothTransitionCompleteEvent ( HPS.View  in_view)
inline

This constructor creates a SmoothTransitionCompleteEvent object and associates it with a View.

Parameters
in_viewThe View that initiated the smooth transition.
HPS.SmoothTransitionCompleteEvent.SmoothTransitionCompleteEvent ( HPS.Event  in_event)
inline

This constructor converts an Event Object to a SmoothTransitionCompleteEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

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

Allocates and returns a copy of this SmoothTransitionCompleteEvent.

Returns
A copy of this SmoothTransitionCompleteEvent.

Implements HPS.Event.

override bool HPS.SmoothTransitionCompleteEvent.Drop ( HPS.Event  in_that_event)
inlinevirtual

Determines if this SmoothTransitionCompleteEvent can be drop in favor of the following event of the same type.

Parameters
in_that_eventEvent 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