Packageaway3d.primitives
Classpublic class Cube
InheritanceCube Inheritance PrimitiveBase Inheritance Mesh Inheritance Entity Inheritance ObjectContainer3D Inheritance Object3D Inheritance flash.events.EventDispatcher

A Cube primitive mesh.

Public Properties
 PropertyDefined by
 Inheritedanimation : AnimationBase
The type of animation used to influence the geometry.
Mesh
 InheritedanimationController : AnimatorBase
The animation controller that will update the mesh's animation state.
Mesh
 InheritedanimationState : AnimationStateBase
The animation state of the mesh, defining how the animation should influence the mesh's geometry.
Mesh
 Inheritedbounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity.
PrimitiveBase
 InheritedcastsShadows : Boolean
Indicates whether or not the Mesh can cast shadows
Mesh
  depth : Number
The size of the cube along its Z-axis.
Cube
 Inheritedeulers : Vector3D
Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis.
Object3D
 Inheritedextra : Object
An object that can contain any extra data.
Object3D
 Inheritedgeometry : Geometry
The geometry used by the mesh that provides it with its shape.
PrimitiveBase
  height : Number
The size of the cube along its Y-axis.
Cube
 InheritedinverseSceneTransform : Matrix3D
The inverse scene transform object that transforms from world to model space.
ObjectContainer3D
 Inheritedmaterial : MaterialBase
The material with which to render the Mesh.
Mesh
 InheritedmaxX : Number
The maximum extremum of the object along the X-axis.
Entity
 InheritedmaxY : Number
The maximum extremum of the object along the Y-axis.
Entity
 InheritedmaxZ : Number
The maximum extremum of the object along the Z-axis.
Entity
 InheritedminX : Number
The minimum extremum of the object along the X-axis.
Entity
 InheritedminY : Number
The minimum extremum of the object along the Y-axis.
Entity
 InheritedminZ : Number
The minimum extremum of the object along the Z-axis.
Entity
 InheritedmodelViewProjection : Matrix3D
The current model-view-projection (MVP) matrix - the one on the top of the stack - used to transform from model to homogeneous projection space.
Entity
 InheritedmouseDetails : Boolean
Indicates whether or not mouse events contain UV and position coordinates.
Mesh
 InheritedmouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
Entity
 Inheritedname : String
The name of the object.
Object3D
 InheritednumChildren : uint
The amount of child objects of the ObjectContainer3D.
ObjectContainer3D
 Inheritedparent : ObjectContainer3D
The parent ObjectContainer3D to which this object's transformation is relative.
ObjectContainer3D
 Inheritedpartition : 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
 InheritedpivotPoint : Vector3D
Defines the local point around which the object rotates.
Object3D
 Inheritedposition : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationX : 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
 InheritedrotationY : 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
 InheritedrotationZ : 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
 InheritedscaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
Object3D
 InheritedscaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
Object3D
 InheritedscaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
Object3D
 InheritedscenePosition : Vector3D
The global position of the ObjectContainer3D in the scene.
ObjectContainer3D
 InheritedsceneTransform : Matrix3D
The transformation matrix that transforms from model to world space.
ObjectContainer3D
  segmentsD : Number
The number of segments that make up the cube along the Z-axis.
Cube
  segmentsH : Number
The number of segments that make up the cube along the Y-axis.
Cube
  segmentsW : Number
The number of segments that make up the cube along the X-axis.
Cube
 InheritedsubMeshes : Vector
The SubMeshes out of which the Mesh consists.
PrimitiveBase
  tile6 : Boolean
The type of uv mapping to use.
Cube
 Inheritedtransform : Matrix3D
The local transformation matrix that transforms to the parent object's space.
ObjectContainer3D
  width : Number
The size of the cube along its X-axis.
Cube
 Inheritedx : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedy : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedz : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedzIndex : Number
The distance of the IRenderable object to the view, used to sort per object.
Entity
Protected Properties
 PropertyDefined by
 Inherited_bounds : BoundingVolumeBase
Entity
 Inherited_boundsInvalid : Boolean = true
Entity
 Inherited_explicitPartition : Partition3D
ObjectContainer3D
 Inherited_geomDirty : Boolean = true
PrimitiveBase
 Inherited_geometry : Geometry
Mesh
 Inherited_implicitPartition : Partition3D
ObjectContainer3D
 Inherited_mvpIndex : int = -1
Entity
 Inherited_mvpTransformStack : Vector
Entity
 Inherited_parent : ObjectContainer3D
ObjectContainer3D
 Inherited_pivotPoint : Vector3D
Object3D
 Inherited_pivotZero : Boolean = true
Object3D
 Inherited_pos : Vector3D
A calculation placeholder.
Object3D
 Inherited_scaleX : Number = 1
Object3D
 Inherited_scaleY : Number = 1
Object3D
 Inherited_scaleZ : Number = 1
Object3D
 Inherited_scene : Scene3D
ObjectContainer3D
 Inherited_sceneTransform : Matrix3D
ObjectContainer3D
 Inherited_sceneTransformDirty : Boolean = true
ObjectContainer3D
 Inherited_stackLen : uint
Entity
 Inherited_transform : Matrix3D
Object3D
 Inherited_uvDirty : Boolean = true
PrimitiveBase
 Inherited_x : Number = 0
Object3D
 Inherited_y : Number = 0
Object3D
 Inherited_z : Number = 0
Object3D
 Inherited_zIndices : Vector
Entity
Public Methods
 MethodDefined by
  
Cube
(material:MaterialBase = null, width:Number = 100, height:Number = 100, depth:Number = 100, segmentsW:uint = 1, segmentsH:uint = 1, segmentsD:uint = 1, tile6:Boolean = true)
Creates a new Cube object.
Cube
 Inherited
Adds a child ObjectContainer3D to the current object.
ObjectContainer3D
 Inherited
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
ObjectContainer3D
 Inherited
PrimitiveBase
 Inherited
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
Mesh
 Inherited
Retrieves the child object at the given index.
ObjectContainer3D
 Inherited
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
Entity
 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.
ObjectContainer3D
 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
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates.
Object3D
 Inherited
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Object3D
 Inherited
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
Object3D
 Inherited
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
Object3D
 Inherited
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
Object3D
 Inherited
Removes a model view projection matrix from the stack, used when leaving a render.
Entity
 Inherited
Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space and places it on the stack.
Entity
 Inherited
Removes a 3d object from the child array of the container
ObjectContainer3D
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Vector3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
Object3D
 Inherited
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
Object3D
 Inherited
scale(value:Number):void
Appends a uniform scale to the current transformation.
Object3D
 Inherited
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
 Inherited
translateLocal(axis:Vector3D, distance:Number):void
ObjectContainer3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined by
  
buildGeometry(target:SubGeometry):void
Builds the primitive's geometry when invalid.
Cube
  
buildUVs(target:SubGeometry):void
Builds the primitive's uv coordinates when invalid.
Cube
 Inherited
Factory method that returns the current partition node.
Mesh
 Inherited
Creates the default bounding box to be used by this type of Entity.
Entity
 Inherited
initGeometry():void
Initialises the SubMesh objects to map unto the Geometry's SubGeometry objects.
Mesh
 Inherited
Invalidates the bounding volume, causing to be updated when requested.
Entity
 Inherited
Invalidates the primitive's geometry, causing it to be updated when requested.
PrimitiveBase
 Inherited
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
Entity
 Inherited
Invalidates the transformation matrix, causing it to be updated upon the next request
ObjectContainer3D
 Inherited
invalidateUVs():void
Invalidates the primitive's uv coordinates, causing them to be updated when requested.
PrimitiveBase
 Inherited
updateBounds():void
Updates the bounding volume for the object.
Mesh
 Inherited
Updates the scene transformation matrix.
ObjectContainer3D
 Inherited
Object3D
Property detail
depthproperty
depth:Number  [read-write]

The size of the cube along its Z-axis.

Implementation
    public function get depth():Number
    public function set depth(value:Number):void
heightproperty 
height:Number  [read-write]

The size of the cube along its Y-axis.

Implementation
    public function get height():Number
    public function set height(value:Number):void
segmentsDproperty 
segmentsD:Number  [read-write]

The number of segments that make up the cube along the Z-axis. Defaults to 1.

Implementation
    public function get segmentsD():Number
    public function set segmentsD(value:Number):void
segmentsHproperty 
segmentsH:Number  [read-write]

The number of segments that make up the cube along the Y-axis. Defaults to 1.

Implementation
    public function get segmentsH():Number
    public function set segmentsH(value:Number):void
segmentsWproperty 
segmentsW:Number  [read-write]

The number of segments that make up the cube along the X-axis. Defaults to 1.

Implementation
    public function get segmentsW():Number
    public function set segmentsW(value:Number):void
tile6property 
tile6:Boolean  [read-write]

The type of uv mapping to use. When true, a texture will be subdivided in a 2x3 grid, each used for a single face. When false, the entire image is mapped on each face.

Implementation
    public function get tile6():Boolean
    public function set tile6(value:Boolean):void
widthproperty 
width:Number  [read-write]

The size of the cube along its X-axis.

Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor detail
Cube()constructor
public function Cube(material:MaterialBase = null, width:Number = 100, height:Number = 100, depth:Number = 100, segmentsW:uint = 1, segmentsH:uint = 1, segmentsD:uint = 1, tile6:Boolean = true)Parameters
material:MaterialBase (default = null) — The material with which to render the object.
 
width:Number (default = 100) — The size of the cube along its X-axis.
 
height:Number (default = 100) — The size of the cube along its Y-axis.
 
depth:Number (default = 100) — The size of the cube along its Z-axis.
 
segmentsW:uint (default = 1) — The number of segments that make up the cube along the X-axis. Defaults to 1.
 
segmentsH:uint (default = 1) — The number of segments that make up the cube along the Y-axis. Defaults to 1.
 
segmentsD:uint (default = 1) — The number of segments that make up the cube along the Z-axis. Defaults to 1.
 
tile6:Boolean (default = true) — The type of uv mapping to use. When true, a texture will be subdivided in a 2x3 grid, each used for a single face. When false, the entire image is mapped on each face.
Init Parameters
Method detail
buildGeometry()method
protected override function buildGeometry(target:SubGeometry):void

Builds the primitive's geometry when invalid. This method should not be called directly. The calling should be triggered by the invalidateGeometry method (and in turn by updateGeometry).

Parameters
target:SubGeometry
buildUVs()method 
protected override function buildUVs(target:SubGeometry):void

Builds the primitive's uv coordinates when invalid. This method should not be called directly. The calling should be triggered by the invalidateUVs method (and in turn by updateUVs).

Parameters
target:SubGeometry
Wiki link
Click to go to the wiki page for 'away3d.primitives.Cube'

Code examples

Comments