C++ Java Unity
C++ Reference
VuMarkTemplate Class Referenceabstract

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 NonCopyable

Public Member Functions

virtual const char * getVuMarkUserData () const =0
 Get the user data for this template from the underlying dataset. More...
 
virtual void setTrackingFromRuntimeAppearance (bool enable)=0
 Set whether tracking should use the template's background image or not. More...
 
virtual bool isTrackingFromRuntimeAppearanceEnabled () const =0
 
virtual Vec2F getOrigin () const =0
 Get the position of the origin of the VuMarkTemplate. More...
 
- Public Member Functions inherited from ObjectTarget
virtual const char * getUniqueTargetId () const =0
 Get the persistent system-wide unique id for this target. More...
 
virtual Vec3F getSize () const =0
 Get the size of this target. More...
 
virtual bool setSize (const Vec3F &size)=0
 Apply a uniform scale to this target that makes it the given size. More...
 
virtual bool setMotionHint (MOTION_HINT hint)=0
 Set the motion hint to indicate how the target moves in space. More...
 
virtual MOTION_HINT getMotionHint () const =0
 Get the motion hint of this target. More...
 
- Public Member Functions inherited from Trackable
virtual Type getType () const =0
 Get the Type for this instance (typically a subclass of Trackable). More...
 
virtual bool isOfType (Type type) const =0
 Check whether this instance is of the given Type or any of its subclasses. More...
 
virtual int getId () const =0
 Get a unique id for this Trackable. More...
 
virtual const char * getName () const =0
 Get the name of this Trackable's name. More...
 
virtual bool setUserData (void *userData)=0
 Set user data for this Trackable. More...
 
virtual void * getUserData () const =0
 Get the user data that was previously set using setUserData(). More...
 
virtual ~Trackable ()
 

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...
 

Additional Inherited Members

- Public Types inherited from ObjectTarget
enum  MOTION_HINT {
  STATIC,
  ADAPTIVE
}
 Target property that indicates how the target moves in space. More...
 

Member Function Documentation

static Type getClassType ( )
static

Get the Type for class 'VuMarkTemplate'.

virtual const char* getVuMarkUserData ( ) const
pure virtual

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.
virtual void setTrackingFromRuntimeAppearance ( bool  enable)
pure virtual

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.
virtual bool isTrackingFromRuntimeAppearanceEnabled ( ) const
pure virtual

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.
virtual Vec2F getOrigin ( ) const
pure virtual

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.