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 | |
![]() | animationLibrary : AnimationLibrary
Reference container for all animations used in the container.
| 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
| Object3D | |
![]() | center : Vertex | Object3D | |
![]() | 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 | ||
![]() | debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
| Object3D | |
![]() | debugBoundingBox : WireCube | Object3D | |
![]() | debugBoundingSphere : WireSphere | Object3D | |
![]() | debugbs : Boolean
Indicates whether a debug bounding sphere should be rendered around the 3d object.
| Object3D | |
![]() | eulers : Number3D
Defines the rotation of the 3d object as a
Number3D object containing euler angles for rotation around x, y and z axis. | Object3D | |
![]() | 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 | |
![]() | geometryLibrary : GeometryLibrary
Reference container for all geometries used in the container.
| Object3D | |
handle : Object3D
[read-only]
Returns a 3d object relating to the currently visible model.
| Object3DLoader | ||
![]() | inverseSceneTransform : MatrixAway3D
Returns the inverse of sceneTransform.
| Object3D | |
![]() | lightarray : ILightConsumer
returns the array of lights contained inside the container.
| Object3D | |
![]() | materialLibrary : MaterialLibrary
Reference container for all materials used in the container.
| Object3D | |
![]() | maxX : Number
Returns the maximum x value of the 3d object
| Object3D | |
![]() | maxY : Number
Returns the maximum y value of the 3d object
| Object3D | |
![]() | maxZ : Number
Returns the maximum z value of the 3d object
| Object3D | |
![]() | minX : Number
Returns the minimum x value of the 3d object
| Object3D | |
![]() | minY : Number
Returns the minimum y value of the 3d object
| Object3D | |
![]() | minZ : Number
Returns the minimum z value of the 3d object
| Object3D | |
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 | |
![]() | objectDepth : Number
Boundary depth of the 3d object
return The depth of the mesh
| Object3D | |
![]() | objectHeight : Number
Boundary height of the 3d object
return The height of the mesh
| Object3D | |
![]() | objectWidth : Number
Boundary width of the 3d object
return The width of the object
| Object3D | |
![]() | ownCanvas : Boolean
Defines whether the contents of the 3d object are rendered using it's own render session
| Object3D | |
![]() | ownLights : Boolean
Defines whether the children of the container are rendered using it's own lights.
| Object3D | |
![]() | ownSession : AbstractRenderSession
Defines a unique render session for the 3d object.
| Object3D | |
![]() | parent : ObjectContainer3D
Defines the parent of the 3d object.
| Object3D | |
parser : AbstractParser | Object3DLoader | ||
parseTimeout : int
Defines a timeout period for file parsing (in milliseconds).
| Object3DLoader | ||
![]() | pivotPoint : Number3D
Defines the local point around which the object rotates.
| Object3D | |
![]() | pivotZero : Boolean | Object3D | |
![]() | position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | projectorType : String | Object3D | |
![]() | pushback : Boolean
Elements use their furthest point from the camera when z-sorting
| Object3D | |
![]() | pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
| Object3D | |
![]() | renderer : IPrimitiveConsumer
An optional renderer object that can be used to render the contents of the object.
| 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 | |
![]() | scaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
| Object3D | |
![]() | scaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
| Object3D | |
![]() | scaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
| Object3D | |
![]() | scene : Scene3D
Returns the parent scene of the 3d object
| Object3D | |
![]() | scenePivotPoint : Number3D | Object3D | |
![]() | scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the
Scene3D object. | Object3D | |
![]() | sceneTransform : MatrixAway3D
Returns the transformation of the 3d object, relative to the global coordinates of the
Scene3D object. | Object3D | |
![]() | screenZOffset : Number
Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true
| 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 : MatrixAway3D
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 | |
![]() | visible : Boolean
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 | |
![]() |
addOnParentUpdate(listener:Function):void
Default method for adding a parentupdated event listener
| Object3D | |
![]() |
addOnRollOut(listener:Function):void
Default method for adding a rollOut3D event listener
| Object3D | |
![]() |
addOnRollOver(listener:Function):void
Default method for adding a rollOver3D 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 | |
![]() |
addOnSessionChange(listener:Function):void
Default method for adding a sessionchanged 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 | |
![]() |
applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position to child objects without altering the appearance of the object container
| ObjectContainer3D | |
![]() |
applyRotations():void
Apply the local rotations to child objects without altering the appearance of the object container
| ObjectContainer3D | |
![]() |
centerPivot():void
| Object3D | |
![]() |
Duplicates the 3d object's properties to another
ObjectContainer3D object
| ObjectContainer3D | |
![]() |
Duplicates the 3d object's properties to another
ObjectContainer3D object, including bones and geometry
| ObjectContainer3D | |
![]() |
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
| Object3D | |
![]() |
Returns a bone object specified by name from the child array of the container
| ObjectContainer3D | |
![]() |
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 local point around which the object rotates.
| Object3D | |
![]() |
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
| Object3D | |
![]() |
moveTo(dx:Number, dy:Number, dz:Number):void
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 | |
![]() |
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 | |
![]() |
removeOnParentUpdate(listener:Function):void
Default method for removing a parentupdated event listener
| Object3D | |
![]() |
removeOnRollOut(listener:Function):void
Default method for removing a rollOut3D event listener
| Object3D | |
![]() |
removeOnRollOver(listener:Function):void
Default method for removing a rollOver3D 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 | |
![]() |
removeOnSessionChange(listener:Function):void
Default method for removing a sessionchanged 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 | |
![]() |
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
| Object3D | |
![]() |
scale(scale:Number):void
Scales the contents of the 3d object.
| Object3D | |
![]() |
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 | |
![]() |
updateObject():void
| Object3D | |
![]() |
updateSession():void
| Object3D | |
![]() |
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Method | Defined by | ||
---|---|---|---|
notifyError(event:Event):void
| Object3DLoader | ||
notifyProgress(event:Event):void
| Object3DLoader | ||
notifySuccess(event:Event):void
| Object3DLoader | ||
onGeometryComplete(event:Event):void
Automatically fired on a geometry complete event
| Object3DLoader | ||
onGeometryError(event:IOErrorEvent):void
Automatically fired on an geometry error event.
| Object3DLoader | ||
onGeometryProgress(event:ProgressEvent):void
Automatically fired on a geometry progress event
| Object3DLoader | ||
Automatically fired on a parser complete event
| Object3DLoader | ||
Automatically fired on an parser error event.
| Object3DLoader | ||
Automatically fired on a parser progress event
| Object3DLoader | ||
onTextureComplete(event:Event):void
Automatically fired on a texture complete event
| Object3DLoader | ||
onTextureError(event:IOErrorEvent):void
Automatically fired on an texture error event.
| Object3DLoader | ||
onTextureProgress(event:ProgressEvent):void
Automatically fired on a texture progress event
| Object3DLoader | ||
![]() |
updateDimensions():void
| ObjectContainer3D | |
![]() |
updateTransform():void
| Object3D |
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 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 | ||
![]() | 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 render session property of the 3d object changes. | Object3D | ||
![]() | Dispatched when the render session property of the 3d object updates its contents. | Object3D | ||
![]() | Dispatched when the local transform matrix of the 3d object changes. | Object3D |
Constant | Defined by | ||
---|---|---|---|
COMPLETE : String = "complete"
Constant value string representing a completed loader mode.
| Object3DLoader | ||
ERROR : String = "error"
Constant value string representing a problem loader mode.
| Object3DLoader | ||
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 | ||
PARSING_GEOMETRY : String = "parsing_geometry"
Constant value string representing the geometry parsing 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
mode | property |
public var mode:String
Returns the current loading mode of the 3d object loader.
parser | property |
public var parser:AbstractParser
parseTimeout | property |
public var parseTimeout:int
Defines a timeout period for file parsing (in milliseconds).
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.
|
parseTimeout:Number (default = 40000) |
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
|
notifyError | () | method |
protected function notifyError(event:Event):void
Parameters
event:Event |
notifyProgress | () | method |
protected function notifyProgress(event:Event):void
Parameters
event:Event |
notifySuccess | () | method |
protected function notifySuccess(event:Event):void
Parameters
event:Event |
onGeometryComplete | () | method |
protected function onGeometryComplete(event:Event):void
Automatically fired on a geometry complete event
Parametersevent:Event |
onGeometryError | () | method |
protected function onGeometryError(event:IOErrorEvent):void
Automatically fired on an geometry error event.
Parametersevent:IOErrorEvent |
See also
onGeometryProgress | () | method |
protected function onGeometryProgress(event:ProgressEvent):void
Automatically fired on a geometry progress event
Parametersevent:ProgressEvent |
onParserComplete | () | method |
protected function onParserComplete(event:ParserEvent):void
Automatically fired on a parser complete event
Parametersevent:ParserEvent |
onParserError | () | method |
protected function onParserError(event:ParserEvent):void
Automatically fired on an parser error event.
Parametersevent:ParserEvent |
See also
onParserProgress | () | method |
protected function onParserProgress(event:ParserEvent):void
Automatically fired on a parser progress event
Parametersevent:ParserEvent |
onTextureComplete | () | method |
protected function onTextureComplete(event:Event):void
Automatically fired on a texture complete event
Parametersevent:Event |
onTextureError | () | method |
protected function onTextureError(event:IOErrorEvent):void
Automatically fired on an texture error event.
Parametersevent:IOErrorEvent |
See also
onTextureProgress | () | method |
protected function onTextureProgress(event:ProgressEvent):void
Automatically fired on a texture 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.
COMPLETE | constant |
public const COMPLETE:String = "complete"
Constant value string representing a completed loader mode.
ERROR | constant |
public const ERROR:String = "error"
Constant value string representing a problem loader mode.
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.
PARSING_GEOMETRY | constant |
public const PARSING_GEOMETRY:String = "parsing_geometry"
Constant value string representing the geometry parsing mode of the 3d object loader.