Packageaway3d.loaders.parsers
Classpublic class OBJParser
InheritanceOBJParser Inheritance ParserBase Inheritance flash.events.EventDispatcher

OBJParser provides a parser for the OBJ data type.



Public Properties
 PropertyDefined By
 InheriteddataFormat : String
[read-only] The data format of the file data 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
  scale : Number
[write-only] Scaling factor applied directly to vertices data
OBJParser
Protected Properties
 PropertyDefined By
 Inherited_data : *
ParserBase
 Inherited_dataFormat : String
ParserBase
 Inherited_frameLimit : Number
ParserBase
 Inherited_lastFrameTime : Number
ParserBase
Public Methods
 MethodDefined By
  
OBJParser(scale:Number = 1)
Creates a new OBJParser object.
OBJParser
 Inherited
isBitmapDataValid(bitmapData:BitmapData):Boolean
Validates a bitmapData loaded before assigning to a default BitmapMaterial
ParserBase
 Inherited
parseAsync(data:*, frameLimit:Number = 30):void
Parse data (possibly containing bytearry, plain text or BitmapAsset) 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.
OBJParser
  
supportsType(extension:String):Boolean
[static] Indicates whether or not a given file extension is supported by the parser.
OBJParser
Protected Methods
 MethodDefined By
 Inherited
addDependency(id:String, req:URLRequest, retrieveAsRawData:Boolean = false, data:* = null, suppressErrorEvents:Boolean = false):void
ParserBase
 Inherited
dieWithError(message:String = Unknown parsing error):void
ParserBase
 Inherited
finalizeAsset(asset:IAsset, name:String = null):void
ParserBase
 Inherited
Finish parsing the data.
ParserBase
 Inherited
getByteData():ByteArray
ParserBase
 Inherited
getTextData():String
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
ParserBase
  
proceedParsing():Boolean
[override] Parse the next block of data.
OBJParser
Events
 Event Summary Defined By
 InheritedDispatched when an animation node has been constructed from a resource.ParserBase
 InheritedDispatched when an animation set has been constructed from a group of animation state resources.ParserBase
 InheritedDispatched when an animation state has been constructed from a group of animation node resources.ParserBase
 InheritedDispatched when a animator asset has been constructed from a resource.ParserBase
 InheritedDispatched when any asset finishes parsing.ParserBase
 InheritedDispatched when a container asset has been constructed from a resource.ParserBase
 InheritedDispatched when a geometry asset has been constructed from a resource.ParserBase
 InheritedDispatched when a material asset has been constructed from a resource.ParserBase
 InheritedDispatched when the parsing finishes.ParserBase
 InheritedDispatched if an error was caught during parsing.ParserBase
 InheritedDispatched when parser pauses to wait for dependencies, used internally to trigger loading of dependencies which are then returned to the parser through it's interface in the arcane namespace.ParserBase
 InheritedDispatched when a skeleton asset has been constructed from a resource.ParserBase
 InheritedDispatched when a skeleton pose asset has been constructed from a resource.ParserBase
 InheritedDispatched when an animation state transition has been constructed from a group of animation node resources.ParserBase
 InheritedDispatched when a texture asset has been constructed from a resource.ParserBase
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
Property Detail
scaleproperty
scale:Number  [write-only]

Scaling factor applied directly to vertices data


Implementation
    public function set scale(value:Number):void
Constructor Detail
OBJParser()Constructor
public function OBJParser(scale:Number = 1)

Creates a new OBJParser object.

Parameters
scale:Number (default = 1) — The url or id of the data or file to be parsed.
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.
resolveDependency()method 
override 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

resourceDependency:ResourceDependency — The dependency to be resolved.

resolveDependencyFailure()method 
override arcane function resolveDependencyFailure(resourceDependency:ResourceDependency):void

Resolve a dependency loading failure. Used by parser to eventually provide a default map

Parameters

resourceDependency:ResourceDependency — The dependency to be resolved.

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.