Packageaway3d.loaders
Classpublic class AbstractParser
InheritanceAbstractParser Inheritance flash.events.EventDispatcher
Subclasses AC3D, Ase, AWData, Collada, Kmz, Max3DS, Md2, Obj, Swf

Abstract parsing object used as a base class for all loaders to extend from.


Public Properties
 PropertyDefined By
  centerMeshes : Boolean
Controls the automatic centering of geometry data in the model, improving culling and the accuracy of bounding dimension values.
AbstractParser
  container : Object3D
[read-only] Retuns a 3d container object used for storing the parsed 3d object.
AbstractParser
  geometryLibrary : GeometryLibrary
[read-only] Retuns a geometryLibrary object used for storing the parsed geometry data.
AbstractParser
  material : Material
Overrides all materials in the model.
AbstractParser
  materialLibrary : MaterialLibrary
[read-only] Retuns a materialLibrary object used for storing the parsed material objects.
AbstractParser
  materials : Object
Overides materials in the model using name:value pairs.
AbstractParser
  parsedChunks : int
[read-only] Returns the total number of data chunks parsed
AbstractParser
  parseTimeout : int
Defines a timeout period for file parsing (in milliseconds).
AbstractParser
  totalChunks : int
[read-only] Returns the total number of data chunks available
AbstractParser
Protected Properties
 PropertyDefined By
  ini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the parser constructor.
AbstractParser
  _symbolLibrary : Dictionary
AbstractParser
Public Methods
 MethodDefined By
  
AbstractParser(init:Object = null)
Creates a new AbstractParser object.
AbstractParser
  
addOnError(listener:Function):void
Default method for adding a parseError event listener
AbstractParser
  
addOnProgress(listener:Function):void
Default method for adding a parseProgress event listener
AbstractParser
  
addOnSuccess(listener:Function):void
Default method for adding a parseSuccess event listener
AbstractParser
  
parseGeometry(data:*):Object3D
Parses 3d file data.
AbstractParser
  
removeOnError(listener:Function):void
Default method for removing a parseError event listener
AbstractParser
  
removeOnProgress(listener:Function):void
Default method for removing a parseProgress event listener
AbstractParser
  
removeOnSuccess(listener:Function):void
Default method for removing a parseSuccess event listener
AbstractParser
Protected Methods
 MethodDefined By
  
buildContainers(containerData:ContainerData, parent:ObjectContainer3D):void
AbstractParser
  
buildMaterials():void
AbstractParser
  
buildMesh(_meshData:MeshData, parent:ObjectContainer3D):Mesh
AbstractParser
Events
 Event Summary Defined By
  
parseError
Dispatched when the 3d object parser fails to parse a file.AbstractParser
  
parseProgress
Dispatched when the 3d object parser progresses by one chunk.AbstractParser
  
parseSuccess
Dispatched when the 3d object parser completes a file parse successfully.AbstractParser
Property Detail
_symbolLibraryproperty
protected var _symbolLibrary:Dictionary

centerMeshesproperty 
public var centerMeshes:Boolean

Controls the automatic centering of geometry data in the model, improving culling and the accuracy of bounding dimension values. Defaults to false.

containerproperty 
container:Object3D  [read-only]

Retuns a 3d container object used for storing the parsed 3d object.


Implementation
    public function get container():Object3D
geometryLibraryproperty 
geometryLibrary:GeometryLibrary  [read-only]

Retuns a geometryLibrary object used for storing the parsed geometry data.


Implementation
    public function get geometryLibrary():GeometryLibrary
iniproperty 
protected var ini:Init

Instance of the Init object used to hold and parse default property values specified by the initialiser object in the parser constructor.

materialproperty 
public var material:Material

Overrides all materials in the model.

materialLibraryproperty 
materialLibrary:MaterialLibrary  [read-only]

Retuns a materialLibrary object used for storing the parsed material objects.


Implementation
    public function get materialLibrary():MaterialLibrary
materialsproperty 
materials:Object

Overides materials in the model using name:value pairs.


Implementation
    public function get materials():Object
    public function set materials(value:Object):void
parsedChunksproperty 
parsedChunks:int  [read-only]

Returns the total number of data chunks parsed


Implementation
    public function get parsedChunks():int
parseTimeoutproperty 
public var parseTimeout:int

Defines a timeout period for file parsing (in milliseconds).

totalChunksproperty 
totalChunks:int  [read-only]

Returns the total number of data chunks available


Implementation
    public function get totalChunks():int
Constructor Detail
AbstractParser()Constructor
public function AbstractParser(init:Object = null)

Creates a new AbstractParser object.

Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
####INIT####
Method Detail
addOnError()method
public function addOnError(listener:Function):void

Default method for adding a parseError event listener

Parameters

listener:Function — The listener function

addOnProgress()method 
public function addOnProgress(listener:Function):void

Default method for adding a parseProgress event listener

Parameters

listener:Function — The listener function

addOnSuccess()method 
public function addOnSuccess(listener:Function):void

Default method for adding a parseSuccess event listener

Parameters

listener:Function — The listener function

buildContainers()method 
protected function buildContainers(containerData:ContainerData, parent:ObjectContainer3D):void

Parameters

containerData:ContainerData
 
parent:ObjectContainer3D

buildMaterials()method 
protected function buildMaterials():void

buildMesh()method 
protected function buildMesh(_meshData:MeshData, parent:ObjectContainer3D):Mesh

Parameters

_meshData:MeshData
 
parent:ObjectContainer3D

Returns
Mesh
parseGeometry()method 
public function parseGeometry(data:*):Object3D

Parses 3d file data.

Parameters

data:* — The file data to be parsed. Can be in text or binary form.

Returns
Object3D — The parsed 3d object.
removeOnError()method 
public function removeOnError(listener:Function):void

Default method for removing a parseError event listener

Parameters

listener:Function — The listener function

removeOnProgress()method 
public function removeOnProgress(listener:Function):void

Default method for removing a parseProgress event listener

Parameters

listener:Function — The listener function

removeOnSuccess()method 
public function removeOnSuccess(listener:Function):void

Default method for removing a parseSuccess event listener

Parameters

listener:Function — The listener function

Event Detail
parseError Event
Event Object Type: away3d.events.ParserEvent
ParserEvent.type property = away3d.events.ParserEvent

Dispatched when the 3d object parser fails to parse a file.

parseProgress Event  
Event Object Type: away3d.events.ParserEvent
ParserEvent.type property = away3d.events.ParserEvent

Dispatched when the 3d object parser progresses by one chunk.

parseSuccess Event  
Event Object Type: away3d.events.ParserEvent
ParserEvent.type property = away3d.events.ParserEvent

Dispatched when the 3d object parser completes a file parse successfully.





Tue Jun 7 2011, 11:27 PM +01:00