C++ Java Unity
Java Reference
VuMarkTemplate Class Reference

Detailed Description

A type of ObjectTarget representing a set of VuMarks.

Individual VuMarks are represented by VuMarkTarget objects, which are instantiated based on a VuMarkTemplate.

Inheritance diagram for VuMarkTemplate:
ObjectTarget Trackable

Public Member Functions

boolean equals (Object obj)
 
String getVuMarkUserData ()
 Get the user data for this template from the underlying dataset. More...
 
void setTrackingFromRuntimeAppearance (boolean enable)
 Set whether tracking should use the template's background image or not. More...
 
boolean isTrackingFromRuntimeAppearanceEnabled ()
 Get whether tracking a VuMark based on this template is aided by a camera-captured image or by the background/design in the template. More...
 
Vec2F getOrigin ()
 Get the position of the origin of the VuMarkTemplate. More...
 
- Public Member Functions inherited from ObjectTarget
boolean equals (Object obj)
 
String getUniqueTargetId ()
 Get the persistent system-wide unique id for this target. More...
 
Vec3F getSize ()
 Get the size of this target. More...
 
boolean setSize (Vec3F size)
 Apply a uniform scale to this target that makes it the given size. More...
 
boolean setMotionHint (int hint)
 Set the motion hint to indicate how the target moves in space. More...
 
int getMotionHint ()
 Get the motion hint of this target. More...
 
- Public Member Functions inherited from Trackable
Object getUserData ()
 
boolean setUserData (Object userData)
 
boolean equals (Object obj)
 
Type getType ()
 Get the Type for this instance (typically a subclass of Trackable). More...
 
boolean isOfType (Type type)
 Check whether this instance is of the given Type or any of its subclasses. More...
 
int getId ()
 Get a unique id for this Trackable. More...
 
String getName ()
 Get the name of this Trackable's name. More...
 

Static Public Member Functions

static Type getClassType ()
 Get the Type for class 'VuMarkTemplate'. More...
 
- Static Public Member Functions inherited from ObjectTarget
static Type getClassType ()
 Get the Type for class "ObjectTarget". More...
 
- Static Public Member Functions inherited from Trackable
static Type getClassType ()
 Get the Type of class 'Trackable'. More...
 

Member Function Documentation

boolean equals ( Object  obj)
static Type getClassType ( )
static

Get the Type for class 'VuMarkTemplate'.

String getVuMarkUserData ( )

Get the user data for this template from the underlying dataset.

The user data is always in text form.

Returns
The user data associated with this VuMarkTemplate, or null if no such user data exists.
void setTrackingFromRuntimeAppearance ( boolean  enable)

Set whether tracking should use the template's background image or not.

A VuMark consists of a mandatory graphic representing a numeric code, and an optional background image. Generally, the background image/design will remain fixed for a set of VuMarks based off the same template, and Vuforia may use details in the background/design to aid with tracking the VuMark.

However, it is possible to use a different background image for each real-world VuMark instance, without having to use a different template. In this case Vuforia will take a sample image from the camera when it detects the VuMark, and will use that to aid tracking, in place of the template background/design.

Note: By default, a VuMark is not tracked using its real-world appearance.

Parameters
enableIf true, use the real-world appearance of the VuMark's background (sampled from a camera frame) to aid with tracking. If false (the default), assume the VuMark is printed using the same background/design as in the template.
boolean isTrackingFromRuntimeAppearanceEnabled ( )

Get whether tracking a VuMark based on this template is aided by a camera-captured image or by the background/design in the template.

Returns
true if the real-world appearance of the VuMark's background (sampled from a camera frame) is being used to aid with tracking, or false if Vuforia assumes the VuMark is printed using the same background/design as in the template.
Vec2F getOrigin ( )

Get the position of the origin of the VuMarkTemplate.

Returns
The position of the origin of the VuMarkTemplate, expressed in this ObjectTarget's local coordinate system and scaled based on the VuMark's size.