| Package | away3d.containers |
| Class | public class ObjectContainer3D |
| Inheritance | ObjectContainer3D Object3D flash.events.EventDispatcher |
| Subclasses | Bone, Loader3D, LODObject, Scene3D, Trident |
| 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 : Array | Object3D | |
| children : Array [read-only]
Returns the children of the container as an array of 3d objects
| ObjectContainer3D | ||
![]() | 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 | |
![]() | id : int | Object3D | |
![]() | inverseSceneTransform : Matrix3D
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 | |
![]() | 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 | |
![]() | 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 : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the
Scene3D object. | Object3D | |
![]() | screenXOffset : Number
Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true
| Object3D | |
![]() | screenYOffset : Number
Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true
| 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 | |
![]() | 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 | |
![]() | 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 | ||
|---|---|---|---|
|
ObjectContainer3D
(... initarray)
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 | |
![]() |
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 | |
![]() |
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 | ||
|
centerMeshes():void
Adjusts each pivot point of the container object's children so that they lies at the center of each childs geoemtry.
| ObjectContainer3D | ||
|
centerPivot():void
Adjusts the pivot point of the object so that it lies at the center of it's geoemtry.
| ObjectContainer3D | ||
|
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 | |
![]() |
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 | |
![]() |
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 | ||
|---|---|---|---|
|
updateDimensions():void
| ObjectContainer3D | ||
![]() |
updateTransform():void
| Object3D | |
| children | property |
children:Array [read-only]Returns the children of the container as an array of 3d objects
Implementation public function get children():Array
| ObjectContainer3D | () | constructor |
public function ObjectContainer3D(... initarray)
... initarray — An array of 3d objects to be added as children of the container on instatiation. Can contain an initialisation object
|
| 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
|
| applyPosition | () | method |
public override function applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position to child objects without altering the appearance of the object container
Parametersdx:Number |
|
dy:Number |
|
dz:Number |
| applyRotations | () | method |
public override function applyRotations():void
Apply the local rotations to child objects without altering the appearance of the object container
| centerMeshes | () | method |
public function centerMeshes():void
Adjusts each pivot point of the container object's children so that they lies at the center of each childs geoemtry.
| centerPivot | () | method |
public override function centerPivot():void
Adjusts the pivot point of the object so that it lies at the center of it's geoemtry.
| clone | () | method |
public override function clone(object:Object3D = null):Object3D
Duplicates the 3d object's properties to another ObjectContainer3D object
object:Object3D (default = null) — [optional] The new object instance into which all properties are copied
|
Object3D —
The new object instance with duplicated properties applied
|
| cloneAll | () | method |
public function cloneAll(object:Object3D = null):Object3D
Duplicates the 3d object's properties to another ObjectContainer3D object, including bones and geometry
object:Object3D (default = null) — [optional] The new object instance into which all properties are copied
|
Object3D —
The new object instance with duplicated properties applied
|
| getBoneByName | () | method |
public function getBoneByName(boneName:String):Bone
Returns a bone object specified by name from the child array of the container
ParametersboneName:String — The name of the bone object to be returned
|
Bone —
The bone object, or null if no such bone object exists with the specified name
|
| getChildByName | () | method |
public function getChildByName(childName:String):Object3D
Returns a 3d object specified by name from the child array of the container
ParameterschildName: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
|
| 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
|
| traverse | () | method |
public override function traverse(traverser:Traverser):void
Used when traversing the scenegraph
Parameterstraverser:Traverser — The traverser object
|
| updateDimensions | () | method |
protected override function updateDimensions():void
Using ObjectContainer3D (groups) based on V1.9.2
groupA=new ObjectContainer3D(objA,objB,objC); //adds three objects to one group
*Lesson_Basic_04_Containers.fla based on V1.9.2
// import core library
import away3d.core.scene.*;
// import geometry primitives
import away3d.objects.*;
// create a 3D-viewport
var view:View3D = new View3D({x:300, y:200});
// add viewport to the stage
addChild(view);
// create carousel elements
var plane:Object3D = new RegularPolygon({material:"grey#white", radius:500, y:-100, pushback:true});
var sphere1:Object3D = new Sphere({material:"blue#cyan", radius:50, y:75});
var sphere2:Object3D = new Sphere({material:"blue.jpg", radius:50, y:-75});
var cube1:Object3D = new Cube({material:"green#lime", y:75});
var cube2:Object3D = new Cube({material:"green.jpg", y:-75});
var spheres:Object3D = new ObjectContainer3D({x:400}, sphere1, sphere2);
var cubes:Object3D = new ObjectContainer3D({x:-400}, cube1, cube2);
var torus1:Object3D = new Torus({material:"red.jpg", z:-400});
var torus2:Object3D = new Torus({material:"yellow.jpg", z:400});
// create carousel of the elements
var carousel:Object3D = new ObjectContainer3D(spheres, cubes, torus1, torus2, plane);
// add carousel to the scene
view.scene.addChild(carousel);
// every frame
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
// rotate carousel
carousel.rotationY = getTimer() / 100;
// rotate pairs
spheres.rotationZ = getTimer() / 10;
cubes.rotationX = getTimer() / 10;
// lift tori
torus1.y = Math.sin(getTimer() / 1000) * 50;
torus2.y = Math.cos(getTimer() / 1000) * 50;
// rerender viewport
view.render();
}From Lesson_Basic_04_Containers.fla