The ITrackable interface. More...

#include "murl_addons_vuforia_i_trackable.h"

Inherited by Murl::Addons::Vuforia::Trackable.

Public Types

enum  State { STATE_IDLE, STATE_LOADED, STATE_ERROR }
 The state of the trackable. More...
 

Public Member Functions

virtual State GetState () const =0
 Get the current state. More...
 
virtual const IVideoSurfaceGetLuminanceSurface () const =0
 Get the trackable's luminance surface, i.e. More...
 
virtual IVideoSurfacePtr CloneLuminanceSurface (IEnums::ScreenOrientation screenOrientation) const =0
 Clone the trackable's luminance surface, with optional orientation. More...
 

Detailed Description

The ITrackable interface.

This interface represents a single trackable, either loaded from a resource or built on the fly via scanning mode.

Member Enumeration Documentation

◆ State

The state of the trackable.

Enumerator
STATE_IDLE 

Idle state, i.e. no trackable data present.

STATE_LOADED 

Successfully loaded.

STATE_ERROR 

Error during creation.

Member Function Documentation

◆ GetState()

virtual State Murl::Addons::Vuforia::ITrackable::GetState ( ) const
pure virtual

Get the current state.

Returns
The current state.

◆ GetLuminanceSurface()

virtual const IVideoSurface* Murl::Addons::Vuforia::ITrackable::GetLuminanceSurface ( ) const
pure virtual

Get the trackable's luminance surface, i.e.

the grayscale image it was created from.

Returns
The luminance surface, or null if not available.

◆ CloneLuminanceSurface()

virtual IVideoSurfacePtr Murl::Addons::Vuforia::ITrackable::CloneLuminanceSurface ( IEnums::ScreenOrientation  screenOrientation) const
pure virtual

Clone the trackable's luminance surface, with optional orientation.

Parameters
screenOrientationThe orientation of the clone.
Returns
A clone of the luminance surface, or null if not available.

The documentation for this interface was generated from the following file:
  • murl_addons_vuforia_i_trackable.h


Copyright © 2011-2018 Spraylight GmbH.