Packagecom.transmote.flar.tracker
Classpublic class FlareManager
InheritanceFlareManager Inheritance flash.events.EventDispatcher
Implements IFLARTrackerManager
Subclasses FlareNFTManager

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



Public Properties
 PropertyDefined By
  id : String
[read-only] The string id of this tracker manager.
FlareManager
  logLevel : int
Set log level for FlareTracker / FlareNFT.
FlareManager
  threshold : Number
Flare handles thresholding natively; methods here for IFLARTrackerManager compliance only.
FlareManager
  thresholdAdapter : IThresholdAdapter
Flare handles thresholding natively; methods here for IFLARTrackerManager compliance only.
FlareManager
  thresholdSourceBitmap : Bitmap
[read-only] Flare handles thresholding natively; methods here for IFLARTrackerManager compliance only.
FlareManager
  thresholdSourceDisplay : Boolean
Flare handles thresholding natively; methods here for IFLARTrackerManager compliance only.
FlareManager
  trackerSource : IFLARSource
Reference to IFLARSource instance from which the tracker gets the BitmapData object to analyze for object tracking.
FlareManager
Protected Properties
 PropertyDefined By
  cameraParamsFile : String
FlareManager
  flarSource : IFLARSource
FlareManager
  markerDetector : IFlareTracker
FlareManager
  resourcesPath : String
FlareManager
Public Methods
 MethodDefined By
  
Constructor.
FlareManager
  
addMarkerDetector(markerType:int, param1:Number, param2:Number):Boolean
add a marker detector to flareracker.
FlareManager
  
Instruct the tracker to detect objects (e.g.
FlareManager
  
dispose():void
Halts all processes and frees the tracker for garbage collection.
FlareManager
  
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.
FlareManager
  
initTracker(stage:Stage = null):void
Initialize the tracker.
FlareManager
  
Load configuration data for the tracker, including camera parameters.
FlareManager
  
Flare handles thresholding natively, and therefore no source adjustments are required; methods here for IFLARTrackerManager compliance only.
FlareManager
Protected Methods
 MethodDefined By
  
parseMarkers(numMarkers:uint):Vector.<FLARMarker>
FlareManager
Property Detail
cameraParamsFileproperty
protected var cameraParamsFile:String

flarSourceproperty 
protected var flarSource:IFLARSource

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
logLevelproperty 
logLevel:int

Set log level for FlareTracker / FlareNFT. Set to 0 to disable. Defaults to 1; disabling is not recommended as it may suppress important error messages.


Implementation
    public function get logLevel():int
    public function set logLevel(value:int):void
markerDetectorproperty 
protected var markerDetector:IFlareTracker

resourcesPathproperty 
protected var resourcesPath:String

thresholdproperty 
threshold:Number

Flare handles thresholding natively; methods here for IFLARTrackerManager compliance only.


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

Flare handles thresholding natively; methods here for IFLARTrackerManager compliance only.


Implementation
    public function get thresholdAdapter():IThresholdAdapter
    public function set thresholdAdapter(value:IThresholdAdapter):void
thresholdSourceBitmapproperty 
thresholdSourceBitmap:Bitmap  [read-only]

Flare handles thresholding natively; methods here for IFLARTrackerManager compliance only.


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

Flare handles thresholding natively; methods here for IFLARTrackerManager compliance only.


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
FlareManager()Constructor
public function FlareManager()

Constructor.

Method Detail
addMarkerDetector()method
public function addMarkerDetector(markerType:int, param1:Number, param2:Number):Boolean

add a marker detector to flareracker. flareracker supports markers of multiple types. FlareManager defaults to SIMPLE_ID type markers.

Parameters

markerType:int — marker type id, enumerated in FlareTracker.
 
param1:Number (default = NaN) — optional additional parameter;
 
param2:Number (default = NaN) — optional additional parameter;

Returns
Boolean — true if marker detector successfully added.

See also

for more information.
for more information.
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.

parseMarkers()method 
protected function parseMarkers(numMarkers:uint):Vector.<FLARMarker>

Parameters

numMarkers:uint

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

Flare handles thresholding natively, and therefore no source adjustments are required; methods here for IFLARTrackerManager compliance only.