C++ Java Unity
Java Reference
State Class Reference
Inheritance diagram for State:

Public Member Functions

State clone ()
 Returns a shallow copy of this State object that is valid beyond the context of the original object. More...
 
boolean equals (Object obj)
 
 State ()
 Default constructor. More...
 
 State (State other)
 Copy constructor. More...
 
Frame getFrame ()
 Get the Frame associated with this State. More...
 
CameraCalibration getCameraCalibration ()
 Get the camera calibration for this State, if available. More...
 
Illumination getIllumination ()
 Get illumination information for this State (if available). More...
 
DeviceTrackableResult getDeviceTrackableResult ()
 Get the DeviceTrackableResult, if it exists. More...
 
TrackableResultList getTrackableResults ()
 Provides access to the list of TrackableResults in the State referring to Trackable objects currently being tracked. More...
 

Constructor & Destructor Documentation

State ( )

Default constructor.

State ( State  other)

Copy constructor.

A State is a lightweight object which keeps internal smart pointers to its data.

Copying is therefore cheap, and recommended over using references.

Member Function Documentation

State clone ( )

Returns a shallow copy of this State object that is valid beyond the context of the original object.

This new state object and it's Frame resource will remain until it all references are removed and the object is Garbage Collected. The Frame object owned by the original State object will be reclaimed at the end of it's life cycle. To continue to reference the cloned State's Frame object, obtain a new reference from getFrame().

boolean equals ( Object  obj)
Frame getFrame ( )

Get the Frame associated with this State.

Returns
A Frame object representing the camera frame that any camera-based Trackable instances used to generate the TrackableResults accessible via getTrackableResult().

Note: For non-camera-based TrackableResult instances, the timestamp of this Frame may not match the timestamp of the TrackableResult. See StateUpdater for more details.

CameraCalibration getCameraCalibration ( )

Get the camera calibration for this State, if available.

Returns
Camara calibration information for this State, or NULL if no camera calibration was available when this State was captured.

The returned object is only valid as long as the State object is valid. Do not keep a copy of the pointer!

Illumination getIllumination ( )

Get illumination information for this State (if available).

Returns
An Illumination instance containing illumination information for this State, or NULL if no illumination information is available.

The returned object is only valid as long as the State object is valid. Do not keep a copy of the pointer!

DeviceTrackableResult getDeviceTrackableResult ( )

Get the DeviceTrackableResult, if it exists.

This is a convenience method that provides easy access to the DeviceTrackableResult, if a DeviceTracker has been started.

Note: The DeviceTrackableResult is also available via getTrackableResult().

Note: The returned object is only valid as long as the State object is valid. Do not keep a copy of the pointer!

Returns
the DeviceTrackableResult, or NULL if no DeviceTracker is running.
TrackableResultList getTrackableResults ( )

Provides access to the list of TrackableResults in the State referring to Trackable objects currently being tracked.

The returned list is only valid as long as the State object is valid. Do not keep a copy of the list or the TrackableResults list elements point to!