ObserverFactory Class Reference

Provides methods to create Vuforia tracked targets More...

Public Member Functions
AnchorBehaviour	CreateAnchorBehaviour (string name, Vector3 position, Quaternion rotation)
	Creates an Anchor Behaviour in mid air using the transform of the pose (position/rotation) where it should be anchored. More...
AnchorBehaviour	CreateAnchorBehaviour (string name, HitTestResult hitTestResult)
	Creates an Anchor Behaviour on a plane using the location (position/rotation) of a HitTestResult from a previous World.HitTest(). More...
AreaTargetBehaviour	CreateAreaTarget (string databasePath, string targetName, bool requiresExternalPositions=false)
	Creates an Area Target Behaviour from a target stored in a Vuforia database. More...
AreaTargetBehaviour	CreateAreaTarget (string databasePath, string targetName, bool hasOcclusion, bool hasCollision, string occlusionModelPath=null, bool requiresExternalPositions=false)
	Creates an Area Target Behaviour from a target stored in a Vuforia database. More...
async Task< AreaTargetBehaviour >	CreateAreaTargetAsync (string databasePath, string targetName, bool requiresExternalPositions=false)
	Asynchronously creates an Area Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target. More...
async Task< AreaTargetBehaviour >	CreateAreaTargetAsync (string databasePath, string targetName, bool hasOcclusion, bool hasCollision, string occlusionModelPath=null, bool requiresExternalPositions=false)
	Asynchronously creates an Area Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target. More...
BarcodeBehaviour	CreateBarcodeBehaviour (HashSet< BarcodeBehaviour.BarcodeType > observedTypes, bool detectMultipleBarcodes)
	Creates a Barcode Behaviour More...
IEnumerable< ObserverBehaviour >	CreateBehavioursFromDatabase (string databasePath)
	Creates Behaviours from all observers in a database. More...
CloudRecoBehaviour	CreateCloudRecoBehaviour (string accessKey, string secretKey)
	Creates a Cloud Recognition using auth keys. Then initializes the reco. More...
CylinderTargetBehaviour	CreateCylinderTarget (string databasePath, string targetName)
	Creates a Cylinder Target Behaviour from a target stored in a Vuforia database. More...
async Task< CylinderTargetBehaviour >	CreateCylinderTargetAsync (string databasePath, string targetName)
	Asynchronously creates a Cylinder Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target. More...
ImageTargetBehaviour	CreateImageTarget (string databasePath, string targetName)
	Creates an Image Target Behaviour from a target stored in a Vuforia database. More...
ImageTargetBehaviour	CreateImageTarget (string filePath, float widthInMeters, string targetName)
	Creates an Image Target from a path to a Unity Texture file. More...
ImageTargetBehaviour	CreateImageTarget (Texture2D texture, float widthInMeters, string targetName)
	Creates an Image Target from a Unity Texture2D. More...
ImageTargetBehaviour	CreateImageTarget (IntPtr texturePointer, int textureWidth, int textureHeight, TextureFormat format, float widthInMeters, string targetName)
	Create an Image Target using raw image data loaded by functions independent from Vuforia Engine. More...
async Task< ImageTargetBehaviour >	CreateImageTargetAsync (string databasePath, string targetName)
	Asynchronously creates an Image Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target. More...
async Task< ImageTargetBehaviour >	CreateImageTargetAsync (string filePath, float widthInMeters, string targetName)
	Asynchronously creates an Image Target from a path to a Unity Texture file. Use this method to prevent blocking the main thread while loading the target. More...
async Task< ImageTargetBehaviour >	CreateImageTargetAsync (Texture2D texture, float widthInMeters, string targetName)
	Asynchronously creates an Image Target from a Unity Texture2D. Use this method to prevent blocking the main thread while loading the target. More...
async Task< ImageTargetBehaviour >	CreateImageTargetAsync (IntPtr texturePointer, int textureWidth, int textureHeight, TextureFormat format, float widthInMeters, string targetName)
	Asynchronously create an Image Target using raw image data loaded by functions independent from Vuforia Engine. Use this method to prevent blocking the main thread while loading the target. More...
ModelTargetBehaviour	CreateModelTarget (string databasePath, string targetName, TrackingOptimization? trackingOptimization=null)
	Creates a Model Target Behaviour from a target stored in a Vuforia database. More...
ModelTargetBehaviour	CreateModelTarget (string databasePath, string targetName, bool hasOcclusion, bool hasCollision, TrackingOptimization? trackingOptimization=null)
	Creates a Model Target Behaviour from a target stored in a Vuforia database. More...
Task< ModelTargetBehaviour >	CreateModelTargetAsync (string databasePath, string targetName, TrackingOptimization? trackingOptimization=null)
	Asynchronously creates a Model Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target. More...
async Task< ModelTargetBehaviour >	CreateModelTargetAsync (string databasePath, string targetName, bool hasOcclusion, bool hasCollision, TrackingOptimization? trackingOptimization=null)
	Asynchronously creates a Model Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target. More...
MultiTargetBehaviour	CreateMultiTarget (string databasePath, string targetName)
	Creates a Multi Target Behaviour from a target stored in a Vuforia database. More...
async Task< MultiTargetBehaviour >	CreateMultiTargetAsync (string databasePath, string targetName)
	Asynchronously creates a Multi Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target. More...
GameObject	CreateRuntimeMeshRenderingBehaviour (ModelTargetBehaviour modelTargetBehaviour, Material displayMaterial)
	Create a Runtime Mesh Behaviour for the Model Target. More...
GameObject	CreateRuntimeMeshRenderingBehaviour (AreaTargetCaptureBehaviour areaTargetCaptureBehaviour, Material displayMaterial, bool hasCollision)
	Create a Runtime Mesh Rendering Behaviour for the Area Target Capture Behaviour. More...
GameObject	CreateRuntimeMeshRenderingBehaviour< T > (T areaTargetBehaviour, Material displayMaterial, bool hasCollision)
	Create a Runtime Mesh Rendering Behaviour for the Area Target. More...
VuMarkBehaviour	CreateVuMarkBehaviour (string databasePath, string targetName)
	Creates a VuMark Behaviour from a target stored in a Vuforia database. More...
async Task< VuMarkBehaviour >	CreateVuMarkBehaviourAsync (string databasePath, string targetName)
	Asynchronously creates a VuMark Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target. More...

Detailed Description

Provides methods to create Vuforia tracked targets

Member Function Documentation

CreateAnchorBehaviour() [1/2]

AnchorBehaviour CreateAnchorBehaviour ( string  name, Vector3  position, Quaternion  rotation  )

inline

Creates an Anchor Behaviour in mid air using the transform of the pose (position/rotation) where it should be anchored.

Parameters

name	The logical name of the anchor. This must be unique among all created anchors.
position	The position at which the anchor will be created.
rotation	The rotation of the anchor that will be created.

Returns

The Anchor Behaviour at the specified position and rotation.

CreateAnchorBehaviour() [2/2]

AnchorBehaviour CreateAnchorBehaviour ( string  name, HitTestResult  hitTestResult  )

inline

Creates an Anchor Behaviour on a plane using the location (position/rotation) of a HitTestResult from a previous World.HitTest().

Parameters

name	The logical name of the anchor. This must be unique among all created anchors.
hitTestResult	The HitTestResult containing the pose at which the anchor will be created on a plane.

Returns

The Anchor Behaviour on the plane at the location of the hit test.

CreateAreaTarget() [1/2]

AreaTargetBehaviour CreateAreaTarget ( string  databasePath, string  targetName, bool  requiresExternalPositions = false  )

inline

Creates an Area Target Behaviour from a target stored in a Vuforia database.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.
requiresExternalPositions	Optional parameter to force the dataset to require an external position. Useful to optimize large dataset loading behavior

Returns

The Area Target Behaviour created from the specified target.

CreateAreaTarget() [2/2]

AreaTargetBehaviour CreateAreaTarget ( string  databasePath, string  targetName, bool  hasOcclusion, bool  hasCollision, string  occlusionModelPath = null, bool  requiresExternalPositions = false  )

inline

Creates an Area Target Behaviour from a target stored in a Vuforia database.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.
hasOcclusion	Sets if target will have a runtime occlusion.
hasCollision	Sets if target will have a runtime collision.
occlusionModelPath	Absolute path to the '*_occlusion.dt' file. If not set, it will be searched next to the dataset file.
requiresExternalPositions	Optional parameter to force the dataset to require an external position. Useful to optimize large dataset loading behavior

Returns

The Area Target Behaviour created from the specified target.

CreateAreaTargetAsync() [1/2]

async Task<AreaTargetBehaviour> CreateAreaTargetAsync ( string  databasePath, string  targetName, bool  requiresExternalPositions = false  )

inline

Asynchronously creates an Area Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.
requiresExternalPositions	Optional parameter to force the dataset to require an external position. Useful to optimize large dataset loading behavior

Returns

The Area Target Behaviour created from the specified target.

CreateAreaTargetAsync() [2/2]

async Task<AreaTargetBehaviour> CreateAreaTargetAsync ( string  databasePath, string  targetName, bool  hasOcclusion, bool  hasCollision, string  occlusionModelPath = null, bool  requiresExternalPositions = false  )

inline

Asynchronously creates an Area Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.
hasOcclusion	Sets if target will have a runtime occlusion.
hasCollision	Sets if target will have a runtime collision.
occlusionModelPath	Absolute path to the '*_occlusion.dt' file. If not set, it will be searched next to the dataset file.
requiresExternalPositions	Optional parameter to force the dataset to require an external position. Useful to optimize large dataset loading behavior

Returns

The Area Target Behaviour created from the specified target.

CreateBarcodeBehaviour()

BarcodeBehaviour CreateBarcodeBehaviour ( HashSet< BarcodeBehaviour.BarcodeType >  observedTypes, bool  detectMultipleBarcodes  )

inline

Creates a Barcode Behaviour

Parameters

observedTypes	The set of observable Barcode Types.
detectMultipleBarcodes	Flag to indicate whether the BarcodeBehaviour should detect multiple Barcodes in parallel.

Returns

The created Barcode Behaviour

CreateBehavioursFromDatabase()

IEnumerable<ObserverBehaviour> CreateBehavioursFromDatabase ( string  databasePath )

inline

Creates Behaviours from all observers in a database.

Parameters

databasePath

The path to the XML file of the database for which to load observer Behaviours. Must be either an absolute path or relative to "StreamingAssets".

Returns

A list of Behaviours extracted from the targets in the database.

CreateCloudRecoBehaviour()

CloudRecoBehaviour CreateCloudRecoBehaviour ( string  accessKey, string  secretKey  )

inline

Creates a Cloud Recognition using auth keys. Then initializes the reco.

Returns

The CloudReco Behaviour from the provided auth keys.

CreateCylinderTarget()

CylinderTargetBehaviour CreateCylinderTarget ( string  databasePath, string  targetName  )

inline

Creates a Cylinder Target Behaviour from a target stored in a Vuforia database.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.

Returns

The Cylinder Target Behaviour created from the specified target.

CreateCylinderTargetAsync()

async Task<CylinderTargetBehaviour> CreateCylinderTargetAsync ( string  databasePath, string  targetName  )

inline

Asynchronously creates a Cylinder Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.

Returns

The Cylinder Target Behaviour created from the specified target.

CreateImageTarget() [1/4]

ImageTargetBehaviour CreateImageTarget ( string  databasePath, string  targetName  )

inline

Creates an Image Target Behaviour from a target stored in a Vuforia database.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.

Returns

The Image Target Behaviour created from the specified target.

CreateImageTarget() [2/4]

ImageTargetBehaviour CreateImageTarget ( string  filePath, float  widthInMeters, string  targetName  )

inline

Creates an Image Target from a path to a Unity Texture file.

Parameters

filePath	The file path of the image to be used as target. Must be either an absolute path or relative to "StreamingAssets".
widthInMeters	The real world width of the target in meters.
targetName	The name of the resulting target.

Returns

The Image Target Behaviour from the specified file.

CreateImageTarget() [3/4]

ImageTargetBehaviour CreateImageTarget ( Texture2D  texture, float  widthInMeters, string  targetName  )

inline

Creates an Image Target from a Unity Texture2D.

Parameters

texture	The texture from which the new Image Target is created.
widthInMeters	The real world width of the target in meters.
targetName	The name of the resulting target.

Returns

The Image Target Behaviour from the specified Unity Texture2D.

CreateImageTarget() [4/4]

ImageTargetBehaviour CreateImageTarget ( IntPtr  texturePointer, int  textureWidth, int  textureHeight, TextureFormat  format, float  widthInMeters, string  targetName  )

inline

Create an Image Target using raw image data loaded by functions independent from Vuforia Engine.

Currently only unpadded image sources are correctly supported.

Parameters

texturePointer	Pointer to the memory location of the image buffer.
textureWidth	The width of the image in pixels.
textureHeight	The height of the image in pixels.
format	The texture format of the image.
widthInMeters	The real world width of the target in meters.
targetName	The name of the resulting target.

Returns

The Image Target Behaviour from the specified image buffer.

CreateImageTargetAsync() [1/4]

async Task<ImageTargetBehaviour> CreateImageTargetAsync ( string  databasePath, string  targetName  )

inline

Asynchronously creates an Image Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.

Returns

The Image Target Behaviour created from the specified target.

CreateImageTargetAsync() [2/4]

async Task<ImageTargetBehaviour> CreateImageTargetAsync ( string  filePath, float  widthInMeters, string  targetName  )

inline

Asynchronously creates an Image Target from a path to a Unity Texture file. Use this method to prevent blocking the main thread while loading the target.

Parameters

filePath	The file path of the image to be used as target. Must be either an absolute path or relative to "StreamingAssets".
widthInMeters	The real world width of the target in meters.
targetName	The name of the resulting target.

Returns

The Image Target Behaviour from the specified file.

CreateImageTargetAsync() [3/4]

async Task<ImageTargetBehaviour> CreateImageTargetAsync ( Texture2D  texture, float  widthInMeters, string  targetName  )

inline

Asynchronously creates an Image Target from a Unity Texture2D. Use this method to prevent blocking the main thread while loading the target.

Parameters

texture	The texture from which the new Image Target is created.
widthInMeters	The real world width of the target in meters.
targetName	The name of the resulting target.

Returns

The Image Target Behaviour from the specified Unity Texture2D.

CreateImageTargetAsync() [4/4]

async Task<ImageTargetBehaviour> CreateImageTargetAsync ( IntPtr  texturePointer, int  textureWidth, int  textureHeight, TextureFormat  format, float  widthInMeters, string  targetName  )

inline

Asynchronously create an Image Target using raw image data loaded by functions independent from Vuforia Engine. Use this method to prevent blocking the main thread while loading the target.

Currently only unpadded image sources are correctly supported.

Parameters

texturePointer	Pointer to the memory location of the image buffer.
textureWidth	The width of the image in pixels.
textureHeight	The height of the image in pixels.
format	The texture format of the image.
widthInMeters	The real world width of the target in meters.
targetName	The name of the resulting target.

Returns

The Image Target Behaviour from the specified image buffer.

CreateModelTarget() [1/2]

ModelTargetBehaviour CreateModelTarget ( string  databasePath, string  targetName, TrackingOptimization?  trackingOptimization = null  )

inline

Creates a Model Target Behaviour from a target stored in a Vuforia database.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.
trackingOptimization	Optionally specify the tracking optimization for the target.

Returns

The Model Target Behaviour created from the specified target.

CreateModelTarget() [2/2]

ModelTargetBehaviour CreateModelTarget ( string  databasePath, string  targetName, bool  hasOcclusion, bool  hasCollision, TrackingOptimization?  trackingOptimization = null  )

inline

Creates a Model Target Behaviour from a target stored in a Vuforia database.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.
hasOcclusion	Sets if target will have a runtime occlusion.
hasCollision	Sets if target will have a runtime collision.
trackingOptimization	Optionally specify the tracking optimization for the target.

Returns

The Model Target Behaviour created from the specified target.

CreateModelTargetAsync() [1/2]

Task<ModelTargetBehaviour> CreateModelTargetAsync ( string  databasePath, string  targetName, TrackingOptimization?  trackingOptimization = null  )

inline

Asynchronously creates a Model Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.
trackingOptimization	Optionally specify the tracking optimization for the target.

Returns

The Model Target Behaviour created from the specified target.

CreateModelTargetAsync() [2/2]

async Task<ModelTargetBehaviour> CreateModelTargetAsync ( string  databasePath, string  targetName, bool  hasOcclusion, bool  hasCollision, TrackingOptimization?  trackingOptimization = null  )

inline

Asynchronously creates a Model Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.
hasOcclusion	Sets if target will have a runtime occlusion.
hasCollision	Sets if target will have a runtime collision.
trackingOptimization	Optionally specify the tracking optimization for the target.

Returns

The Model Target Behaviour created from the specified target.

CreateMultiTarget()

MultiTargetBehaviour CreateMultiTarget ( string  databasePath, string  targetName  )

inline

Creates a Multi Target Behaviour from a target stored in a Vuforia database.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.

Returns

The Multi Target Behaviour created from the specified target.

CreateMultiTargetAsync()

async Task<MultiTargetBehaviour> CreateMultiTargetAsync ( string  databasePath, string  targetName  )

inline

Asynchronously creates a Multi Target Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.

Returns

The Multi Target Behaviour created from the specified target.

CreateRuntimeMeshRenderingBehaviour() [1/2]

GameObject CreateRuntimeMeshRenderingBehaviour ( ModelTargetBehaviour  modelTargetBehaviour, Material  displayMaterial  )

inline

Create a Runtime Mesh Behaviour for the Model Target.

Parameters

modelTargetBehaviour	The Model Target whose runtime mesh should be rendered.
displayMaterial	The material used to display the runtime mesh.

CreateRuntimeMeshRenderingBehaviour() [2/2]

GameObject CreateRuntimeMeshRenderingBehaviour ( AreaTargetCaptureBehaviour  areaTargetCaptureBehaviour, Material  displayMaterial, bool  hasCollision  )

inline

Create a Runtime Mesh Rendering Behaviour for the Area Target Capture Behaviour.

Parameters

areaTargetCaptureBehaviour	The Area Target Capture whose runtime mesh should be rendered.
displayMaterial	The material used to display the runtime mesh.
hasCollision	Flag to indicate if the runtime meshes should collide with other objects

CreateRuntimeMeshRenderingBehaviour< T >()

GameObject CreateRuntimeMeshRenderingBehaviour< T > ( T  areaTargetBehaviour, Material  displayMaterial, bool  hasCollision  )

inline

Create a Runtime Mesh Rendering Behaviour for the Area Target.

Parameters

areaTargetBehaviour	The Area Target whose runtime mesh should be rendered.
displayMaterial	The material used to display the runtime mesh.
hasCollision	Flag to indicate if the runtime meshes should collide with other objects

Type Constraints

T

:

AreaTargetBehaviour

CreateVuMarkBehaviour()

VuMarkBehaviour CreateVuMarkBehaviour ( string  databasePath, string  targetName  )

inline

Creates a VuMark Behaviour from a target stored in a Vuforia database.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.

Returns

The VuMark Behaviour created from the specified target.

CreateVuMarkBehaviourAsync()

async Task<VuMarkBehaviour> CreateVuMarkBehaviourAsync ( string  databasePath, string  targetName  )

inline

Asynchronously creates a VuMark Behaviour from a target stored in a Vuforia database. Use this method to prevent blocking the main thread while loading the target.

Parameters

databasePath	The path to the XML file of the database that contains the target. Must be either an absolute path or relative to "StreamingAssets".
targetName	The name of the target in the database.

Returns

The VuMark Behaviour created from the specified target.