Package | away3d.containers |
Class | public class ObjectContainer3D |
Inheritance | ObjectContainer3D ![]() ![]() ![]() |
Subclasses | Bone, BSPTree, 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 | |
![]() | back : Material
Defines a triangle material to be used for the backface of all faces in the 3d object.
| Mesh | |
![]() | blendMode : String
An optional blend mode that can be applied to the 3d object.
| Object3D | |
![]() | bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
| Mesh | |
![]() | 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 | ||
![]() | collider : Boolean
Indicates whether this object is used for collision detection.
| Object3D | |
![]() | 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 | |
![]() | elements : Array
Returns an array of all elements contained in the mesh object.
| Mesh | |
![]() | 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 | |
![]() | faces : Array
Returns an array of the faces contained in the mesh object.
| Mesh | |
![]() | faceVOs : Array
Returns an array of the faceVOs contained in the mesh object.
| Mesh | |
![]() | filters : Array
An optional array of filters that can be applied to the 3d object.
| Object3D | |
![]() | geometry : Geometry
Defines the geometry object used for the mesh.
| Mesh | |
![]() | geometryLibrary : GeometryLibrary
Reference container for all geometries used in the container.
| Object3D | |
![]() | id : int | Object3D | |
![]() | indexes : Array
Placeholder for md2 frame indexes
| Mesh | |
![]() | indices : Array
Returns an array of the indices contained in the mesh object.
| Mesh | |
![]() | inverseSceneTransform : MatrixAway3D
Returns the inverse of sceneTransform.
| Object3D | |
![]() | material : Material
Defines the material used to render the faces, segments or 3d sprites in the geometry object.
| Mesh | |
![]() | 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 | |
![]() | outline : Material
Defines a segment material to be used for outlining the 3d object.
| Mesh | |
![]() | ownCanvas : Boolean
Defines whether the contents of the 3d object are rendered using it's own render session
| Object3D | |
![]() | ownSession : AbstractSession
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 | |
polyCount : int [read-only]
Returns the number of elements in the container,
including elements in child nodes.
| ObjectContainer3D | ||
![]() | position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | 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 : Renderer
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 | |
![]() | 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 | |
![]() | segments : Array
Returns an array of the segments contained in the mesh object.
| Mesh | |
![]() | segmentVOs : Array
Returns an array of the segmentVOs contained in the mesh object.
| Mesh | |
![]() | session : AbstractSession
The render session used by the 3d object
| Object3D | |
![]() | sprites : Array
Returns an array of the 3d sprites contained in the mesh object.
| Mesh | |
![]() | spriteVOs : Array
Returns an array of the spriteVOs contained in the mesh object.
| Mesh | |
![]() | startIndices : Array
Returns an array of the start indices contained in the mesh object.
| Mesh | |
![]() | transform : MatrixAway3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | type : String = "mesh"
String defining the type of class used to generate the mesh.
| Mesh | |
![]() | url : String
String defining the source of the mesh.
| Mesh | |
![]() | useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
| Object3D | |
![]() | vertices : Array
Returns an array of the vertices contained in the mesh object.
| Mesh | |
![]() | 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 | ||
![]() |
Adds a face object to the mesh object.
| Mesh | |
Adds a light as a child 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 | |
![]() |
addOnPositionChange(listener:Function):void
Default method for adding a positionchanged 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 | |
![]() |
addOnScaleChange(listener:Function):void
Default method for adding a scalechanged 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 | |
![]() |
addOnVisibilityUpdate(listener:Function):void
Default method for adding a visibilityUpdated event listener
| Object3D | |
![]() |
Adds a segment object to the mesh object.
| Mesh | |
![]() |
Adds a sprite3d object to the mesh object.
| Mesh | |
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 | ||
![]() |
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
| Mesh | |
![]() |
asXML():XML
Returns an xml representation of the mesh
| Mesh | |
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 | ||
![]() |
invertFaces():void
Inverts the geometry of all face objects.
| Mesh | |
![]() |
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 | |
![]() |
Divides a face object into 4 equal sized face objects.
| Mesh | |
![]() |
quarterFaces():void
Divides all faces objects of a Mesh into 4 equal sized face objects.
| Mesh | |
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 | ||
![]() |
Removes a face object from the mesh object.
| Mesh | |
Removes a light from 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 | |
![]() |
removeOnPositionChange(listener:Function):void
Default method for removing a positionchanged 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 | |
![]() |
removeOnScaleChange(listener:Function):void
Default method for removing a scalechanged 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 | |
![]() |
removeOnVisibilityUpdate(listener:Function):void
Default method for removing a visibilityUpdated event listener
| Object3D | |
![]() |
Removes a segment object from the mesh object.
| Mesh | |
![]() |
Removes a 3d sprite object from the mesh object.
| Mesh | |
![]() |
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 | |
![]() |
Divides a face object into 2 face objects.
| Mesh | |
![]() |
splitFaces(side:int = 0):void
Divides all faces objects of a Mesh into 2 face objects.
| Mesh | |
![]() |
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 | ||
![]() |
Divides a face object into 3 face objects.
| Mesh | |
![]() |
triFaces():void
Divides all faces objects of a Mesh into 3 face objects.
| Mesh | |
![]() |
updateBounds():void
| Mesh | |
![]() |
Updates the materials in the mesh object
| Mesh | |
![]() |
update vertex information.
| Mesh | |
![]() |
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
polyCount | property |
polyCount:int
[read-only]Returns the number of elements in the container, including elements in child nodes. Elements can be faces, segments or 3d sprites.
Implementation public function get polyCount():int
ObjectContainer3D | () | constructor |
public function ObjectContainer3D(... initarray)
Parameters
... 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
|
addLight | () | method |
public function addLight(light:AbstractLight):void
Adds a light as a child of the container
Parameterslight:AbstractLight — The light object to be added
|
— ObjectContainer3D.addLight(null)
|
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 override 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
|
removeLight | () | method |
public function removeLight(light:AbstractLight):void
Removes a light from the container
Parameterslight:AbstractLight — The light object to be removed
|
— ObjectContainer3D.removeLight(null)
|
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