ParserBase provides an abstract base class for objects that convert blocks of data to data structures
supported by Away3D.
If used by
AssetLoader to automatically determine the parser type, two static public methods should
be implemented, with the following signatures:
public static function supportsType(extension : String) : Boolean
Indicates whether or not a given file extension is supported by the parser.
public static function supportsData(data : : Boolean
Tests whether a data block can be parsed by the parser.
Furthermore, for any concrete subtype, the method
initHandle should be overridden to immediately
create the object that will contain the parsed data. This allows
ResourceManager to return an object
handle regardless of whether the object was loaded or not.
baseUri:String [read-only]
The parent url of the file to be parsed.
Implementation
public function get baseUri():String
protected var _byteData:ByteArray
protected var _dataFormat:String
dataFormat:String [read-only]
The data format of the file data to be parsed. Can be either ParserDataFormat.BINARY or ParserDataFormat.PLAIN_TEXT.
Implementation
public function get dataFormat():String
defaultBitmapData:BitmapData [read-only]
The url or id of the data or file to be parsed.
Implementation
public function get defaultBitmapData():BitmapData
protected var _dependencies:Vector
A list of dependencies that need to be loaded and resolved for the object being parsed.
See also
dependencies:Vector [read-only]
A list of dependencies that need to be loaded and resolved for the object being parsed.
Implementation
public function get dependencies():Vector
eventVerbosity:int [read-write]
The threshold that define which events are dispatched.
Implementation
public function get eventVerbosity():int
public function set eventVerbosity(value:int):void
protected var _frameLimit:Number
handle:IResource [read-only]
The object that will contain all the parsed data.
Implementation
public function get handle():IResource
protected var _lastFrameTime:Number
parsingFailure:Boolean [read-write]Implementation
public function get parsingFailure():Boolean
public function set parsingFailure(value:Boolean):void
protected var _textData:String
uri:String [read-only]
The url or id of the data or file to be parsed.
Implementation
public function get uri():String
public function ParserBase(uri:String, format:String)Parameters
| uri:String — The url or id of the data or file to be parsed.
|
| |
| format:String — The data format of the file data to be parsed. Can be either ParserDataFormat.BINARY or ParserDataFormat.PLAIN_TEXT, and should be provided by the concrete subtype.
|
Init Parameters
See also
protected function finishParsing():void
Finish parsing the data.
protected function hasTime():Boolean
Tests whether or not there is still time left for parsing within the maximum allowed time frame per session.
Returns
| Boolean — True if there is still time left, false if the maximum allotted time was exceeded and parsing should be interrupted.
|
protected function initHandle():IResource
Creates the object that will be returned to the user and will contain all the loaded data. This allows
ResourceManager to return an object handle regardless of whether the object was loaded or not,
which in turn allows users to add objects to the scene or assign materials before they are actually loaded.
This method needs to be overridden by concrete subclasses.
Returns
public function isBitmapDataValid(bitmapData:BitmapData):Boolean
Validates a bitmapData loaded before assigning to a default BitmapMaterial
Parameters
Returns
protected function onInterval(event:TimerEvent = null):void
Called when the parsing pause interval has passed and parsing can proceed.
Parameters
| event:TimerEvent (default = null) |
public function parseBytesAsync(bytes:ByteArray, frameLimit:Number = 30):void
Parse byte array (possibly containing plain text) asynchronously, meaning that
the parser will periodically stop parsing so that the AVM may proceed to the
next frame.
Parameters
| bytes:ByteArray — The byte array in which the loaded data resides.
|
| |
| frameLimit:Number (default = 30) |
public function parseTextAsync(str:String, frameLimit:Number = 30):void
Parse plaintext string asynchronously, meaning that the parser will periodically
stop parsing so that the AVM may proceed to the next frame. If this parser
requires binary data, an error will be thrown.
Parameters
| str:String — Text data used for parsing.
|
| |
| frameLimit:Number (default = 30) |
protected function proceedParsing():Boolean
Parse the next block of data.
Returns
| Boolean — Whether or not more data needs to be parsed. Can be ParserBase.PARSING_DONE or
ParserBase.MORE_TO_PARSE.
|
arcane function resolveDependency(resourceDependency:ResourceDependency):void
Resolve a dependency when it's loaded. For example, a dependency containing an ImageResource would be assigned
to a Mesh instance as a BitmapMaterial, a scene graph object would be added to its intended parent. The
dependency should be a member of the dependencies property.
Parameters
arcane function resolveDependencyFailure(resourceDependency:ResourceDependency):void
Resolve a dependency loading failure. Used by parser to eventually provide a default map
Parameters
protected static const MORE_TO_PARSE:Boolean = false
Returned by proceedParsing to indicate more parsing is needed, allowing asynchronous parsing.
protected static const PARSING_DONE:Boolean = true
Returned by proceedParsing to indicate no more parsing is needed.
flash.events.EventDispatcher