Packageaway3d.loaders.parsers
Classpublic class ImageParser
InheritanceImageParser Inheritance ParserBase Inheritance flash.events.EventDispatcher

ImageParser provides a "parser" for natively supported image types (jpg, png). While it simply loads bytes into a loader object, it wraps it in a BitmapDataResource so resource management can happen consistently without exception cases.


Public Properties
 PropertyDefined By
 InheriteddataFormat : String
[read-only] The data format of the file data to be parsed.
ParserBase
 InheriteddefaultBitmapData : BitmapData
[read-only] The url or id of the data or file to be parsed.
ParserBase
 Inheriteddependencies : Vector.<ResourceDependency>
[read-only] A list of dependencies that need to be loaded and resolved for the object being parsed.
ParserBase
 InheritedparsingComplete : Boolean
[read-only]
ParserBase
 InheritedparsingFailure : Boolean
ParserBase
 InheritedparsingPaused : Boolean
[read-only]
ParserBase
Protected Properties
 PropertyDefined By
 Inherited_byteData : ByteArray
ParserBase
 Inherited_dataFormat : String
ParserBase
 Inherited_frameLimit : Number
ParserBase
 Inherited_lastFrameTime : Number
ParserBase
 Inherited_textData : String
ParserBase
Public Methods
 MethodDefined By
  
ImageParser()
Creates a new ImageParser object.
ImageParser
 Inherited
isBitmapDataValid(bitmapData:BitmapData):Boolean
Validates a bitmapData loaded before assigning to a default BitmapMaterial
ParserBase
 Inherited
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.
ParserBase
 Inherited
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.
ParserBase
  
supportsData(data:*):Boolean
[static] Tests whether a data block can be parsed by the parser.
ImageParser
  
supportsType(extension:String):Boolean
[static] Indicates whether or not a given file extension is supported by the parser.
ImageParser
Protected Methods
 MethodDefined By
 Inherited
addDependency(id:String, req:URLRequest, retrieveAsRawData:Boolean = false, data:* = null):void
ParserBase
 Inherited
dieWithError(message:String = Unknown parsing error):void
ParserBase
 Inherited
finalizeAsset(asset:IAsset, name:String = null):void
ParserBase
 Inherited
finishParsing():void
Finish parsing the data.
ParserBase
 Inherited
hasTime():Boolean
Tests whether or not there is still time left for parsing within the maximum allowed time frame per session.
ParserBase
 Inherited
onInterval(event:TimerEvent = null):void
Called when the parsing pause interval has passed and parsing can proceed.
ParserBase
 Inherited
pauseAndRetrieveDependencies():void
ParserBase
  
proceedParsing():Boolean
[override] Parse the next block of data.
ImageParser
Protected Constants
 ConstantDefined By
 InheritedMORE_TO_PARSE : Boolean = false
[static] Returned by proceedParsing to indicate more parsing is needed, allowing asynchronous parsing.
ParserBase
 InheritedPARSING_DONE : Boolean = true
[static] Returned by proceedParsing to indicate no more parsing is needed.
ParserBase
Constructor Detail
ImageParser()Constructor
public function ImageParser()

Creates a new ImageParser object.

Method Detail
proceedParsing()method
override 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.
supportsData()method 
public static function supportsData(data:*):Boolean

Tests whether a data block can be parsed by the parser.

Parameters

data:* — The data block to potentially be parsed.

Returns
Boolean — Whether or not the given data is supported.
supportsType()method 
public static function supportsType(extension:String):Boolean

Indicates whether or not a given file extension is supported by the parser.

Parameters

extension:String — The file extension of a potential file to be parsed.

Returns
Boolean — Whether or not the given file type is supported.




Thu Sep 8 2011, 01:50 PM +01:00