Murl::Addons::Vuforia::IDataSet Interface Referenceabstract

The IDataSet interface. More...

#include "murl_addons_vuforia_i_data_set.h"

Inherited by Murl::Addons::Vuforia::DataSet.

Public Member Functions

virtual const ITrackableAddTrackableFromResource (const ConstData &xml, const ConstData &dat)=0
 Add a trackable from a given resource. More...
 
virtual const ITrackableAddTrackableFromScanner (const String &name, Real sceneSize)=0
 Create and add a trackable on the fly, when the control is in scanning mode. More...
 
virtual UInt32 GetNumberOfTrackables () const =0
 Get the number of trackables contained in this data set. More...
 
virtual const ITrackableGetTrackable (UInt32 index) const =0
 Get the trackable at a given index. More...
 
virtual Bool DeleteTrackable (UInt32 index)=0
 Delete the trackable at a given index. More...
 
virtual Bool DeleteTrackable (const ITrackable *trackable)=0
 Delete a given trackable from the data set. More...
 
virtual Bool DeleteAllTrackables ()=0
 Delete all trackables in the data set. More...
 
virtual Bool SetActive (Bool enabled)=0
 Activate/deactivate the data set. More...
 
virtual Bool IsActive () const =0
 Check if the data set is active. More...
 

Detailed Description

The IDataSet interface.

A data set is a container for one or more trackables. There can be any number of data sets simultaneously present, and they can be activated or deactivated independently of each other.

Member Function Documentation

◆ AddTrackableFromResource()

virtual const ITrackable* Murl::Addons::Vuforia::IDataSet::AddTrackableFromResource ( const ConstData xml,
const ConstData dat 
)
pure virtual

Add a trackable from a given resource.

Parameters
xmlThe trackable's XML description.
datThe trackable's actual binary data.
Returns
The newly created trackable, or null if failed.

◆ AddTrackableFromScanner()

virtual const ITrackable* Murl::Addons::Vuforia::IDataSet::AddTrackableFromScanner ( const String name,
Real  sceneSize 
)
pure virtual

Create and add a trackable on the fly, when the control is in scanning mode.

Parameters
nameThe name of the trackable to create.
sceneSizeThe trackable's virtual size.
Returns
The newly created trackable, or null if failed.

◆ GetNumberOfTrackables()

virtual UInt32 Murl::Addons::Vuforia::IDataSet::GetNumberOfTrackables ( ) const
pure virtual

Get the number of trackables contained in this data set.

Returns
The number of trackables.

◆ GetTrackable()

virtual const ITrackable* Murl::Addons::Vuforia::IDataSet::GetTrackable ( UInt32  index) const
pure virtual

Get the trackable at a given index.

Parameters
indexThe index of the trackable in the data set, from 0 to GetNumberOfTrackables()-1.
Returns
The trackable, or null if the index is out of range.

◆ DeleteTrackable() [1/2]

virtual Bool Murl::Addons::Vuforia::IDataSet::DeleteTrackable ( UInt32  index)
pure virtual

Delete the trackable at a given index.

Parameters
indexThe index of the trackable in the data set, from 0 to GetNumberOfTrackables()-1.
Returns
true if successful.

◆ DeleteTrackable() [2/2]

virtual Bool Murl::Addons::Vuforia::IDataSet::DeleteTrackable ( const ITrackable trackable)
pure virtual

Delete a given trackable from the data set.

Parameters
trackableThe trackable to delete.
Returns
true if successful.

◆ DeleteAllTrackables()

virtual Bool Murl::Addons::Vuforia::IDataSet::DeleteAllTrackables ( )
pure virtual

Delete all trackables in the data set.

Returns
true if successful.

◆ SetActive()

virtual Bool Murl::Addons::Vuforia::IDataSet::SetActive ( Bool  enabled)
pure virtual

Activate/deactivate the data set.

Parameters
enabledIf true, the data set is enabled.
Returns
true if successful.

◆ IsActive()

virtual Bool Murl::Addons::Vuforia::IDataSet::IsActive ( ) const
pure virtual

Check if the data set is active.

Returns
true if active.

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


Copyright © 2011-2018 Spraylight GmbH.