Packageaway3dlite.containers
Classpublic class ObjectContainer3D
InheritanceObjectContainer3D Inheritance Mesh Inheritance Object3D Inheritance flash.display.Sprite
SubclassesBone, Loader3D, Scene3D, Trident

3d object container node for other 3d objects in a scene.

Public Properties
 PropertyDefined by
 InheritedanimationLibrary : AnimationLibrary
Used in the loaders to store all parsed animation data contained in the model.
Object3D
 Inheritedbothsides : Boolean
Determines whether the faces in teh mesh are visible on both sides (true) or just the front side (false).
Mesh
  children : Array
[read-only] Returns the children of the container as an array of 3d objects.
ObjectContainer3D
 Inheritedfaces : Vector
Returns the faces used in the mesh.
Mesh
 InheritedgeometryLibrary : GeometryLibrary
Used in loaders to store all parsed geometry data contained in the model.
Object3D
 Inheritedlayer : Sprite
An optional layer sprite used to draw into inseatd of the default view.
Object3D
  lights : Vector
[read-only] Returns the lights of the container as an array of 3d lights.
ObjectContainer3D
 Inheritedmaterial : Material
Determines the global material used on the faces in the mesh.
Mesh
 InheritedmaterialLibrary : MaterialLibrary
Used in loaders to store all parsed materials contained in the model.
Object3D
 InheritedmaxPersp : Number = 0
The maximum perspective value from which the 3d object can be viewed.
Object3D
 InheritedminPersp : Number = 0
The minimum perspective value from which the 3d object can be viewed.
Object3D
 Inheritedposition : Vector3D
Returns a 3d vector representing the local position of the 3d object.
Object3D
 Inheritedscene : Scene3D
Returns the scene to which the 3d object belongs
Object3D
 InheritedsceneMatrix3D : Matrix3D
Returns a 3d matrix representing the absolute transformation of the 3d object in the scene.
Object3D
 InheritedscreenZ : Number
Returns the z-sorting position of the 3d object.
Object3D
 InheritedsortFaces : Boolean = true
Determines if the faces in the mesh are sorted.
Mesh
 InheritedsortType : String
Determines by which mechanism vertices are sorted.
Mesh
  sprites : Vector
[read-only] Returns the sprites of the container as an array of 3d sprites.
ObjectContainer3D
 Inheritedtype : String
Returns the type of 3d object.
Object3D
 Inheritedurl : String
Returns the source url of the 3d object, or the name of the family of generative geometry objects if not loaded from an external source.
Object3D
  vectorsFixed : Boolean
[write-only] lock or unlock vectors when adding or removing sprites
ObjectContainer3D
  vertices : Vector
[read-only] Returns the 3d vertices used in the mesh.
ObjectContainer3D
 InheritedviewMatrix3D : Matrix3D
Returns a 3d matrix representing the absolute transformation of the 3d object in the view.
Object3D
Protected Properties
 PropertyDefined by
 Inherited_vertexNormals : Vector
Mesh
Public Methods
 MethodDefined by
  
ObjectContainer3D
(... childArray)
Creates a new ObjectContainer3D object.
ObjectContainer3D
  
addChild(child:DisplayObject):DisplayObject
Adds a 3d object to the scene as a child of the container.
ObjectContainer3D
 Inherited
addFace(vs:Vector, uvs:Vector):void
Mesh
  
Adds a 3d light to the lights array of the container.
ObjectContainer3D
  
Adds a 3d sprite to the scene as a child of the container.
ObjectContainer3D
  
clone(object:Object3D = null):Object3D
Duplicates the 3d object's properties to another ObjectContainer3D object
ObjectContainer3D
  
getBoneByName(boneName:String):Bone
Returns a bone object specified by name from the child array of the container
ObjectContainer3D
  
getChildByName(childName:String):DisplayObject
Returns a 3d object specified by name from the child array of the container
ObjectContainer3D
 Inherited
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.
Object3D
 Inherited
moveBackward(distance:Number):void
Moves the 3D object backwards along it's local z axis
Object3D
 Inherited
moveDown(distance:Number):void
Moves the 3D object backwards along it's local y axis
Object3D
 Inherited
moveForward(distance:Number):void
Moves the 3D object forwards along it's local z axis
Object3D
 Inherited
moveLeft(distance:Number):void
Moves the 3D object backwards along it's local x axis
Object3D
 Inherited
moveRight(distance:Number):void
Moves the 3D object forwards along it's local x axis
Object3D
 Inherited
moveUp(distance:Number):void
Moves the 3D object forwards along it's local y axis
Object3D
 Inherited
pitch(degrees:Number):void
Rotates the 3D object around it's local x-axis
Object3D
 Inherited
pushV3D(v:Vector3D, uv:Point):void
Mesh
  
removeChild(child:DisplayObject):DisplayObject
Removes a 3d object from the child array of the container.
ObjectContainer3D
  
Removes a 3d light from the lights array of the container.
ObjectContainer3D
  
Removes a 3d sprite from the sprites array of the container.
ObjectContainer3D
 Inherited
roll(degrees:Number):void
Rotates the 3D object around it's local z-axis
Object3D
 Inherited
rotate(degrees:Number, axis:Vector3D, pivotPoint:Vector3D = null):void
Rotates the 3D object around an axis by a defined degrees
Object3D
 Inherited
translate(axis:Vector3D, distance:Number):void
Moves the 3D object along a vector by a defined length
Object3D
 Inherited
yaw(degrees:Number):void
Rotates the 3D object around it's local y-axis
Object3D
Protected Methods
 MethodDefined by
 Inherited
copyMatrix3D(m1:Matrix3D, m2:Matrix3D):void
Object3D
Events
 EventSummaryDefined by
 Inherited Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor while it is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor away from the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor over the 3d object.Object3D
 Inherited Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user rolls out of the 3d object.Object3D
 Inherited Dispatched when a user rolls over the 3d object.Object3D
Property detail
childrenproperty
children:Array  [read-only]

Returns the children of the container as an array of 3d objects.

Implementation
    public function get children():Array
lightsproperty 
lights:Vector  [read-only]

Returns the lights of the container as an array of 3d lights.

Implementation
    public function get lights():Vector
spritesproperty 
sprites:Vector  [read-only]

Returns the sprites of the container as an array of 3d sprites.

Implementation
    public function get sprites():Vector
vectorsFixedproperty 
vectorsFixed:Boolean  [write-only]

lock or unlock vectors when adding or removing sprites

Implementation
    public function set vectorsFixed(value:Boolean):void
verticesproperty 
vertices:Vector  [read-only]

Returns the 3d vertices used in the mesh.

Implementation
    public function get vertices():Vector
Constructor detail
ObjectContainer3D()constructor
public function ObjectContainer3D(... childArray)Parameters
... childArray — An array of 3d objects to be added as children of the container on instatiation.
Init Parameters
Method detail
addChild()method
public override function addChild(child:DisplayObject):DisplayObject

Adds a 3d object to the scene as a child of the container.

Parameters
child:DisplayObject — The 3d object to be added.

Returns
DisplayObject
addLight()method 
public function addLight(light:AbstractLight3D):AbstractLight3D

Adds a 3d light to the lights array of the container.

Parameters
light:AbstractLight3D — The 3d light to be added.

Returns
AbstractLight3D
addSprite()method 
public function addSprite(sprite:Sprite3D):Sprite3D

Adds a 3d sprite to the scene as a child of the container.

Parameters
sprite:Sprite3D — The 3d sprite to be added.

Returns
Sprite3D
clone()method 
public override function clone(object:Object3D = null):Object3D

Duplicates the 3d object's properties to another ObjectContainer3D object

Parameters
object:Object3D (default = null) — [optional] The new object instance into which all properties are copied

Returns
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

Parameters
boneName:String — The name of the bone object to be returned

Returns
Bone — The bone object, or null if no such bone object exists with the specified name
getChildByName()method 
public override function getChildByName(childName:String):DisplayObject

Returns a 3d object specified by name from the child array of the container

Parameters
childName:String — The name of the 3d object to be returned

Returns
DisplayObject — The 3d object, or null if no such child object exists with the specified name
removeChild()method 
public override function removeChild(child:DisplayObject):DisplayObject

Removes a 3d object from the child array of the container.

Parameters
child:DisplayObject — The 3d object to be removed.

Returns
DisplayObject
removeLight()method 
public function removeLight(light:AbstractLight3D):AbstractLight3D

Removes a 3d light from the lights array of the container.

Parameters
light:AbstractLight3D — The 3d light to be removed.

Returns
AbstractLight3D
removeSprite()method 
public function removeSprite(sprite:Sprite3D):Sprite3D

Removes a 3d sprite from the sprites array of the container.

Parameters
sprite:Sprite3D — The 3d sprite to be removed.

Returns
Sprite3D
Wiki link
Click to go to the wiki page for 'away3dlite.containers.ObjectContainer3D'

Code examples

Comments