Package | away3d.loaders |
Class | public class Object3DLoader |
Inheritance | Object3DLoader ![]() ![]() ![]() |
Subclasses | CubeLoader |
Property | Defined by | ||
---|---|---|---|
![]() | alpha : Number
An optional alpha value that can be applied to the 3d object.
| Object3D | |
![]() | blendMode : String
An optional blend mode that can be applied to the 3d object.
| Object3D | |
![]() | boundingRadius : Number
Returns the bounding radius of the 3d object
| ObjectContainer3D | |
![]() | children : Array
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.
| Object3DLoader | ||
![]() | extra : Object
An optional untyped object that can contain used-defined properties
| Object3D | |
![]() | filters : Array
An optional array of filters that can be applied to the 3d object.
| Object3D | |
handle : Object3D
[read-only]
Returns a 3d object relating to the currently visible model.
| Object3DLoader | ||
![]() | inverseSceneTransform : Matrix3D | Object3D | |
materialLibrary : MaterialLibrary
Returns the material library being used by the loaded file.
| Object3DLoader | ||
![]() | maxX : Number
Returns the maximum x value of the 3d object
| ObjectContainer3D | |
![]() | maxY : Number
Returns the maximum y value of the 3d object
| ObjectContainer3D | |
![]() | maxZ : Number
Returns the maximum z value of the 3d object
| ObjectContainer3D | |
![]() | minX : Number
Returns the minimum x value of the 3d object
| ObjectContainer3D | |
![]() | minY : Number
Returns the minimum y value of the 3d object
| ObjectContainer3D | |
![]() | minZ : Number
Returns the minimum z value of the 3d object
| ObjectContainer3D | |
mode : String
Returns the current loading mode of the 3d object loader.
| Object3DLoader | ||
![]() | mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
| Object3D | |
![]() | name : String
An optional name string for the 3d object.
| Object3D | |
![]() | ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
| Object3D | |
![]() | ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
| Object3D | |
![]() | parent : ObjectContainer3D
Defines the parent of the 3d object.
| Object3D | |
parse : Function
Function placeholder for the parse method from the correct file loader class.
| Object3DLoader | ||
![]() | position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | projection : Projection | Object3D | |
![]() | rotationX : 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 | |
![]() | rotationY : 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 | |
![]() | rotationZ : 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 | |
![]() | scene : Scene3D
Returns the parent scene of the 3d object
| Object3D | |
![]() | scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the
Scene3D . | Object3D | |
![]() | sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the
Scene3D . | Object3D | |
![]() | sceneTransformed : Boolean | Object3D | |
![]() | session : AbstractRenderSession
The render session used by the 3d object
| Object3D | |
texturePath : String
Returns the filepath to the directory where any required texture files are located.
| Object3DLoader | ||
![]() | transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
url : String
Returns the url string of the file being loaded.
| Object3DLoader | ||
![]() | useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
| Object3D | |
![]() | viewTransform : Matrix3D | Object3D | |
![]() | visible : Boolean = true
Defines whether the 3d object is visible in the scene
| Object3D | |
![]() | x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D |
Method | Defined by | ||
---|---|---|---|
Object3DLoader
(init:Object = null)
Creates a new
Object3DLoader object. | Object3DLoader | ||
![]() |
Adds a 3d object to the scene as a child of the container
| ObjectContainer3D | |
![]() |
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
| ObjectContainer3D | |
![]() |
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
| Object3D | |
addOnError(listener:Function):void
Default method for adding a loaderror event listener
| Object3DLoader | ||
![]() |
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
| Object3D | |
![]() |
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
| Object3D | |
![]() |
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
| Object3D | |
![]() |
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
| Object3D | |
![]() |
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
| Object3D | |
![]() |
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
| Object3D | |
![]() |
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
| Object3D | |
![]() |
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
| Object3D | |
addOnSuccess(listener:Function):void
Default method for adding a loadsuccess event listener
| Object3DLoader | ||
![]() |
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
| Object3D | |
![]() |
clone(object:* = null):*
Duplicates the 3d object's properties to another
ObjectContainer3D object
| ObjectContainer3D | |
![]() |
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
| Object3D | |
![]() |
Returns a 3d object specified by name from the child array of the container
| ObjectContainer3D | |
![]() |
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() |
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
| Object3D | |
![]() |
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
| Object3D | |
![]() |
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
| Object3D | |
![]() |
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
| Object3D | |
![]() |
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
| ObjectContainer3D | |
![]() |
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
| Object3D | |
![]() |
Moves the 3d object directly to a point in space
| Object3D | |
![]() |
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
| Object3D | |
![]() |
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
| Object3D | |
![]() |
Called from the
PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
| Object3D | |
![]() |
Removes a 3d object from the child array of the container
| ObjectContainer3D | |
![]() |
removeChildByName(name:String):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | |
![]() |
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
| Object3D | |
removeOnError(listener:Function):void
Default method for removing a loaderror event listener
| Object3DLoader | ||
![]() |
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
| Object3D | |
![]() |
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
| Object3D | |
![]() |
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
| Object3D | |
![]() |
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
| Object3D | |
![]() |
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
| Object3D | |
![]() |
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
| Object3D | |
![]() |
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
| Object3D | |
![]() |
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
| Object3D | |
removeOnSuccess(listener:Function):void
Default method for removing a loadsuccess event listener
| Object3DLoader | ||
![]() |
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
| Object3D | |
![]() |
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
![]() |
Rotates the 3d object around an axis by a defined angle
| Object3D | |
![]() |
scale(scale:Number):void
Scales the contents of the 3d object.
| ObjectContainer3D | |
![]() |
tick(time:int):void
Called by the
TickTraverser . | Object3D | |
![]() |
toString():String
Used to trace the values of a 3d object.
| Object3D | |
![]() |
Moves the 3d object along a vector by a defined length
| Object3D | |
![]() |
Used when traversing the scenegraph
| ObjectContainer3D | |
![]() |
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Method | Defined by | ||
---|---|---|---|
onComplete(event:Event):void
Automatically fired on a complete event
| Object3DLoader | ||
onError(event:IOErrorEvent):void
Automatically fired on an error event.
| Object3DLoader | ||
onProgress(event:ProgressEvent):void
Automatically fired on a progress event
| Object3DLoader |
Event | Summary | Defined by | ||
---|---|---|---|---|
![]() | Dispatched when the bounding dimensions of the 3d object changes. | Object3D | ||
Dispatched when the 3d object loader fails to load a file. | Object3DLoader | |||
Dispatched when the 3d object loader completes a file load successfully. | Object3DLoader | |||
![]() | Dispatched when a user presses the let 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 let hand mouse button while the cursor is over the 3d object. | Object3D | ||
![]() | Dispatched when the bounding radius of the 3d object changes. | Object3D | ||
![]() | Dispatched when the parent scene of the 3d object changes | Object3D | ||
![]() | Dispatched when the scene transform matrix of the 3d object changes. | Object3D | ||
![]() | Dispatched when the local transform matrix of the 3d object changes. | Object3D |
Constant | Defined by | ||
---|---|---|---|
LOADING_GEOMETRY : String = "loading_geometry"
Constant value string representing the geometry loading mode of the 3d object loader.
| Object3DLoader | ||
LOADING_TEXTURES : String = "loading_textures"
Constant value string representing the texture loading mode of the 3d object loader.
| Object3DLoader |
containerData | property |
public var containerData:ContainerData
Returns 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 CubeLoader
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():Object3D
See also
materialLibrary | property |
public var materialLibrary:MaterialLibrary
Returns the material library being used by the loaded file.
mode | property |
public var mode:String
Returns the current loading mode of the 3d object loader.
parse | property |
public var parse:Function
Function placeholder for the parse method from the correct file loader class.
texturePath | property |
public var texturePath:String
Returns the filepath to the directory where any required texture files are located.
url | property |
public var url:String
Returns the url string of the file being loaded.
Object3DLoader | () | constructor |
public function Object3DLoader(init:Object = null)
Parameters
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties.
|
addOnError | () | method |
public function addOnError(listener:Function):void
Default method for adding a loaderror event listener
Parameterslistener:Function — The listener function
|
addOnSuccess | () | method |
public function addOnSuccess(listener:Function):void
Default method for adding a loadsuccess event listener
Parameterslistener:Function — The listener function
|
onComplete | () | method |
protected function onComplete(event:Event):void
Automatically fired on a complete event
Parametersevent:Event |
onError | () | method |
protected function onError(event:IOErrorEvent):void
Automatically fired on an error event.
Parametersevent:IOErrorEvent |
See also
onProgress | () | method |
protected function onProgress(event:ProgressEvent):void
Automatically fired on a progress event
Parametersevent:ProgressEvent |
removeOnError | () | method |
public function removeOnError(listener:Function):void
Default method for removing a loaderror event listener
Parameterslistener:Function — The listener function
|
removeOnSuccess | () | method |
public function removeOnSuccess(listener:Function):void
Default method for removing a loadsuccess event listener
Parameterslistener:Function — The listener function
|
loaderror | event |
away3d.events.LoaderEvent
Dispatched when the 3d object loader fails to load a file.
loadsuccess | event |
away3d.events.LoaderEvent
Dispatched when the 3d object loader completes a file load successfully.
LOADING_GEOMETRY | constant |
public const LOADING_GEOMETRY:String = "loading_geometry"
Constant value string representing the geometry loading mode of the 3d object loader.
LOADING_TEXTURES | constant |
public const LOADING_TEXTURES:String = "loading_textures"
Constant value string representing the texture loading mode of the 3d object loader.