The IControl interface. More...

#include "murl_addons_vuforia_i_control.h"

Inherited by Murl::Addons::Vuforia::Control.

Public Types

enum  OperationMode { OPERATION_MODE_IDLE, OPERATION_MODE_VIEWING, OPERATION_MODE_TRACKING, OPERATION_MODE_SCANNING }
 The current operation mode. More...
 
enum  TrackableQuality { TRACKABLE_QUALITY_NONE, TRACKABLE_QUALITY_LOW, TRACKABLE_QUALITY_MEDIUM, TRACKABLE_QUALITY_HIGH }
 The current quality of a possible trackable, in scanning mode. More...
 
enum  FocusMode {
  FOCUS_MODE_NORMAL, FOCUS_MODE_TRIGGER_AUTO, FOCUS_MODE_CONTINUOUS_AUTO, FOCUS_MODE_INFINITY,
  FOCUS_MODE_MACRO
}
 Camera focus modes. More...
 

Public Member Functions

virtual IDataSetCreateDataSet ()=0
 Create a data set object. More...
 
virtual Bool DestroyDataSet (IDataSet *&dataSet)=0
 Destroy a previously created data set object. More...
 
virtual Bool SetMaxNumberOfTrackedObjects (UInt32 maxNumTrackables)=0
 Set the maximum number of objects that can be tracked simultaneously. More...
 
virtual UInt32 GetMaxNumberOfTrackedObjects () const =0
 Get the maximum number of objects that can be tracked simultaneously. More...
 
virtual Bool SetOperationMode (OperationMode newMode)=0
 Set the current operation mode. More...
 
virtual OperationMode GetOperationMode () const =0
 Get the current operation mode. More...
 
virtual Bool SetFocusMode (FocusMode newMode)=0
 Set the current camera focus mode. More...
 
virtual FocusMode GetFocusMode () const =0
 Get the current camera focus mode. More...
 
virtual Bool SetTorchEnabled (Bool enabled)=0
 Enable/disable the camera torch, if available. More...
 
virtual Bool IsTorchEnabled () const =0
 Check if the camera torch is on. More...
 
virtual const Math::Matrix< Float > & GetVirtualCameraProjection () const =0
 Get the projection matrix of the virtual camera. More...
 
virtual Float GetVirtualCameraNearPlane () const =0
 Get the absolute near plane distance of the virtual camera's projection matrix. More...
 
virtual Float GetVirtualCameraFarPlane () const =0
 Get the absolute far plane distance of the virtual camera's projection matrix. More...
 
virtual UInt32 GetNumberOfTrackedObjects () const =0
 Get the current number of tracked objects. More...
 
virtual const Math::Matrix< Float > & GetTrackedObjectPose (UInt32 index) const =0
 Get the pose matrix of a tracked object. More...
 
virtual SInt32 GetTrackedObjectId (UInt32 index) const =0
 Get the unique ID of a tracked object. More...
 
virtual String GetTrackedObjectName (UInt32 index) const =0
 Get the actual name of a tracked object. More...
 
virtual TrackableQuality GetScannedTrackableQuality () const =0
 Get the currently scanned trackable quality, if in scanning mode. More...
 
virtual Bool GetCameraImageStreams (IVideoStream *&lumaStream, IVideoStream *&chromaStream)=0
 Get the live camera image streams. More...
 
virtual UInt32 GetCameraImageSizeX () const =0
 Get the horizontal size of the camera image in pixels. More...
 
virtual UInt32 GetCameraImageSizeY () const =0
 Get the vertical size of the camera image in pixels. More...
 

Static Public Member Functions

static IControlGetInstance ()
 Get the instance of the master control. More...
 

Detailed Description

The IControl interface.

This interface represents the main control exposing the functionality of the Vuforia toolkit.

Member Enumeration Documentation

◆ OperationMode

The current operation mode.

Enumerator
OPERATION_MODE_IDLE 

Idle mode; live camera video and tracking are disabled.

OPERATION_MODE_VIEWING 

Viewing mode; live camera video is enabled and tracking disabled.

OPERATION_MODE_TRACKING 

Tracking mode; live camera video and tracking are both enabled.

OPERATION_MODE_SCANNING 

Scanning mode; live camera video is enabled.

◆ TrackableQuality

The current quality of a possible trackable, in scanning mode.

Enumerator
TRACKABLE_QUALITY_NONE 

No quality available.

TRACKABLE_QUALITY_LOW 

Low quality.

TRACKABLE_QUALITY_MEDIUM 

Medium quality.

TRACKABLE_QUALITY_HIGH 

High quality.

◆ FocusMode

Camera focus modes.

Enumerator
FOCUS_MODE_NORMAL 

Normal mode.

FOCUS_MODE_TRIGGER_AUTO 

Single-trigger auto focus mode.

FOCUS_MODE_CONTINUOUS_AUTO 

Continuous auto focus mode.

FOCUS_MODE_INFINITY 

Focus to infinity.

FOCUS_MODE_MACRO 

Macro mode.

Member Function Documentation

◆ GetInstance()

static IControl* Murl::Addons::Vuforia::IControl::GetInstance ( )
static

Get the instance of the master control.

Returns
The control.

◆ CreateDataSet()

virtual IDataSet* Murl::Addons::Vuforia::IControl::CreateDataSet ( )
pure virtual

Create a data set object.

Returns
The newly created data set object, or null if failed.

◆ DestroyDataSet()

virtual Bool Murl::Addons::Vuforia::IControl::DestroyDataSet ( IDataSet *&  dataSet)
pure virtual

Destroy a previously created data set object.

Parameters
dataSetA reference to a pointer holding the data set object to destroy.
Returns
true if successful.

◆ SetMaxNumberOfTrackedObjects()

virtual Bool Murl::Addons::Vuforia::IControl::SetMaxNumberOfTrackedObjects ( UInt32  maxNumTrackables)
pure virtual

Set the maximum number of objects that can be tracked simultaneously.

Parameters
maxNumTrackablesThe maximum number of trackable objects.
Returns
true if successful.

◆ GetMaxNumberOfTrackedObjects()

virtual UInt32 Murl::Addons::Vuforia::IControl::GetMaxNumberOfTrackedObjects ( ) const
pure virtual

Get the maximum number of objects that can be tracked simultaneously.

Returns
The maximum number of trackable objects.

◆ SetOperationMode()

virtual Bool Murl::Addons::Vuforia::IControl::SetOperationMode ( OperationMode  newMode)
pure virtual

Set the current operation mode.

Parameters
newModeThe mode to set.
Returns
true if successful.

◆ GetOperationMode()

virtual OperationMode Murl::Addons::Vuforia::IControl::GetOperationMode ( ) const
pure virtual

Get the current operation mode.

Returns
The current operation mode.

◆ SetFocusMode()

virtual Bool Murl::Addons::Vuforia::IControl::SetFocusMode ( FocusMode  newMode)
pure virtual

Set the current camera focus mode.

Parameters
newModeThe mode to set.
Returns
true if successful.

◆ GetFocusMode()

virtual FocusMode Murl::Addons::Vuforia::IControl::GetFocusMode ( ) const
pure virtual

Get the current camera focus mode.

Returns
The current camera focus mode.

◆ SetTorchEnabled()

virtual Bool Murl::Addons::Vuforia::IControl::SetTorchEnabled ( Bool  enabled)
pure virtual

Enable/disable the camera torch, if available.

Parameters
enabledIf true, the torch is enabled.
Returns
true if successful.

◆ IsTorchEnabled()

virtual Bool Murl::Addons::Vuforia::IControl::IsTorchEnabled ( ) const
pure virtual

Check if the camera torch is on.

Returns
true if the torch is enabled.

◆ GetVirtualCameraProjection()

virtual const Math::Matrix<Float>& Murl::Addons::Vuforia::IControl::GetVirtualCameraProjection ( ) const
pure virtual

Get the projection matrix of the virtual camera.

Returns
The projection matrix.

◆ GetVirtualCameraNearPlane()

virtual Float Murl::Addons::Vuforia::IControl::GetVirtualCameraNearPlane ( ) const
pure virtual

Get the absolute near plane distance of the virtual camera's projection matrix.

Returns
The near plane distance.

◆ GetVirtualCameraFarPlane()

virtual Float Murl::Addons::Vuforia::IControl::GetVirtualCameraFarPlane ( ) const
pure virtual

Get the absolute far plane distance of the virtual camera's projection matrix.

Returns
The far plane distance.

◆ GetNumberOfTrackedObjects()

virtual UInt32 Murl::Addons::Vuforia::IControl::GetNumberOfTrackedObjects ( ) const
pure virtual

Get the current number of tracked objects.

Returns
The number of tracked objects.

◆ GetTrackedObjectPose()

virtual const Math::Matrix<Float>& Murl::Addons::Vuforia::IControl::GetTrackedObjectPose ( UInt32  index) const
pure virtual

Get the pose matrix of a tracked object.

Parameters
indexThe index of the tracked object, from 0 to GetNumberOfTrackedObjects().
Returns
The object pose.

◆ GetTrackedObjectId()

virtual SInt32 Murl::Addons::Vuforia::IControl::GetTrackedObjectId ( UInt32  index) const
pure virtual

Get the unique ID of a tracked object.

Parameters
indexThe index of the tracked object, from 0 to GetNumberOfTrackedObjects().
Returns
The unique object ID.

◆ GetTrackedObjectName()

virtual String Murl::Addons::Vuforia::IControl::GetTrackedObjectName ( UInt32  index) const
pure virtual

Get the actual name of a tracked object.

Parameters
indexThe index of the tracked object, from 0 to GetNumberOfTrackedObjects().
Returns
The object name.

◆ GetScannedTrackableQuality()

virtual TrackableQuality Murl::Addons::Vuforia::IControl::GetScannedTrackableQuality ( ) const
pure virtual

Get the currently scanned trackable quality, if in scanning mode.

Returns
The quality.

◆ GetCameraImageStreams()

virtual Bool Murl::Addons::Vuforia::IControl::GetCameraImageStreams ( IVideoStream *&  lumaStream,
IVideoStream *&  chromaStream 
)
pure virtual

Get the live camera image streams.

Parameters
lumaStreamA reference to a pointer receiving the luminance (Y) stream.
chromaStreamA reference to a pointer receiving the chrominance (U/V) stream.
Returns
true if successful.

◆ GetCameraImageSizeX()

virtual UInt32 Murl::Addons::Vuforia::IControl::GetCameraImageSizeX ( ) const
pure virtual

Get the horizontal size of the camera image in pixels.

Returns
The horizontal size.

◆ GetCameraImageSizeY()

virtual UInt32 Murl::Addons::Vuforia::IControl::GetCameraImageSizeY ( ) const
pure virtual

Get the vertical size of the camera image in pixels.

Returns
The vertical size.

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


Copyright © 2011-2018 Spraylight GmbH.