Package | away3d.containers |
Class | public class ObjectContainer3D |
Inheritance | ObjectContainer3D ![]() ![]() |
Implements | IPrimitiveProvider |
Subclasses | DebugObjectContainer3D, LODObject, Object3DLoader, Scene3D, Trident |
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 [read-only]
Returns the bounding radius of the 3d object
| ObjectContainer3D | ||
children : Array [read-only]
Returns the children of the container as an array of 3d objects
| ObjectContainer3D | ||
![]() | 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 | |
![]() | inverseSceneTransform : Matrix3D | Object3D | |
maxX : Number [read-only]
Returns the maximum x value of the 3d object
| ObjectContainer3D | ||
maxY : Number [read-only]
Returns the maximum y value of the 3d object
| ObjectContainer3D | ||
maxZ : Number [read-only]
Returns the maximum z value of the 3d object
| ObjectContainer3D | ||
minX : Number [read-only]
Returns the minimum x value of the 3d object
| ObjectContainer3D | ||
minY : Number [read-only]
Returns the minimum y value of the 3d object
| ObjectContainer3D | ||
minZ : Number [read-only]
Returns the minimum z value of the 3d object
| ObjectContainer3D | ||
![]() | 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 | |
![]() | 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 | |
![]() | transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | 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 | ||
---|---|---|---|
ObjectContainer3D
(init:Object = null, ... childarray)
Creates a new
ObjectContainer3D object
| ObjectContainer3D | ||
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 | |
![]() |
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 | |
![]() |
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 | |
![]() |
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 | |
![]() |
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 |
boundingRadius | property |
boundingRadius:Number
[read-only]Returns the bounding radius of the 3d object
Implementation public function get boundingRadius():Number
children | property |
children:Array
[read-only]Returns the children of the container as an array of 3d objects
Implementation public function get children():Array
maxX | property |
maxX:Number
[read-only]Returns the maximum x value of the 3d object
Implementation public function get maxX():Number
maxY | property |
maxY:Number
[read-only]Returns the maximum y value of the 3d object
Implementation public function get maxY():Number
maxZ | property |
maxZ:Number
[read-only]Returns the maximum z value of the 3d object
Implementation public function get maxZ():Number
minX | property |
minX:Number
[read-only]Returns the minimum x value of the 3d object
Implementation public function get minX():Number
minY | property |
minY:Number
[read-only]Returns the minimum y value of the 3d object
Implementation public function get minY():Number
minZ | property |
minZ:Number
[read-only]Returns the minimum z value of the 3d object
Implementation public function get minZ():Number
ObjectContainer3D | () | constructor |
public function ObjectContainer3D(init:Object = null, ... childarray)
Parameters
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties
|
|
... childarray — An array of 3d objects to be added as children of the container on instatiation
|
addChild | () | method |
public function addChild(child:Object3D):void
Adds a 3d object to the scene as a child of the container
Parameterschild:Object3D — The 3d object to be added
|
— ObjectContainer3D.addChild(null)
|
addChildren | () | method |
public function addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
Parameters... childarray — An array of 3d objects to be added
|
clone | () | method |
public override function clone(object:* = null):*
Duplicates the 3d object's properties to another ObjectContainer3D
object
object:* (default = null ) — [optional] The new object instance into which all properties are copied
|
* — The new object instance with duplicated properties applied
|
getChildByName | () | method |
public function getChildByName(name:String):Object3D
Returns a 3d object specified by name from the child array of the container
Parametersname:String — The name of the 3d object to be returned
|
Object3D —
The 3d object, or null if no such child object exists with the specified name
|
movePivot | () | method |
public function movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
Parametersdx:Number — The amount of movement along the local x axis
|
|
dy:Number — The amount of movement along the local y axis
|
|
dz:Number — The amount of movement along the local z axis
|
removeChild | () | method |
public function removeChild(child:Object3D):void
Removes a 3d object from the child array of the container
Parameterschild:Object3D — The 3d object to be removed
|
— ObjectContainer3D.removeChild(null)
|
removeChildByName | () | method |
public function removeChildByName(name:String):void
Removes a 3d object from the child array of the container
Parametersname:String — The name of the 3d object to be removed
|
scale | () | method |
public override function scale(scale:Number):void
Scales the contents of the 3d object.
Parametersscale:Number — The scaling value
|
traverse | () | method |
public override function traverse(traverser:Traverser):void
Used when traversing the scenegraph
Parameterstraverser:Traverser — The traverser object
|