Packageaway3d.loaders
Classpublic class Loader3D
InheritanceLoader3D Inheritance ObjectContainer3D Inheritance Object3D Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

Loader3D can load any file format that Away3D supports (or for which a third-party parser has been plugged in) and be added directly to the scene. As assets are encountered they are added to the Loader3D container. Assets that can not be displayed in the scene graph (e.g. unused bitmaps/materials, skeletons et c) will be ignored. This provides a fast and easy way to load models (no need for event listeners) but is not very versatile since many types of assets are ignored. Loader3D by default uses the AssetLibrary to load all assets, which means that they also ends up in the library. To circumvent this, Loader3D can be configured to not use the AssetLibrary in which case it will use the AssetLoader directly.

See also

away3d.loading.AssetLoader
away3d.loading.AssetLibrary


Public Properties
 PropertyDefined By
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only]
ObjectContainer3D
 InheritedbackVector : Vector3D
[read-only]
Object3D
 InheriteddownVector : Vector3D
[read-only]
Object3D
 Inheritedeulers : Vector3D
Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis.
Object3D
 Inheritedextra : Object
An object that can contain any extra data.
Object3D
 InheritedforwardVector : Vector3D
[read-only]
Object3D
 InheritedinverseSceneTransform : Matrix3D
[read-only] The inverse scene transform object that transforms from world to model space.
ObjectContainer3D
 InheritedleftVector : Vector3D
[read-only]
Object3D
 InheritedmaxX : Number
[read-only] The maximum extremum of the object along the X-axis.
ObjectContainer3D
 InheritedmaxY : Number
[read-only] The maximum extremum of the object along the Y-axis.
ObjectContainer3D
 InheritedmaxZ : Number
[read-only] The maximum extremum of the object along the Z-axis.
ObjectContainer3D
 InheritedminX : Number
[read-only] The minimum extremum of the object along the X-axis.
ObjectContainer3D
 InheritedminY : Number
[read-only] The minimum extremum of the object along the Y-axis.
ObjectContainer3D
 InheritedminZ : Number
[read-only] The minimum extremum of the object along the Z-axis.
ObjectContainer3D
 InheritedmouseChildren : Boolean
ObjectContainer3D
 InheritedmouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
ObjectContainer3D
 Inheritedname : String
NamedAssetBase
 InheritednumChildren : uint
[read-only] The amount of child objects of the ObjectContainer3D.
ObjectContainer3D
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
 Inheritedparent : ObjectContainer3D
[read-only] The parent ObjectContainer3D to which this object's transformation is relative.
ObjectContainer3D
 Inheritedpartition : Partition3D
The space partition to be used by the object container and all its recursive children, unless it has its own space partition assigned.
ObjectContainer3D
 InheritedpivotPoint : Vector3D
Defines the local point around which the object rotates.
Object3D
 Inheritedposition : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrightVector : Vector3D
[read-only]
Object3D
 InheritedrotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedscaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
Object3D
 InheritedscaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
Object3D
 InheritedscaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
Object3D
 Inheritedscene : Scene3D
A reference to the Scene3D object to which this object belongs.
ObjectContainer3D
 InheritedscenePosition : Vector3D
[read-only] The global position of the ObjectContainer3D in the scene.
ObjectContainer3D
 InheritedsceneTransform : Matrix3D
[read-only] The transformation matrix that transforms from model to world space.
ObjectContainer3D
 Inheritedtransform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedupVector : Vector3D
[read-only]
Object3D
 Inheritedvisible : Boolean
ObjectContainer3D
 Inheritedx : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedy : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedz : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
Protected Properties
 PropertyDefined By
 Inherited_explicitPartition : Partition3D
ObjectContainer3D
 Inherited_implicitPartition : Partition3D
ObjectContainer3D
 Inherited_mouseEnabled : Boolean
ObjectContainer3D
 Inherited_parent : ObjectContainer3D
ObjectContainer3D
 Inherited_pivotPoint : Vector3D
Object3D
 Inherited_pivotZero : Boolean = true
Object3D
 Inherited_pos : Vector3D
Object3D
 Inherited_rot : Vector3D
Object3D
 Inherited_sca : Vector3D
Object3D
 Inherited_scaleX : Number = 1
Object3D
 Inherited_scaleY : Number = 1
Object3D
 Inherited_scaleZ : Number = 1
Object3D
 Inherited_scene : Scene3D
ObjectContainer3D
 Inherited_sceneTransform : Matrix3D
ObjectContainer3D
 Inherited_sceneTransformDirty : Boolean = true
ObjectContainer3D
 Inherited_transform : Matrix3D
Object3D
 Inherited_transformComponents : Vector.<Vector3D>
Object3D
 Inherited_x : Number = 0
Object3D
 Inherited_y : Number = 0
Object3D
 Inherited_z : Number = 0
Object3D
Public Methods
 MethodDefined By
  
Loader3D(useAssetLibrary:Boolean = true, assetLibraryId:String = null)
Loader3D
 Inherited
Adds a child ObjectContainer3D to the current object.
ObjectContainer3D
 Inherited
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
ObjectContainer3D
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override]
ObjectContainer3D
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
[override] Clones this ObjectContainer3D instance along with all it's children, and returns the result (which will be a copy of this container, containing copies of all it's children.)
ObjectContainer3D
 Inherited
ObjectContainer3D
 Inherited
dispatchEvent(event:Event):Boolean
[override]
ObjectContainer3D
 Inherited
dispose():void
[override] Cleans up resources used by this asset.
ObjectContainer3D
 Inherited
Object3D
  
enableParser(parserClass:Class):void
[static]
Loader3D
  
enableParsers(parserClasses:Vector.<Class>):void
[static]
Loader3D
 Inherited
Retrieves the child object at the given index.
ObjectContainer3D
  
load(req:URLRequest, context:AssetLoaderContext = null, ns:String = null, parser:ParserBase = null):AssetLoaderToken
Loads a file and (optionally) all of its dependencies.
Loader3D
  
loadData(data:*, context:AssetLoaderContext = null, ns:String = null, parser:ParserBase = null):AssetLoaderToken
Loads a resource from already loaded data.
Loader3D
 Inherited
lookAt(target:Vector3D, upAxis:Vector3D = null):void
[override] Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
ObjectContainer3D
 Inherited
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
Object3D
 Inherited
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
Object3D
 Inherited
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
Object3D
 Inherited
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
Object3D
 Inherited
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates.
Object3D
 Inherited
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Object3D
 Inherited
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
Object3D
 Inherited
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
Object3D
 Inherited
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
Object3D
 Inherited
Removes a 3d object from the child array of the container
ObjectContainer3D
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override]
ObjectContainer3D
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Vector3D, angle:Number):void
[override]
ObjectContainer3D
 Inherited
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
Object3D
 Inherited
scale(value:Number):void
Appends a uniform scale to the current transformation.
Object3D
 Inherited
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
 Inherited
translateLocal(axis:Vector3D, distance:Number):void
[override]
ObjectContainer3D
 Inherited
ObjectContainer3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined By
 Inherited
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
ObjectContainer3D
 Inherited
ObjectContainer3D
 Inherited
Updates the scene transformation matrix.
ObjectContainer3D
 Inherited
Object3D
Events
 Event Summary Defined By
  Dispatched when an animation node has been constructed from a resource.Loader3D
  Dispatched when an animation set has been constructed from a group of animation state resources.Loader3D
  Dispatched when an animation state has been constructed from a group of animation node resources.Loader3D
  Dispatched when a animator asset has been constructed from a resource.Loader3D
  Dispatched when any asset finishes parsing.Loader3D
  Dispatched when a container asset has been constructed from a resource.Loader3D
  Dispatched when a single dependency (which may be the main file of a resource) finishes loading.Loader3D
  Dispatched when a geometry asset has been constructed from a resource.Loader3D
  Dispatched when an error occurs during loading.Loader3D
  Dispatched when a material asset has been constructed from a resource.Loader3D
 InheritedDispatched when a user presses the left hand mouse button while the cursor is over the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor while it is over the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor away from the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor over the 3d object.ObjectContainer3D
 InheritedDispatched when a user releases the left hand mouse button while the cursor is over the 3d object.ObjectContainer3D
 InheritedDispatched when the position of the 3d object changes.Object3D
  Dispatched when a full resource (including dependencies) finishes loading.Loader3D
 InheritedDispatched when the rotation of the 3d object changes.Object3D
 InheritedDispatched when the scale of the 3d object changes.Object3D
 InheritedDispatched when the parent scene of the 3d object changes.ObjectContainer3D
 InheritedDispatched when the scene transform matrix of the 3d object changes.ObjectContainer3D
  Dispatched when a skeleton asset has been constructed from a resource.Loader3D
  Dispatched when a skeleton pose asset has been constructed from a resource.Loader3D
  Dispatched when an animation state transition has been constructed from a group of animation node resources.Loader3D
  Dispatched when a texture asset has been constructed from a resource.Loader3D
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Constructor Detail
Loader3D()Constructor
public function Loader3D(useAssetLibrary:Boolean = true, assetLibraryId:String = null)



Parameters
useAssetLibrary:Boolean (default = true)
 
assetLibraryId:String (default = null)
Method Detail
enableParser()method
public static function enableParser(parserClass:Class):void

Parameters

parserClass:Class

enableParsers()method 
public static function enableParsers(parserClasses:Vector.<Class>):void

Parameters

parserClasses:Vector.<Class>

load()method 
public function load(req:URLRequest, context:AssetLoaderContext = null, ns:String = null, parser:ParserBase = null):AssetLoaderToken

Loads a file and (optionally) all of its dependencies.

Parameters

req:URLRequest — The URLRequest object containing the URL of the file to be loaded.
 
context:AssetLoaderContext (default = null) — An optional context object providing additional parameters for loading
 
ns:String (default = null) — An optional namespace string under which the file is to be loaded, allowing the differentiation of two resources with identical assets
 
parser:ParserBase (default = null) — An optional parser object for translating the loaded data into a usable resource. If not provided, AssetLoader will attempt to auto-detect the file type.

Returns
AssetLoaderToken
loadData()method 
public function loadData(data:*, context:AssetLoaderContext = null, ns:String = null, parser:ParserBase = null):AssetLoaderToken

Loads a resource from already loaded data.

Parameters

data:* — The data object containing all resource information.
 
context:AssetLoaderContext (default = null) — An optional context object providing additional parameters for loading
 
ns:String (default = null) — An optional namespace string under which the file is to be loaded, allowing the differentiation of two resources with identical assets
 
parser:ParserBase (default = null) — An optional parser object for translating the loaded data into a usable resource. If not provided, AssetLoader will attempt to auto-detect the file type.

Returns
AssetLoaderToken
Event Detail
animationNodeComplete Event
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when an animation node has been constructed from a resource.

animationSetComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when an animation set has been constructed from a group of animation state resources.

animationStateComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when an animation state has been constructed from a group of animation node resources.

animatorComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when a animator asset has been constructed from a resource.

assetComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when any asset finishes parsing. Also see specific events for each individual asset type (meshes, materials et c.)

containerComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when a container asset has been constructed from a resource.

dependencyComplete Event  
Event Object Type: away3d.events.LoaderEvent
LoaderEvent.type property = away3d.events.LoaderEvent

Dispatched when a single dependency (which may be the main file of a resource) finishes loading.

geometryComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when a geometry asset has been constructed from a resource.

loadError Event  
Event Object Type: away3d.events.LoaderEvent
LoaderEvent.type property = away3d.events.LoaderEvent

Dispatched when an error occurs during loading.

materialComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when a material asset has been constructed from a resource.

resourceComplete Event  
Event Object Type: away3d.events.LoaderEvent
LoaderEvent.type property = away3d.events.LoaderEvent

Dispatched when a full resource (including dependencies) finishes loading.

skeletonComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when a skeleton asset has been constructed from a resource.

skeletonPoseComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when a skeleton pose asset has been constructed from a resource.

stateTransitionComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when an animation state transition has been constructed from a group of animation node resources.

textureComplete Event  
Event Object Type: away3d.events.AssetEvent
AssetEvent.type property = away3d.events.AssetEvent

Dispatched when a texture asset has been constructed from a resource.