| Package | away3d.containers |
| Class | public class ObjectContainer3D |
| Inheritance | ObjectContainer3D  Object3D flash.events.EventDispatcher |
| Subclasses | Entity, Sound3D, TextureProjector |
| Package | away3d.containers |
| Class | public class ObjectContainer3D |
| Inheritance | ObjectContainer3D Object3D flash.events.EventDispatcher |
| Subclasses | Entity, Sound3D, TextureProjector |
| Property | Defined by | ||
|---|---|---|---|
 | eulers : Vector3D
Defines the rotation of the 3d object as a
Vector3D object containing euler angles for rotation around x, y and z axis. | Object3D | |
| extra : Object
An object that can contain any extra data.
| Object3D | |
| inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space.
| ObjectContainer3D | ||
| maxX : Number [read-only]
The maximum extremum of the object along the X-axis.
| ObjectContainer3D | ||
| maxY : Number [read-only]
The maximum extremum of the object along the Y-axis.
| ObjectContainer3D | ||
| maxZ : Number [read-only]
The maximum extremum of the object along the Z-axis.
| ObjectContainer3D | ||
| minX : Number [read-only]
The minimum extremum of the object along the X-axis.
| ObjectContainer3D | ||
| minY : Number [read-only]
The minimum extremum of the object along the Y-axis.
| ObjectContainer3D | ||
| minZ : Number [read-only]
The minimum extremum of the object along the Z-axis.
| ObjectContainer3D | ||
| name : String
The name of the object.
| Object3D | |
| numChildren : uint [read-only]
The amount of child objects of the ObjectContainer3D.
| ObjectContainer3D | ||
| parent : ObjectContainer3D
The parent ObjectContainer3D to which this object's transformation is relative.
| ObjectContainer3D | ||
| partition : 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 | ||
| pivotPoint : Vector3D
Defines the local point around which the object rotates.
| Object3D | |
| position : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D. | 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 | |
| scenePosition : Vector3D [read-only]
The global position of the ObjectContainer3D in the scene.
| ObjectContainer3D | ||
| sceneTransform : Matrix3D [read-only]
The transformation matrix that transforms from model to world space.
| ObjectContainer3D | ||
| transform : Matrix3D [write-only]
The local transformation matrix that transforms to the parent object's space.
| ObjectContainer3D | ||
| 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 | |
| Property | Defined by | ||
|---|---|---|---|
| _explicitPartition : Partition3D | ObjectContainer3D | ||
| _implicitPartition : Partition3D | ObjectContainer3D | ||
| _parent : ObjectContainer3D | ObjectContainer3D | ||
| _pivotPoint : Vector3D | Object3D | |
| _pivotZero : Boolean = true | Object3D | |
| _pos : Vector3D
A calculation placeholder.
| Object3D | |
| _scaleX : Number = 1 | Object3D | |
| _scaleY : Number = 1 | Object3D | |
| _scaleZ : Number = 1 | Object3D | |
| _scene : Scene3D | ObjectContainer3D | ||
| _sceneTransform : Matrix3D | ObjectContainer3D | ||
| _sceneTransformDirty : Boolean = true | ObjectContainer3D | ||
| _transform : Matrix3D | Object3D | |
| _x : Number = 0 | Object3D | |
| _y : Number = 0 | Object3D | |
| _z : Number = 0 | Object3D | |
| Method | Defined by | ||
|---|---|---|---|
|
Creates a new ObjectContainer3D object.
| ObjectContainer3D | ||
|
Adds a child ObjectContainer3D to the current object.
| ObjectContainer3D | ||
|
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
| ObjectContainer3D | ||
| Object3D | ||
|
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
| ObjectContainer3D | ||
|
Retrieves the child object at the given index.
| ObjectContainer3D | ||
|
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. | ObjectContainer3D | ||
|
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 | ||
|
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
|
rotate(axis:Vector3D, angle:Number):void
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(value:Number):void
Appends a uniform scale to the current transformation.
| Object3D | |
|
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | |
|
translateLocal(axis:Vector3D, distance:Number):void
| ObjectContainer3D | ||
|
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D | |
| Method | Defined by | ||
|---|---|---|---|
|
invalidateSceneTransform():void
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
| ObjectContainer3D | ||
|
invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
| ObjectContainer3D | ||
|
updateSceneTransform():void
Updates the scene transformation matrix.
| ObjectContainer3D | ||
|
updateTransform():void
| Object3D | |
| _explicitPartition | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _explicitPartition:Partition3D
| _implicitPartition | property |
protected var _implicitPartition:Partition3D
| implicitPartition | property |
implicitPartition:Partition3D [read-write]The space partition used for this object, possibly inherited from its parent.
Implementation arcane function get implicitPartition():Partition3D
arcane function set implicitPartition(value:Partition3D):void
| inverseSceneTransform | property |
inverseSceneTransform:Matrix3D [read-only]The inverse scene transform object that transforms from world to model space.
Implementation public function get inverseSceneTransform():Matrix3D
| maxX | property |
maxX:Number [read-only]The maximum extremum of the object along the X-axis.
Implementation public function get maxX():Number
| maxY | property |
maxY:Number [read-only]The maximum extremum of the object along the Y-axis.
Implementation public function get maxY():Number
| maxZ | property |
maxZ:Number [read-only]The maximum extremum of the object along the Z-axis.
Implementation public function get maxZ():Number
| minX | property |
minX:Number [read-only]The minimum extremum of the object along the X-axis.
Implementation public function get minX():Number
| minY | property |
minY:Number [read-only]The minimum extremum of the object along the Y-axis.
Implementation public function get minY():Number
| minZ | property |
minZ:Number [read-only]The minimum extremum of the object along the Z-axis.
Implementation public function get minZ():Number
| numChildren | property |
numChildren:uint [read-only]The amount of child objects of the ObjectContainer3D.
Implementation public function get numChildren():uint
| _parent | property |
protected var _parent:ObjectContainer3D
| parent | property |
parent:ObjectContainer3D [read-write]The parent ObjectContainer3D to which this object's transformation is relative.
Implementation public function get parent():ObjectContainer3D
public function set parent(value:ObjectContainer3D):void
| partition | property |
partition:Partition3D [read-write]The space partition to be used by the object container and all its recursive children, unless it has its own space partition assigned.
Implementation public function get partition():Partition3D
public function set partition(value:Partition3D):void
| _scene | property |
protected var _scene:Scene3D
| scene | property |
scene:Scene3D [read-write]A reference to the Scene3D object to which this object belongs.
Implementation arcane function get scene():Scene3D
arcane function set scene(value:Scene3D):void
| scenePosition | property |
scenePosition:Vector3D [read-only]The global position of the ObjectContainer3D in the scene.
Implementation public function get scenePosition():Vector3D
| _sceneTransform | property |
protected var _sceneTransform:Matrix3D
| sceneTransform | property |
sceneTransform:Matrix3D [read-only]The transformation matrix that transforms from model to world space.
Implementation public function get sceneTransform():Matrix3D
| _sceneTransformDirty | property |
protected var _sceneTransformDirty:Boolean = true
| transform | property |
transform:Matrix3D [write-only]The local transformation matrix that transforms to the parent object's space.
Implementation public function set transform(value:Matrix3D):void
| ObjectContainer3D | () | constructor |
public function ObjectContainer3D()
Init Parameters
| addChild | () | method |
public function addChild(child:ObjectContainer3D):ObjectContainer3D
Adds a child ObjectContainer3D to the current object. The child's transformation will become relative to the current object's transformation.
Parameterschild:ObjectContainer3D — The object to be added as a child.
|
ObjectContainer3D —
A reference to the added child object.
|
| 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
|
| dispose | () | method |
public override function dispose(deep:Boolean):void
Cleans up any resources used by the current object.
Parametersdeep:Boolean — Indicates whether other resources should be cleaned up, that could potentially be shared across different instances.
|
| getChildAt | () | method |
public function getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index.
Parametersindex:uint — The index of the object to be retrieved.
|
ObjectContainer3D —
The child object at the given index.
|
| invalidateSceneTransform | () | method |
protected function invalidateSceneTransform():void
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
| invalidateTransform | () | method |
protected override function invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
| lookAt | () | method |
public override function 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.
target:Vector3D — The vector defining the point to be looked at
|
|
upAxis:Vector3D (default = null) |
| removeChild | () | method |
public function removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
Parameterschild:ObjectContainer3D — The 3d object to be removed
|
|
| translateLocal | () | method |
public override function translateLocal(axis:Vector3D, distance:Number):void
Parameters
axis:Vector3D |
|
distance:Number |
| updateSceneTransform | () | method |
protected function updateSceneTransform():void
Updates the scene transformation matrix.