Packagecom.transmote.flar.pattern
Classpublic class FLARPattern
InheritanceFLARPattern Inheritance Object

Wrapper for all information needed by FLARToolkit to track an individual marker.



Public Properties
 PropertyDefined By
  _filename : String
FLARPattern
  filename : String
[read-only] The location of the marker pattern file.
FLARPattern
  _minConfidence : Number
FLARPattern
  minConfidence : Number
'Confidence' is a value assigned by FLARToolkit to each detected marker, that describes the algorithm's perceived accuracy of the pattern match.
FLARPattern
  _patternToBorderRatioX : Number
FLARPattern
  patternToBorderRatioX : Number
[read-only] Out of the entire width of a marker, the amount that the pattern occupies relative to the amount the border occupies.
FLARPattern
  _patternToBorderRatioY : Number
FLARPattern
  patternToBorderRatioY : Number
[read-only] Out of the entire height of a marker, the amount that the pattern occupies relative to the amount the border occupies.
FLARPattern
  _resolution : int
FLARPattern
  resolution : Number
[read-only] The resolution (width/height) of the marker pattern file.
FLARPattern
  _unscaledMarkerWidth : Number
FLARPattern
  unscaledMarkerWidth : Number
[read-only] The width of a marker (in pixels) on-screen at which the scale of its transformation matrix is 1.0.
FLARPattern
Public Methods
 MethodDefined By
  
FLARPattern(filename:String, resolution:int, patternToBorderRatioX:Number, patternToBorderRatioY:Number, unscaledMarkerWidth:Number, minConfidence:Number)
constructor.
FLARPattern
Public Constants
 ConstantDefined By
  DEFAULT_MIN_CONFIDENCE : Number = 0.5
[static]
FLARPattern
  DEFAULT_PATTERN_TO_BORDER_RATIO : Number = 50
[static]
FLARPattern
  DEFAULT_UNSCALED_MARKER_WIDTH : Number = 80
[static]
FLARPattern
Property Detail
_filenameproperty
public var _filename:String

_minConfidenceproperty 
public var _minConfidence:Number

_patternToBorderRatioXproperty 
public var _patternToBorderRatioX:Number

_patternToBorderRatioYproperty 
public var _patternToBorderRatioY:Number

_resolutionproperty 
public var _resolution:int

_unscaledMarkerWidthproperty 
public var _unscaledMarkerWidth:Number

filenameproperty 
filename:String  [read-only]

The location of the marker pattern file.


Implementation
    public function get filename():String
minConfidenceproperty 
minConfidence:Number

'Confidence' is a value assigned by FLARToolkit to each detected marker, that describes the algorithm's perceived accuracy of the pattern match. This value sets the minimum confidence required to signal a recognized marker.


Implementation
    public function get minConfidence():Number
    public function set minConfidence(value:Number):void
patternToBorderRatioXproperty 
patternToBorderRatioX:Number  [read-only]

Out of the entire width of a marker, the amount that the pattern occupies relative to the amount the border occupies. This value is expressed as a percentage. For example, a value of 50 indicates that the width of the pattern area is equal to the total width (on either side of the pattern) of the border. Note that the border must still be a square (equal width and height).


Implementation
    public function get patternToBorderRatioX():Number
patternToBorderRatioYproperty 
patternToBorderRatioY:Number  [read-only]

Out of the entire height of a marker, the amount that the pattern occupies relative to the amount the border occupies. This value is expressed as a percentage. For example, a value of 50 indicates that the width of the pattern area is equal to the total width (on either side of the pattern) of the border. Note that the border must still be a square (equal width and height).


Implementation
    public function get patternToBorderRatioY():Number
resolutionproperty 
resolution:Number  [read-only]

The resolution (width/height) of the marker pattern file.


Implementation
    public function get resolution():Number
unscaledMarkerWidthproperty 
unscaledMarkerWidth:Number  [read-only]

The width of a marker (in pixels) on-screen at which the scale of its transformation matrix is 1.0.


Implementation
    public function get unscaledMarkerWidth():Number
Constructor Detail
FLARPattern()Constructor
public function FLARPattern(filename:String, resolution:int, patternToBorderRatioX:Number, patternToBorderRatioY:Number, unscaledMarkerWidth:Number, minConfidence:Number)

constructor.

Parameters
filename:String — The location of the marker pattern file.
 
resolution:int — The resolution (width/height) of the marker pattern file.
 
patternToBorderRatioX:Number (default = NaN) — Out of the entire width of a marker, the amount that the pattern occupies relative to the amount the border occupies. This value is expressed as a percentage. For example, a value of 50 indicates that the width of the pattern area is equal to the total width (on either side of the pattern) of the border. Note that the border must still be a square (equal width and height). Defaults to 50.
 
patternToBorderRatioY:Number (default = NaN) — Out of the entire height of a marker, the amount that the pattern occupies relative to the amount the border occupies. This value is expressed as a percentage. For example, a value of 50 indicates that the width of the pattern area is equal to the total width (on either side of the pattern) of the border. Note that the border must still be a square (equal width and height). Defaults to 50.
 
unscaledMarkerWidth:Number (default = NaN) — The width of a marker (in pixels) on-screen at which the scale of its transformation matrix is 1.0. Defaults to 80.
 
minConfidence:Number (default = NaN) — 'Confidence' is a value assigned by FLARToolkit to each detected marker, that describes the algorithm's perceived accuracy of the pattern match. This value sets the minimum confidence required to signal a recognized marker. Defaults to 0.5.
Constant Detail
DEFAULT_MIN_CONFIDENCEConstant
public static const DEFAULT_MIN_CONFIDENCE:Number = 0.5

DEFAULT_PATTERN_TO_BORDER_RATIOConstant 
public static const DEFAULT_PATTERN_TO_BORDER_RATIO:Number = 50

DEFAULT_UNSCALED_MARKER_WIDTHConstant 
public static const DEFAULT_UNSCALED_MARKER_WIDTH:Number = 80