Package | away3d.containers |
Class | public class ObjectContainer3D |
Inheritance | ObjectContainer3D ![]() ![]() ![]() |
Implements | IAsset |
Subclasses | Entity, Loader3D, Sound3D, TextureProjector |
Property | Defined By | ||
---|---|---|---|
![]() | assetFullPath : Array [read-only] | NamedAssetBase | |
![]() | assetNamespace : String [read-only] | NamedAssetBase | |
assetType : String [read-only] | ObjectContainer3D | ||
![]() | backVector : Vector3D [read-only]
| Object3D | |
![]() | downVector : Vector3D [read-only]
| Object3D | |
![]() | 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 | |
![]() | forwardVector : Vector3D [read-only]
| Object3D | |
ignoreTransform : Boolean
Does not apply any transformations to this object. | ObjectContainer3D | ||
inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space. | ObjectContainer3D | ||
![]() | leftVector : Vector3D [read-only]
| Object3D | |
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 | ||
mouseChildren : Boolean | ObjectContainer3D | ||
mouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing. | ObjectContainer3D | ||
![]() | name : String | NamedAssetBase | |
numChildren : uint [read-only]
The amount of child objects of the ObjectContainer3D. | ObjectContainer3D | ||
![]() | originalName : String [read-only]
The original name used for this asset in the resource (e.g. | NamedAssetBase | |
parent : ObjectContainer3D [read-only]
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 | |
![]() | rightVector : Vector3D [read-only]
| 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
A reference to the Scene3D object to which this object belongs. | ObjectContainer3D | ||
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
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
![]() | upVector : Vector3D [read-only]
| Object3D | |
visible : Boolean | 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 | ||
_ignoreTransform : Boolean = false | ObjectContainer3D | ||
_implicitPartition : Partition3D | ObjectContainer3D | ||
_mouseEnabled : Boolean | ObjectContainer3D | ||
_parent : ObjectContainer3D | ObjectContainer3D | ||
![]() | _pivotPoint : Vector3D | Object3D | |
![]() | _pivotZero : Boolean = true | Object3D | |
![]() | _pos : Vector3D | Object3D | |
![]() | _rot : Vector3D | Object3D | |
![]() | _sca : Vector3D | 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 | |
![]() | _transformComponents : Vector.<Vector3D> | 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 | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] | ObjectContainer3D | ||
![]() | assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | |
[override]
Clones this ObjectContainer3D instance along with all it's children, and
returns the result (which will be a copy of this container, containing copies
of all it's children.)
| ObjectContainer3D | ||
contains(child:ObjectContainer3D):Boolean | ObjectContainer3D | ||
dispatchEvent(event:Event):Boolean [override]
| ObjectContainer3D | ||
dispose():void [override]
Cleans up resources used by this asset. | ObjectContainer3D | ||
![]() | disposeAsset():void | Object3D | |
getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index. | ObjectContainer3D | ||
lookAt(target:Vector3D, upAxis:Vector3D = null):void [override]
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 | |
removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override] | ObjectContainer3D | ||
![]() | resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase | |
![]() | roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
rotate(axis:Vector3D, angle:Number):void [override] | ObjectContainer3D | ||
![]() | 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 [override] | ObjectContainer3D | ||
updateImplicitVisibility():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 | ||
updateMouseChildren():void | ObjectContainer3D | ||
updateSceneTransform():void
Updates the scene transformation matrix. | ObjectContainer3D | ||
![]() | updateTransform():void | Object3D |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object. | ObjectContainer3D | |||
Dispatched when a user moves the cursor while it is over the 3d object. | ObjectContainer3D | |||
Dispatched when a user moves the cursor away from the 3d object. | ObjectContainer3D | |||
Dispatched when a user moves the cursor over the 3d object. | ObjectContainer3D | |||
Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object. | ObjectContainer3D | |||
![]() | Dispatched when the position of the 3d object changes. | Object3D | ||
![]() | Dispatched when the rotation of the 3d object changes. | Object3D | ||
![]() | Dispatched when the scale of the 3d object changes. | Object3D | ||
Dispatched when the parent scene of the 3d object changes. | ObjectContainer3D | |||
Dispatched when the scene transform matrix of the 3d object changes. | ObjectContainer3D |
_explicitPartition | property |
protected var _explicitPartition:Partition3D
_ignoreTransform | property |
protected var _ignoreTransform:Boolean = false
_implicitPartition | property |
protected var _implicitPartition:Partition3D
_isRoot | property |
arcane var _isRoot:Boolean
_mouseEnabled | property |
protected var _mouseEnabled:Boolean
_parent | property |
protected var _parent:ObjectContainer3D
_scene | property |
protected var _scene:Scene3D
_sceneTransform | property |
protected var _sceneTransform:Matrix3D
_sceneTransformDirty | property |
protected var _sceneTransformDirty:Boolean = true
assetType | property |
assetType:String
[read-only] public function get assetType():String
ignoreTransform | property |
ignoreTransform:Boolean
Does not apply any transformations to this object. Allows static objects to be described in world coordinates without any matrix calculations.
public function get ignoreTransform():Boolean
public function set ignoreTransform(value:Boolean):void
implicitPartition | property |
implicitPartition:Partition3D
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.
public function get inverseSceneTransform():Matrix3D
maxX | property |
maxX:Number
[read-only] The maximum extremum of the object along the X-axis.
public function get maxX():Number
maxY | property |
maxY:Number
[read-only] The maximum extremum of the object along the Y-axis.
public function get maxY():Number
maxZ | property |
maxZ:Number
[read-only] The maximum extremum of the object along the Z-axis.
public function get maxZ():Number
minX | property |
minX:Number
[read-only] The minimum extremum of the object along the X-axis.
public function get minX():Number
minY | property |
minY:Number
[read-only] The minimum extremum of the object along the Y-axis.
public function get minY():Number
minZ | property |
minZ:Number
[read-only] The minimum extremum of the object along the Z-axis.
public function get minZ():Number
mouseChildren | property |
mouseChildren:Boolean
public function get mouseChildren():Boolean
public function set mouseChildren(value:Boolean):void
mouseEnabled | property |
mouseEnabled:Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
public function get mouseEnabled():Boolean
public function set mouseEnabled(value:Boolean):void
numChildren | property |
numChildren:uint
[read-only] The amount of child objects of the ObjectContainer3D.
public function get numChildren():uint
parent | property |
parent:ObjectContainer3D
[read-only] The parent ObjectContainer3D to which this object's transformation is relative.
public function get parent():ObjectContainer3D
partition | property |
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.
public function get partition():Partition3D
public function set partition(value:Partition3D):void
scene | property |
scene:Scene3D
A reference to the Scene3D object to which this object belongs.
public function get scene():Scene3D
public function set scene(value:Scene3D):void
scenePosition | property |
scenePosition:Vector3D
[read-only] The global position of the ObjectContainer3D in the scene.
public function get scenePosition():Vector3D
sceneTransform | property |
sceneTransform:Matrix3D
[read-only] The transformation matrix that transforms from model to world space.
public function get sceneTransform():Matrix3D
visible | property |
visible:Boolean
public function get visible():Boolean
public function set visible(value:Boolean):void
ObjectContainer3D | () | Constructor |
public function ObjectContainer3D()
Creates a new ObjectContainer3D object.
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.
Parameters
child: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
|
addEventListener | () | method |
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false )
| |
priority:int (default = 0 )
| |
useWeakReference:Boolean (default = false )
|
clone | () | method |
override public function clone():Object3D
Clones this ObjectContainer3D instance along with all it's children, and returns the result (which will be a copy of this container, containing copies of all it's children.)
ReturnsObject3D |
contains | () | method |
public function contains(child:ObjectContainer3D):Boolean
Parameters
child:ObjectContainer3D |
Boolean |
dispatchEvent | () | method |
override public function dispatchEvent(event:Event):Boolean
Parameters
event:Event |
Boolean |
dispose | () | method |
override public function dispose():void
Cleans up resources used by this asset.
getChildAt | () | method |
public function getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index.
Parameters
index: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 |
override arcane function invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
lookAt | () | method |
override public 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
.
Parameters
target:Vector3D — The vector defining the point to be looked at
| |
upAxis:Vector3D (default = null ) — An optional vector used to define the desired up orientation of the 3d object after rotation has occurred
|
removeChild | () | method |
public function removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
Parameters
child:ObjectContainer3D — The 3d object to be removed
|
Error ObjectContainer3D:removeChild(null)
|
removeEventListener | () | method |
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false )
|
rotate | () | method |
override public function rotate(axis:Vector3D, angle:Number):void
Parameters
axis:Vector3D | |
angle:Number |
translateLocal | () | method |
override public function translateLocal(axis:Vector3D, distance:Number):void
Parameters
axis:Vector3D | |
distance:Number |
updateImplicitVisibility | () | method |
public function updateImplicitVisibility():void
updateMouseChildren | () | method |
protected function updateMouseChildren():void
updateSceneTransform | () | method |
protected function updateSceneTransform():void
Updates the scene transformation matrix.
mouseDown3d | Event |
away3d.events.MouseEvent3D
away3d.events.MouseEvent3D
Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.
mouseMove3d | Event |
away3d.events.MouseEvent3D
away3d.events.MouseEvent3D
Dispatched when a user moves the cursor while it is over the 3d object.
mouseOut3d | Event |
away3d.events.MouseEvent3D
away3d.events.MouseEvent3D
Dispatched when a user moves the cursor away from the 3d object.
mouseOver3d | Event |
away3d.events.MouseEvent3D
away3d.events.MouseEvent3D
Dispatched when a user moves the cursor over the 3d object.
mouseUp3d | Event |
away3d.events.MouseEvent3D
away3d.events.MouseEvent3D
Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.
sceneChanged | Event |
away3d.events.Object3DEvent
away3d.events.Object3DEvent
Dispatched when the parent scene of the 3d object changes.
See also
scenetransformChanged | Event |
away3d.events.Object3DEvent
away3d.events.Object3DEvent
Dispatched when the scene transform matrix of the 3d object changes.
See also