| Package | com.transmote.flar.marker |
| Class | public class FLARMarker |
Container for information about a detected marker, including:
See also
| Property | Defined by | ||
|---|---|---|---|
| centerpoint : Point [read-only]
centerpoint of marker outline in the 2D space of the screen,
calculated as the average of the outline's four corner points.
| FLARMarker | ||
| _centerpoint2D : Point = null | FLARMarker | ||
| _centerpoint3D : Point = null | FLARMarker | ||
| centerpoint3D : Point [read-only]
centerpoint of marker outline extracted from FLARToolkit transformation matrix.
| FLARMarker | ||
| _confidence : Number | FLARMarker | ||
| 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.
| FLARMarker | ||
| corners : Vector [read-only]
| FLARMarker | ||
| _direction : int | FLARMarker | ||
| direction : int [read-only]
closest orthographic orientation of detected marker.
| FLARMarker | ||
| _flarSource : IFLARSource | FLARMarker | ||
| _flarSquare : FLARSquare | FLARMarker | ||
| flarSquare : FLARSquare [read-only]
FLARSquare instance used to create this FLARMarker instance.
| FLARMarker | ||
| _patternId : int | FLARMarker | ||
| patternId : int [read-only]
ID of this marker's pattern.
| FLARMarker | ||
| _rotationX : Number = NaN | FLARMarker | ||
| rotationX : Number [read-only]
rotation of marker along X axis.
| FLARMarker | ||
| _rotationY : Number = NaN | FLARMarker | ||
| rotationY : Number [read-only]
rotation of marker along Y axis.
| FLARMarker | ||
| _rotationZ : Number = NaN | FLARMarker | ||
| rotationZ : Number [read-only]
rotation of marker along Z axis.
| FLARMarker | ||
| _sessionId : int = -1 | FLARMarker | ||
| sessionId : uint [read-only]
ID unique to this marker in this session.
| FLARMarker | ||
| targetCenterpoint3D : Point [read-only]
returns centerpoint at location toward which this FLARMarker is moving
(target location at end of smoothing animation).
| FLARMarker | ||
| _transformMatrix : FLARDoubleMatrix34 | FLARMarker | ||
| transformMatrix : FLARDoubleMatrix34 [read-only]
FLARDoubleMatrix34 matrix that describes transformation of marker relative to the camera.
| FLARMarker | ||
| _vector3D : Vector3D = null | FLARMarker | ||
| vector3D : Vector3D [read-only]
Vector3D instance that describes x, y, and z coordinates,
as well as rotationZ (stored as vector3D.w).
| FLARMarker | ||
| Method | Defined by | ||
|---|---|---|---|
|
FLARMarker(detectorResult:FLARMultiMarkerDetectorResult, transformMatrix:FLARDoubleMatrix34, flarSource:IFLARSource)
constructor.
| FLARMarker | ||
|
applySmoothing(smoother:IFLARMatrixSmoother, numFrames:int):void
apply smoothing algorithm over a number of frames.
| FLARMarker | ||
|
copy(otherMarker:FLARMarker):void
copy the properties of a FLARMarker into this FLARMarker.
| FLARMarker | ||
|
dispose():void
free this FLARMarker instance up for garbage collection.
| FLARMarker | ||
|
incrementRemovalAge():uint
increment removal age by one.
| FLARMarker | ||
|
resetRemovalAge():void
reset removal age to zero.
| FLARMarker | ||
|
setSessionId():void
called only by FLARManager, when a new FLARMarker is detected.
| FLARMarker | ||
|
toString():String
| FLARMarker | ||
| centerpoint | property |
centerpoint:Point [read-only]centerpoint of marker outline in the 2D space of the screen, calculated as the average of the outline's four corner points. to access the centerpoint reported by FLARToolkit in three dimensions, use FLARMarker.centerpoint.
Implementation public function get centerpoint():Point
| _centerpoint2D | property |
public var _centerpoint2D:Point = null
| _centerpoint3D | property |
public var _centerpoint3D:Point = null
| centerpoint3D | property |
centerpoint3D:Point [read-only]centerpoint of marker outline extracted from FLARToolkit transformation matrix. this centerpoint is determined based on the 3D location of the detected marker, and is used by FLARManager in 3D calculations. to avoid having to correct for Z location, use centerpoint2D.
Implementation public function get centerpoint3D():Point
| _confidence | property |
public var _confidence:Number
| confidence | property |
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
| corners | property |
corners:Vector [read-only]Implementation
public function get corners():Vector
| _direction | property |
public var _direction:int
| direction | property |
direction:int [read-only]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
| _flarSource | property |
public var _flarSource:IFLARSource
| _flarSquare | property |
public var _flarSquare:FLARSquare
| flarSquare | property |
flarSquare:FLARSquare [read-only]FLARSquare 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():FLARSquare
| _patternId | property |
public var _patternId:int
| patternId | property |
patternId:int [read-only]ID of this marker's pattern. pattern IDs are zero-indexed, and are assigned to patterns in the order they were initially loaded.
Implementation public function get patternId():int
| _rotationX | property |
public var _rotationX:Number = NaN
| rotationX | property |
rotationX:Number [read-only]rotation of marker along X axis.
Implementation public function get rotationX():Number
| _rotationY | property |
public var _rotationY:Number = NaN
| rotationY | property |
rotationY:Number [read-only]rotation of marker along Y axis.
Implementation public function get rotationY():Number
| _rotationZ | property |
public var _rotationZ:Number = NaN
| rotationZ | property |
rotationZ:Number [read-only]rotation of marker along Z axis.
Implementation public function get rotationZ():Number
| _sessionId | property |
public var _sessionId:int = -1
| sessionId | property |
sessionId:uint [read-only]ID unique to this marker in this session. no two markers in a session share the same sessionId.
Implementation public function get sessionId():uint
| targetCenterpoint3D | property |
targetCenterpoint3D:Point [read-only]returns centerpoint at location toward which this FLARMarker is moving (target location at end of smoothing animation).
Implementation public function get targetCenterpoint3D():Point
| _transformMatrix | property |
public var _transformMatrix:FLARDoubleMatrix34
| transformMatrix | property |
transformMatrix:FLARDoubleMatrix34 [read-only]FLARDoubleMatrix34 matrix that describes transformation of marker relative to the camera. apply to FLARBaseNodes that should appear 'tethered' to the marker.
Implementation public function get transformMatrix():FLARDoubleMatrix34
| _vector3D | property |
public var _vector3D:Vector3D = null
| vector3D | property |
vector3D:Vector3D [read-only]Vector3D instance that describes x, y, and z coordinates, as well as rotationZ (stored as vector3D.w).
Implementation public function get vector3D():Vector3D
| FLARMarker | () | constructor |
public function FLARMarker(detectorResult:FLARMultiMarkerDetectorResult, transformMatrix:FLARDoubleMatrix34, flarSource:IFLARSource)constructor.
ParametersdetectorResult:FLARMultiMarkerDetectorResult |
|
transformMatrix:FLARDoubleMatrix34 |
|
flarSource:IFLARSource |
| applySmoothing | () | method |
public function applySmoothing(smoother:IFLARMatrixSmoother, numFrames:int):voidapply smoothing algorithm over a number of frames. called by FLARManager as part of marker tracking/maintenance process.
Parameterssmoother:IFLARMatrixSmoother |
|
numFrames:int |
| copy | () | method |
public function copy(otherMarker:FLARMarker):voidcopy the properties of a FLARMarker into this FLARMarker.
ParametersotherMarker:FLARMarker |
| dispose | () | method |
public function dispose():voidfree this FLARMarker instance up for garbage collection.
| incrementRemovalAge | () | method |
public function incrementRemovalAge():uintincrement removal age by one. removal age is the number of frames that have elapsed since this FLARMarker was last detected by FLARToolkit. this method is used by FLARManager, and should generally not be called by developers.
Returnsuint |
| resetRemovalAge | () | method |
public function resetRemovalAge():voidreset removal age to zero. removal age is the number of frames that have elapsed since this FLARMarker was last detected by FLARToolkit. this method is used by FLARManager, and should generally not be called by developers.
| setSessionId | () | method |
public function setSessionId():voidcalled only by FLARManager, when a new FLARMarker is detected. this method should not be called by developers. (poor OOP, i know....sorry.)
| toString | () | method |
public function toString():String
Returns
String |