| Package | away3dlite.loaders |
| Class | public class Loader3D |
| Inheritance | Loader3D  ObjectContainer3D Mesh Object3D flash.display.Sprite |
| Property | Defined By | ||
|---|---|---|---|
 | animationLibrary : AnimationLibrary
Used in the loaders to store all parsed animation data contained in the model. | Object3D | |
| autoLoadTextures : Boolean = true
Controls the automatic loading of image files used as textures in the model. | Loader3D | ||
| bothsides : Boolean
Determines whether the faces in teh mesh are visible on both sides (true) or just the front side (false). | Mesh | |
| bytesLoaded : int [read-only] | Loader3D | ||
| bytesTotal : int [read-only] | Loader3D | ||
| children : Array [read-only]
Returns the children of the container as an array of 3d objects. | ObjectContainer3D | |
| containerData : ContainerData
Returns the the data container being used by the loaded file. | Loader3D | ||
| faces : Vector.<Face> [read-only]
Returns the faces used in the mesh. | Mesh | |
| geometryLibrary : GeometryLibrary
Used in loaders to store all parsed geometry data contained in the model. | Object3D | |
| handle : Object3D [read-only]
Returns a 3d object relating to the currently visible model. | Loader3D | ||
| IOErrorText : String [read-only] | Loader3D | ||
| layer : Sprite
An optional layer sprite used to draw into inseatd of the default view. | Object3D | |
| material : Material
Determines the global material used on the faces in the mesh. | Mesh | |
| materialLibrary : MaterialLibrary
Used in loaders to store all parsed materials contained in the model. | Object3D | |
| mode : String
Returns the current loading mode of the 3d object loader. | Loader3D | ||
| parser : AbstractParser | Loader3D | ||
| position : Vector3D [read-only]
Returns a 3d vector representing the local position of the 3d object. | Object3D | |
| scene : Scene3D [read-only]
Returns the scene to which the 3d object belongs
| Object3D | |
| sceneMatrix3D : Matrix3D [read-only]
Returns a 3d matrix representing the absolute transformation of the 3d object in the scene. | Object3D | |
| screenZ : Number [read-only]
Returns the z-sorting position of the 3d object. | Object3D | |
| sortFaces : Boolean = true
Determines if the faces in the mesh are sorted. | Mesh | |
| sortType : String
Determines by which mechanism vertices are sorted. | Mesh | |
| sprites : Vector.<Sprite3D> [read-only]
Returns the sprites of the container as an array of 3d sprites. | ObjectContainer3D | |
| texturePath : String
Defines a different path for the location of image files used as textures in the model. | Loader3D | ||
| type : String
Returns the type of 3d object. | Object3D | |
| url : String
Returns the source url of the 3d object, or the name of the family of generative geometry objects if not loaded from an external source. | Object3D | |
| vertices : Vector.<Number> [override] [read-only]
Returns the 3d vertices used in the mesh. | ObjectContainer3D | |
| viewMatrix3D : Matrix3D [read-only]
Returns a 3d matrix representing the absolute transformation of the 3d object in the view. | Object3D | |
| Method | Defined By | ||
|---|---|---|---|
Loader3D()
Creates a new Loader3D object. | Loader3D | ||
| addChild(child:DisplayObject):DisplayObject [override]
Adds a 3d object to the scene as a child of the container. | ObjectContainer3D | |
|
Adds a 3d object to the scene as a child of the container. | ObjectContainer3D | |
| [override]
Duplicates the 3d object's properties to another ObjectContainer3D object
| ObjectContainer3D | |
| getBoneByName(boneName:String):Bone
Returns a bone object specified by name from the child array of the container
| ObjectContainer3D | |
| getChildByName(childName:String):DisplayObject [override]
Returns a 3d object specified by name from the child array of the container
| ObjectContainer3D | |
loadGeometry(url:String, parser:AbstractParser):void
Loads and parses a 3d file format. | Loader3D | ||
loadTextures(data:*, parser:AbstractParser):void
Parses 3d file data and loads any subsequent textures if required. | Loader3D | ||
| lookAt(target:Vector3D, upAxis:Vector3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
| removeChild(child:DisplayObject):DisplayObject [override]
Removes a 3d object from the child array of the container. | ObjectContainer3D | |
|
Removes a 3d sprite from the sprites array of the container. | ObjectContainer3D | |
| Method | Defined By | ||
|---|---|---|---|
| copyMatrix3D(m1:Matrix3D, m2:Matrix3D):void | Object3D | |
notifyError():void | Loader3D | ||
notifyProgress():void | Loader3D | ||
notifySuccess():void | Loader3D | ||
onGeometryComplete(event:Event):void
Automatically fired on a geometry complete event
| Loader3D | ||
onGeometryError(event:IOErrorEvent):void
Automatically fired on an geometry error event. | Loader3D | ||
onGeometryProgress(event:ProgressEvent):void
Automatically fired on a geometry progress event
| Loader3D | ||
onParserComplete(event:ParserEvent):void
Automatically fired on a parser complete event
| Loader3D | ||
onParserError(event:ParserEvent):void
Automatically fired on an parser error event. | Loader3D | ||
onParserProgress(event:ParserEvent):void
Automatically fired on a parser progress event
| Loader3D | ||
onTextureComplete(event:Event):void
Automatically fired on a texture complete event
| Loader3D | ||
onTextureError(event:IOErrorEvent):void
Automatically fired on an texture error event. | Loader3D | ||
onTextureProgress(event:ProgressEvent):void
Automatically fired on a texture progress event
| Loader3D | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the 3d object loader fails to load a file. | Loader3D | |||
| Dispatched when the 3d object loader progresses in the laoding of a file. | Loader3D | |||
| Dispatched when the 3d object loader completes a file load successfully. | Loader3D | |||
| Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object. | Object3D | ||
| Dispatched when a user moves the cursor while it is over the 3d object. | Object3D | ||
| Dispatched when a user moves the cursor away from the 3d object. | Object3D | ||
| Dispatched when a user moves the cursor over the 3d object. | Object3D | ||
| Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object. | Object3D | ||
| Dispatched when a user rolls out of the 3d object. | Object3D | ||
| Dispatched when a user rolls over the 3d object. | Object3D | ||
| Constant | Defined By | ||
|---|---|---|---|
| COMPLETE : String = complete
Constant value string representing a completed loader mode. | Loader3D | ||
| LOADING_GEOMETRY : String = loading_geometry
Constant value string representing the geometry loading mode of the 3d object loader. | Loader3D | ||
| LOADING_TEXTURES : String = loading_textures
Constant value string representing the texture loading mode of the 3d object loader. | Loader3D | ||
| PARSING_GEOMETRY : String = parsing_geometry
Constant value string representing the geometry parsing mode of the 3d object loader. | Loader3D | ||
| autoLoadTextures | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var autoLoadTextures:Boolean = trueControls the automatic loading of image files used as textures in the model. Defaults to true.
| bytesLoaded | property |
bytesLoaded:int [read-only] public function get bytesLoaded():int| bytesTotal | property |
bytesTotal:int [read-only] public function get bytesTotal():int| containerData | property |
public var containerData:ContainerDataReturns the the data container being used by the loaded file.
| handle | property |
handle:Object3D [read-only]
Returns a 3d object relating to the currently visible model.
While a file is being loaded, this takes the form of the 3d object loader placeholder.
The default placeholder is LoaderCube
Once the file has been loaded and is ready to view, the handle returns the
parsed 3d object file and the placeholder object is swapped in the scenegraph tree.
public function get handle():Object3DSee also
| IOErrorText | property |
IOErrorText:String [read-only] public function get IOErrorText():String| mode | property |
public var mode:StringReturns the current loading mode of the 3d object loader.
| parser | property |
public var parser:AbstractParser| texturePath | property |
public var texturePath:StringDefines a different path for the location of image files used as textures in the model. Defaults to the location of the loaded model file.
| Loader3D | () | Constructor |
public function Loader3D()
Creates a new Loader3D object.
| loadGeometry | () | method |
public function loadGeometry(url:String, parser:AbstractParser):voidLoads and parses a 3d file format.
Parameters
url:String — The url location of the file to be loaded.
| |
parser:AbstractParser — The parser class to be used on the file data once loaded.
|
| loadTextures | () | method |
public function loadTextures(data:*, parser:AbstractParser):voidParses 3d file data and loads any subsequent textures if required.
Parameters
data:* — The file data to be parsed. Can be in text or binary form.
| |
parser:AbstractParser — The parser class to be used on the file data.
|
| notifyError | () | method |
protected function notifyError():void| notifyProgress | () | method |
protected function notifyProgress():void| notifySuccess | () | method |
protected function notifySuccess():void| onGeometryComplete | () | method |
protected function onGeometryComplete(event:Event):voidAutomatically fired on a geometry complete event
Parameters
event:Event |
| onGeometryError | () | method |
protected function onGeometryError(event:IOErrorEvent):voidAutomatically fired on an geometry error event.
Parameters
event:IOErrorEvent |
See also
| onGeometryProgress | () | method |
protected function onGeometryProgress(event:ProgressEvent):voidAutomatically fired on a geometry progress event
Parameters
event:ProgressEvent |
| onParserComplete | () | method |
protected function onParserComplete(event:ParserEvent):voidAutomatically fired on a parser complete event
Parameters
event:ParserEvent |
| onParserError | () | method |
protected function onParserError(event:ParserEvent):voidAutomatically fired on an parser error event.
Parameters
event:ParserEvent |
See also
| onParserProgress | () | method |
protected function onParserProgress(event:ParserEvent):voidAutomatically fired on a parser progress event
Parameters
event:ParserEvent |
| onTextureComplete | () | method |
protected function onTextureComplete(event:Event):voidAutomatically fired on a texture complete event
Parameters
event:Event |
| onTextureError | () | method |
protected function onTextureError(event:IOErrorEvent):voidAutomatically fired on an texture error event.
Parameters
event:IOErrorEvent |
See also
| onTextureProgress | () | method |
protected function onTextureProgress(event:ProgressEvent):voidAutomatically fired on a texture progress event
Parameters
event:ProgressEvent |
| loadError | Event |
away3dlite.events.Loader3DEventaway3dlite.events.Loader3DEventDispatched when the 3d object loader fails to load a file.
| loadProgress | Event |
away3dlite.events.Loader3DEventaway3dlite.events.Loader3DEventDispatched when the 3d object loader progresses in the laoding of a file.
| loadSuccess | Event |
away3dlite.events.Loader3DEventaway3dlite.events.Loader3DEventDispatched when the 3d object loader completes a file load successfully.
| COMPLETE | Constant |
public const COMPLETE:String = completeConstant value string representing a completed loader mode.
| LOADING_GEOMETRY | Constant |
public const LOADING_GEOMETRY:String = loading_geometryConstant value string representing the geometry loading mode of the 3d object loader.
| LOADING_TEXTURES | Constant |
public const LOADING_TEXTURES:String = loading_texturesConstant value string representing the texture loading mode of the 3d object loader.
| PARSING_GEOMETRY | Constant |
public const PARSING_GEOMETRY:String = parsing_geometryConstant value string representing the geometry parsing mode of the 3d object loader.