HPS::CameraChangedEvent Class Reference
Inheritance diagram for HPS::CameraChangedEvent:
HPS::Event

Public Member Functions

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

Public Attributes

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
 

Constructor & Destructor Documentation

◆ CameraChangedEvent() [1/2]

HPS::CameraChangedEvent::CameraChangedEvent ( )
inline

The default constructor creates an empty CameraChangedEvent object.

◆ CameraChangedEvent() [2/2]

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

This constructor converts an Event Object to a CameraChangedEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

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

Allocates and returns a copy of this CameraChangedEvent.

Returns
A copy of this CameraChangedEvent.

Implements HPS::Event.

◆ Drop()

virtual bool HPS::CameraChangedEvent::Drop ( Event const *  in_that_event) const
inlinevirtual

This optional function is used to determine if the current event can be dropped based on the following event in the queue.

Reimplemented from HPS::Event.

◆ Freshen()

virtual intptr_t HPS::CameraChangedEvent::Freshen ( ) const
inlinevirtual

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.

Returns
A cookie representing the freshen category. Zero indicates a non-freshening event.

Reimplemented from HPS::Event.


The documentation for this class was generated from the following file: