Ocean
Loading...
Searching...
No Matches
Ocean::Tracking::Offline::TrackerPlaneStateEvent Class Reference

This class implements a tracker plane state event that provides the detected plane of a tracker. More...

#include <TrackerEvent.h>

Inheritance diagram for Ocean::Tracking::Offline::TrackerPlaneStateEvent:

Public Member Functions

 TrackerPlaneStateEvent (const unsigned int trackerId, const Plane3 &plane)
 Creates a new plane state event object.
 
const Plane3plane () const
 Returns the plane of this object.
 
- Public Member Functions inherited from Ocean::Tracking::Offline::StateEvent
std::string subtypeName () const override
 Returns the sub-type name of this event object.
 
- Public Member Functions inherited from Ocean::Tracking::Offline::TrackerEvent
unsigned int trackerId () const
 Returns the unique id of the tracker that sent this event.
 
std::string typeName () const
 Returns the type name of this event.
 
- Public Member Functions inherited from Ocean::Event
virtual ~Event ()
 Destructs an event object.
 
unsigned int type () const
 Returns the type of this event.
 
unsigned int subtype () const
 Returns the sub-type of this event.
 
template<typename T >
const T & cast () const
 Casts this event to an event with specified type.
 
template<typename T >
T & cast ()
 Casts this event to an event with specified type.
 

Static Public Member Functions

static EventRef createEvent (const unsigned int trackerId, const Plane3 &plane)
 Creates a new event reference object.
 

Protected Attributes

const Plane3 plane_
 The plane of this event.
 
- Protected Attributes inherited from Ocean::Tracking::Offline::TrackerEvent
unsigned int trackerId_ = 0u
 The unique tracker id of the tracker that sent this event.
 
- Protected Attributes inherited from Ocean::Event
unsigned int eventType
 The type of the event.
 
unsigned int eventSubtype
 The sub-type of the event.
 

Additional Inherited Members

- Public Types inherited from Ocean::Tracking::Offline::StateEvent
enum  StateEventSubType {
  SEST_INVALID = 0 , SEST_CAMERA_CALIBRATION , SEST_TRACKER_TRANSFORMATION , SEST_TRACKER_POSE ,
  SEST_TRACKER_POSES , SEST_TRACKER_PLANE
}
 Definition of individual state event sub-types. More...
 
- Protected Member Functions inherited from Ocean::Tracking::Offline::StateEvent
 StateEvent (const unsigned int subtype, const unsigned int trackerId)
 Creates a new state event object.
 
- Protected Member Functions inherited from Ocean::Tracking::Offline::TrackerEvent
 TrackerEvent (const unsigned int type, const unsigned int subtype, const unsigned int trackerId)
 Creates a new tracker event object.
 
- Protected Member Functions inherited from Ocean::Event
 Event (const unsigned int type, const unsigned int subtype)
 Creates a new event object.
 

Detailed Description

This class implements a tracker plane state event that provides the detected plane of a tracker.

Constructor & Destructor Documentation

◆ TrackerPlaneStateEvent()

Ocean::Tracking::Offline::TrackerPlaneStateEvent::TrackerPlaneStateEvent ( const unsigned int  trackerId,
const Plane3 plane 
)
inlineexplicit

Creates a new plane state event object.

Parameters
trackerIdUnique id of the tracker that sent this event
planeTracker plane of the sender

Member Function Documentation

◆ createEvent()

EventRef Ocean::Tracking::Offline::TrackerPlaneStateEvent::createEvent ( const unsigned int  trackerId,
const Plane3 plane 
)
inlinestatic

Creates a new event reference object.

Parameters
trackerIdUnique id of the tracker that sent this event
planeTracker plane of the sender
Returns
The new event object

◆ plane()

const Plane3 & Ocean::Tracking::Offline::TrackerPlaneStateEvent::plane ( ) const
inline

Returns the plane of this object.

Returns
Event plane

Field Documentation

◆ plane_

const Plane3 Ocean::Tracking::Offline::TrackerPlaneStateEvent::plane_
protected

The plane of this event.


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