Packagecom.transmote.flar.marker
Classpublic class FLARToolkitMarker
InheritanceFLARToolkitMarker Inheritance FLARMarker Inheritance Object

Container for information about a marker detected by FLARToolkit, including:

See also

com.transmote.flar.marker.FLARMarkerEvent


Public Properties
 PropertyDefined By
 Inheritedcenterpoint : Point
[read-only] The centerpoint of the marker outline in the 2D space of the screen, calculated as the average of the outline's four corner points.
FLARMarker
 Inherited_centerpoint2D : Point = null
FLARMarker
 Inherited_centerpoint3D : Point = null
FLARMarker
 Inheritedcenterpoint3D : Point
[read-only] Centerpoint of marker outline extracted from the tracker transformation matrix.
FLARMarker
  _confidence : Number
FLARToolkitMarker
  confidence : Number
[read-only] 'Confidence' is a value assigned by FLARToolkit to each detected marker, that describes the algorithm's perceived accuracy of the pattern match.
FLARToolkitMarker
 Inheritedcorners : Vector.<Point>
[read-only] A Vector of four Points that describe the four points of the detected marker's outline.
FLARMarker
  _direction : int
FLARToolkitMarker
  direction : int
[read-only] The closest orthographic orientation of detected marker.
FLARToolkitMarker
  _flarPattern : FLARPattern
FLARToolkitMarker
 Inherited_flarSource : IFLARSource
FLARMarker
  _flarSquare : NyARSquare
FLARToolkitMarker
  flarSquare : NyARSquare
[read-only] The NyARSquare instance used to create this FLARMarker instance.
FLARToolkitMarker
 Inheritedmatrix2D : Matrix
[read-only] Return the transformation matrix of this FLARMarker as a Flash Matrix object, for applying 2D transformations to Flash DisplayObject instances.
FLARMarker
 Inheritedmatrix3D : Matrix3D
[read-only] Return this.transformMatrix, adjusted for application directly to a DisplayObject (by setting displayObject.transform.matrix3D = flarMarker.matrix3D).
FLARMarker
 InheritedmotionDirection2D : Number
[read-only] The direction (in degrees) of the marker's (x,y) motion between the previous and current frames.
FLARMarker
 InheritedmotionSpeed2D : Number
[read-only] The length of the marker's (x,y) motion vector between the previous and current frames.
FLARMarker
 Inherited_patternId : int
FLARMarker
 InheritedpatternId : int
[read-only] ID of this FLARMarker's pattern.
FLARMarker
 Inheritedposition : Vector3D
[read-only] A Vector3D instance that describes x, y, and z coordinates, as well as rotationZ (stored as position.w).
FLARMarker
 InheritedrotationSpeedX : Number
[read-only] The amount of change (in degrees) in the marker's rotation along the x-axis between the previous and current frames.
FLARMarker
 InheritedrotationSpeedY : Number
[read-only] The amount of change (in degrees) in the marker's rotation along the y-axis between the previous and current frames.
FLARMarker
 InheritedrotationSpeedZ : Number
[read-only] The amount of change (in degrees) in the marker's rotation along the z-axis between the previous and current frames.
FLARMarker
 InheritedrotationX : Number
[read-only] The rotation of the marker along X axis.
FLARMarker
 InheritedrotationY : Number
[read-only] The rotation of the marker along Y axis.
FLARMarker
 InheritedrotationZ : Number
[read-only] The rotation of the marker along Z axis.
FLARMarker
 Inheritedscale2D : Number
[read-only] The scale of the marker for use in 2D applications.
FLARMarker
 Inherited_sessionId : int = -1
FLARMarker
 InheritedsessionId : uint
[read-only] ID unique to this FLARMarker in this session.
FLARMarker
 InheritedtargetCenterpoint3D : Point
[read-only] The centerpoint at the location toward which this FLARMarker is moving (target location at end of smoothing animation).
FLARMarker
 InheritedtargetPosition : Vector3D
[read-only] The position toward which this FLARMarker is moving (target position at end of smoothing animation).
FLARMarker
 Inherited_transformMatrix : Matrix3D
FLARMarker
 InheritedtransformMatrix : Matrix3D
[read-only] A Matrix3D object that describes the orientation of the detected marker relative to the viewer.
FLARMarker
 Inherited_vector3D : Vector3D = null
FLARMarker
 Inheritedvelocity : Vector3D
[read-only] A Vector3D instance that describes change between the previous and current frames in x, y, and z coordinates, as well as change in rotationZ (stored as velocity.w).
FLARMarker
 Inheritedx : Number
[read-only] The 2D X coordinate of the marker.
FLARMarker
 Inheritedy : Number
[read-only] The 2D Y coordinate of the marker.
FLARMarker
 Inheritedz : Number
[read-only] The Z coordinate of the marker.
FLARMarker
Protected Properties
 PropertyDefined By
 Inherited_corners : Vector.<Point>
FLARMarker
Public Methods
 MethodDefined By
  
FLARToolkitMarker(transformMatrix:Matrix3D, flarSource:IFLARSource, flarPattern:FLARPattern, patternId:int, direction:int, square:NyARSquare, confidence:Number)
Constructor.
FLARToolkitMarker
  
copy(otherMarker:FLARMarker):void
[override] Copy the properties of a FLARMarker into this FLARMarker.
FLARToolkitMarker
  
dispose():void
[override] Free this FLARMarker instance for garbage collection.
FLARToolkitMarker
 Inherited
toString():String
FLARMarker
Protected Methods
 MethodDefined By
  
mirror():void
[override]
FLARToolkitMarker
  
[override]
FLARToolkitMarker
Public Constants
 ConstantDefined By
 InheritedDEFAULT_UNSCALED_MARKER_WIDTH : Number = 80
[static]
FLARMarker
Property Detail
_confidenceproperty
public var _confidence:Number

_directionproperty 
public var _direction:int

_flarPatternproperty 
public var _flarPattern:FLARPattern

_flarSquareproperty 
public var _flarSquare:NyARSquare

confidenceproperty 
confidence:Number  [read-only]

'Confidence' is a value assigned by FLARToolkit to each detected marker, that describes the algorithm's perceived accuracy of the pattern match.


Implementation
    public function get confidence():Number
directionproperty 
direction:int  [read-only]

The closest orthographic orientation of detected marker. value between 0 and 3, inclusive: 0: up 1: left 2: down 3: right


Implementation
    public function get direction():int
flarSquareproperty 
flarSquare:NyARSquare  [read-only]

The NyARSquare instance used to create this FLARMarker instance. Can be accessed if direct access to FLARToolkit output is desired; no downsampling correction is applied.


Implementation
    public function get flarSquare():NyARSquare
Constructor Detail
FLARToolkitMarker()Constructor
public function FLARToolkitMarker(transformMatrix:Matrix3D, flarSource:IFLARSource, flarPattern:FLARPattern, patternId:int, direction:int, square:NyARSquare, confidence:Number)

Constructor.

Parameters
transformMatrix:Matrix3D — A Matrix3D object that describes the orientation of the detected marker relative to the viewer. Apply this Matrix3D to a 3D model to make it appear tethered to the marker.
 
flarSource:IFLARSource — The IFLARSource from which the marker's image was extracted by the current tracker.
 
flarPattern:FLARPattern — The FLARPattern that represents the detected marker's pattern.
 
patternId:int — ID of the pattern of the detected marker.
 
direction:int — The closest orthographic orientation of detected marker (up/down/left/right).
 
square:NyARSquare — The NyARSquare instance used to create this FLARMarker instance.
 
confidence:Number — The value assigned by FLARToolkit to each detected marker.
Method Detail
copy()method
override public function copy(otherMarker:FLARMarker):void

Copy the properties of a FLARMarker into this FLARMarker. FLARMarkers are updated across frames by copying the properties of newly-detected markers.

Parameters

otherMarker:FLARMarker

dispose()method 
override public function dispose():void

Free this FLARMarker instance for garbage collection.

mirror()method 
override protected function mirror():void

resetAllCalculations()method 
override protected function resetAllCalculations():void