HPS::SmoothTransitionCompleteEvent Class Reference

#include <sprk.h>

Inheritance diagram for HPS::SmoothTransitionCompleteEvent:
HPS::Event

Public Member Functions

EventClone () const
 
virtual bool Drop (Event const *in_that_event) const
 
 SmoothTransitionCompleteEvent ()
 
 SmoothTransitionCompleteEvent (HPS::View const &in_view)
 
 SmoothTransitionCompleteEvent (Event const &in_event)
 
- Public Member Functions inherited from HPS::Event
 Event (intptr_t in_channel=0)
 
virtual intptr_t Freshen () const
 
intptr_t GetChannel () const
 
intptr_t GetClassID () const
 
Time GetTimeStamp () const
 
bool IsConsumable () const
 

Public Attributes

HPS::View view
 

Additional Inherited Members

- Public Types inherited from HPS::Event
enum  Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
 
- Static Public Member Functions inherited from HPS::Event
static void operator delete (void *in_ptr, size_t in_size) throw ()
 
static void * operator new (size_t in_size)
 
- Protected Attributes inherited from HPS::Event
intptr_t channel
 
bool consumable
 

Detailed Description

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

Constructor & Destructor Documentation

◆ SmoothTransitionCompleteEvent() [1/3]

HPS::SmoothTransitionCompleteEvent::SmoothTransitionCompleteEvent ( )
inline

The default constructor creates a SmoothTransitionCompleteEvent object.

◆ SmoothTransitionCompleteEvent() [2/3]

HPS::SmoothTransitionCompleteEvent::SmoothTransitionCompleteEvent ( HPS::View const &  in_view)
inline

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

Parameters
in_viewThe View that initiated the smooth transition.

◆ SmoothTransitionCompleteEvent() [3/3]

HPS::SmoothTransitionCompleteEvent::SmoothTransitionCompleteEvent ( Event const &  in_event)
inline

This constructor converts an Event Object to a SmoothTransitionCompleteEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

Event* HPS::SmoothTransitionCompleteEvent::Clone ( ) const
inlinevirtual

Allocates and returns a copy of this SmoothTransitionCompleteEvent.

Returns
A copy of this SmoothTransitionCompleteEvent.

Implements HPS::Event.

◆ Drop()

virtual bool HPS::SmoothTransitionCompleteEvent::Drop ( Event const *  in_that_event) const
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: