Packagecom.transmote.flar.tracker
Classpublic class FLARToolkitManager
InheritanceFLARToolkitManager Inheritance flash.events.EventDispatcher
Implements IFLARTrackerManager

Tracker library manager for use with FLARToolkit. Pass a FLARToolkitManager instance into the FLARManager constructor in order to use FLARManager with FLARToolkit.



Public Properties
 PropertyDefined By
  id : String
[read-only] The string id of this tracker manager.
FLARToolkitManager
  labelAreaMax : Number
Maximum size (widtheight) a dark area of the source image can be in order to become a candidate for marker outline detection.
FLARToolkitManager
  labelAreaMin : Number
Minimum size (widtheight) a dark area of the source image must be in order to become a candidate for marker outline detection.
FLARToolkitManager
  threshold : Number
Threshold applied to BitmapData before tracker analysis.
FLARToolkitManager
  thresholdAdapter : IThresholdAdapter
IFLARThresholdAdapter instance used to automate threshold changes.
FLARToolkitManager
  thresholdSourceBitmap : Bitmap
[read-only] Retrieve a Bitmap to display the source BitmapData analyzed by the tracker post-thresholding.
FLARToolkitManager
  thresholdSourceDisplay : Boolean
Set to true to display the source BitmapData used by the FLARToolkit post-thresholding.
FLARToolkitManager
  trackerSource : IFLARSource
Reference to IFLARSource instance from which the tracker gets the BitmapData object to analyze for object tracking.
FLARToolkitManager
Public Methods
 MethodDefined By
  
Constructor.
FLARToolkitManager
  
Instruct the tracker to detect objects (e.g.
FLARToolkitManager
  
dispose():void
Halts all processes and frees the tracker for garbage collection.
FLARToolkitManager
  
getProjectionMatrix(frameworkId:int, viewportSize:Rectangle):Matrix3D
Retrieve the projection matrix used by the tracker to map 3D transform matrices to the perspective view of the application.
FLARToolkitManager
  
initTracker(stage:Stage = null):void
Initialize the tracker.
FLARToolkitManager
  
Load configuration data for the tracker, including camera parameters.
FLARToolkitManager
  
Perform any adjustments, such as thresholding, to the source BitmapData before tracker analysis.
FLARToolkitManager
Property Detail
idproperty
id:String  [read-only]

The string id of this tracker manager. All tracker manager ids are enumerated in FLARManager.as.


Implementation
    public function get id():String
labelAreaMaxproperty 
labelAreaMax:Number

Maximum size (widtheight) a dark area of the source image can be in order to become a candidate for marker outline detection.

Lower values may result in faster performance, but poorer marker detection at larger on-screen sizes.

Defaults to FLARLabeling.AR_AREA_MAX, which is 100000 at the time of this writing.

Can be set in flarConfig.xml, as an attribute of the <flarToolkitSettings> element.


Implementation
    public function get labelAreaMax():Number
    public function set labelAreaMax(value:Number):void
labelAreaMinproperty 
labelAreaMin:Number

Minimum size (widtheight) a dark area of the source image must be in order to become a candidate for marker outline detection.

Higher values result in faster performance, but poorer marker detection at smaller on-screen sizes.

Defaults to FLARLabeling.AR_AREA_MIN, which is 70 at the time of this writing.

Can be set in flarConfig.xml, as an attribute of the <flarToolkitSettings> element.


Implementation
    public function get labelAreaMin():Number
    public function set labelAreaMin(value:Number):void
thresholdproperty 
threshold:Number

Threshold applied to BitmapData before tracker analysis.


Implementation
    public function get threshold():Number
    public function set threshold(value:Number):void

See also

thresholdAdapterproperty 
thresholdAdapter:IThresholdAdapter

IFLARThresholdAdapter instance used to automate threshold changes.


Implementation
    public function get thresholdAdapter():IThresholdAdapter
    public function set thresholdAdapter(value:IThresholdAdapter):void

See also

thresholdSourceBitmapproperty 
thresholdSourceBitmap:Bitmap  [read-only]

Retrieve a Bitmap to display the source BitmapData analyzed by the tracker post-thresholding. Displaying the thresholded source can be useful for debugging threshold changes.


Implementation
    public function get thresholdSourceBitmap():Bitmap
thresholdSourceDisplayproperty 
thresholdSourceDisplay:Boolean

Set to true to display the source BitmapData used by the FLARToolkit post-thresholding. Displaying the thresholded source can be useful for debugging threshold changes.


Implementation
    public function get thresholdSourceDisplay():Boolean
    public function set thresholdSourceDisplay(value:Boolean):void
trackerSourceproperty 
trackerSource:IFLARSource

Reference to IFLARSource instance from which the tracker gets the BitmapData object to analyze for object tracking.


Implementation
    public function get trackerSource():IFLARSource
    public function set trackerSource(value:IFLARSource):void
Constructor Detail
FLARToolkitManager()Constructor
public function FLARToolkitManager()

Constructor.

Method Detail
detectMarkers()method
public function detectMarkers():Vector.<FLARMarker>

Instruct the tracker to detect objects (e.g. markers, patterns, images). This method is called automatically by FLARManager; application developers should not call this method.

Returns
Vector.<FLARMarker>
dispose()method 
public function dispose():void

Halts all processes and frees the tracker for garbage collection.

getProjectionMatrix()method 
public function getProjectionMatrix(frameworkId:int, viewportSize:Rectangle):Matrix3D

Retrieve the projection matrix used by the tracker to map 3D transform matrices to the perspective view of the application. Use the returned Matrix3D instance with the application's 3D framework camera, or apply directly to a container object.

Parameters

frameworkId:int — The id of the 3D framework used by the application, as enumerated in FLARManager.
 
viewportSize:Rectangle — The size, as a Rectangle instance, of the container holding all 3D objects to be transformed by the tracker results.

Returns
Matrix3D
initTracker()method 
public function initTracker(stage:Stage = null):void

Initialize the tracker. This method is called automatically by FLARManager; application developers should not call this method.

Parameters

stage:Stage (default = null) — A reference to the application's Stage.

loadTrackerConfig()method 
public function loadTrackerConfig(configLoader:FLARManagerConfigLoader):void

Load configuration data for the tracker, including camera parameters. This method is called automatically by FLARManager; application developers should not call this method.

Parameters

configLoader:FLARManagerConfigLoader — The FLARManagerConfigLoader instance with loaded configuration data.

performSourceAdjustments()method 
public function performSourceAdjustments():void

Perform any adjustments, such as thresholding, to the source BitmapData before tracker analysis. This method is called automatically by FLARManager; application developers should not call this method.