C++ Java Unity
Java Reference
ImageTarget Class Reference

Detailed Description

A type of ObjectTarget that represents a 2D image or a planar object.

Note: It is not possible to modify an ImageTarget while its DataSet is active. See the DataSet class for more information.

Inheritance diagram for ImageTarget:
ObjectTarget Trackable

Public Member Functions

boolean equals (Object obj)
 
VirtualButtonList getVirtualButtons ()
 Provides write access to the list of virtual buttons defined for this ImageTarget. More...
 
VirtualButton getVirtualButton (String name)
 Get (by name) one of the VirtualButton objects associated with this ImageTarget. More...
 
VirtualButton createVirtualButton (String name, Area area)
 Create a new virtual button and add it to this ImageTarget. More...
 
boolean destroyVirtualButton (VirtualButton button)
 Destroy one of this ImageTarget's virtual buttons. More...
 
String getMetaData ()
 Get the meta data string for this ImageTarget. 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 "ImageTarget". 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 "ImageTarget".

VirtualButtonList getVirtualButtons ( )

Provides write access to the list of virtual buttons defined for this ImageTarget.

VirtualButton getVirtualButton ( String  name)

Get (by name) one of the VirtualButton objects associated with this ImageTarget.

Parameters
nameThe name of the VirtualButton to get.
Returns
The requested VirtualButton, or NULL if this ImageTarget does not define a button with the requested name.
VirtualButton createVirtualButton ( String  name,
Area  area 
)

Create a new virtual button and add it to this ImageTarget.

Parameters
nameThe name for the new VirtualButton.
areaAn Area instance (e.g. a Rectangle) describing the extents of the button, in this target's local coordinate system.
Returns
The new VirtualButton, or NULL if the DataSet for this ImageTarget is currently active.
boolean destroyVirtualButton ( VirtualButton  button)

Destroy one of this ImageTarget's virtual buttons.

Parameters
buttonThe virtual button to destroy.
Returns
true on success, or false on failure or if the DataSet for this ImageTarget is currently active.
String getMetaData ( )

Get the meta data string for this ImageTarget.

A meta data string can be assigned to Cloud Recognition targets as part of the web interface or API. This method retrieves this string.

Returns
The meta data string associated with this ImageTarget (as set via the Cloud Recognition API).