| Package | away3d.primitives |
| Class | public class SkyBox |
| Inheritance | SkyBox  Entity ObjectContainer3D Object3D flash.events.EventDispatcher |
| Implements | IRenderable |
| Package | away3d.primitives |
| Class | public class SkyBox |
| Inheritance | SkyBox Entity ObjectContainer3D Object3D flash.events.EventDispatcher |
| Implements | IRenderable |
| Property | Defined by | ||
|---|---|---|---|
| animation : AnimationBase
[read-only]
The animation used by the material to assemble the vertex code.
| SkyBox | ||
| animationState : AnimationStateBase
[read-only]
| SkyBox | ||
 | bounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity.
| Entity | |
| castsShadows : Boolean [read-only]
| SkyBox | ||
| 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 | |
| inverseSceneTransform : Matrix3D
The inverse scene transform object that transforms from world to model space.
| ObjectContainer3D | |
| material : MaterialBase
The material with which to render the object.
| SkyBox | ||
| maxX : Number
The maximum extremum of the object along the X-axis.
| Entity | |
| maxY : Number
The maximum extremum of the object along the Y-axis.
| Entity | |
| maxZ : Number
The maximum extremum of the object along the Z-axis.
| Entity | |
| minX : Number
The minimum extremum of the object along the X-axis.
| Entity | |
| minY : Number
The minimum extremum of the object along the Y-axis.
| Entity | |
| minZ : Number
The minimum extremum of the object along the Z-axis.
| Entity | |
| modelViewProjection : 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 | |
| mouseDetails : Boolean [read-only]
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
| SkyBox | ||
| mouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
| Entity | |
| name : String
The name of the object.
| Object3D | |
| numChildren : uint
The amount of child objects of the ObjectContainer3D.
| ObjectContainer3D | |
| numTriangles : uint [read-only]
The amount of triangles that comprise the SkyBox geometry.
| SkyBox | ||
| parent : ObjectContainer3D
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 | |
| 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 | |
| scenePosition : Vector3D
The global position of the ObjectContainer3D in the scene.
| ObjectContainer3D | |
| sceneTransform : Matrix3D
The transformation matrix that transforms from model to world space.
| ObjectContainer3D | |
| sourceEntity : Entity
[read-only]
The entity that that initially provided the IRenderable to the render pipeline.
| SkyBox | ||
| transform : Matrix3D
The local transformation matrix that transforms to the parent object's space.
| 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 | |
| zIndex : Number [read-only]
The distance of the IRenderable object to the view, used to sort per object.
| SkyBox | ||
| Method | Defined by | ||
|---|---|---|---|
|
Create a new SkyBox object.
| SkyBox | ||
|
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 | |
| Object3D | ||
|
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
| ObjectContainer3D | |
|
Retrieves the child object at the given index.
| ObjectContainer3D | |
|
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
| Entity | |
|
getIndexBuffer(context:Context3D, contextIndex:uint):IndexBuffer3D
Retrieves the VertexBuffer3D object that contains triangle indices.
| SkyBox | ||
|
getUVBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains texture coordinates.
| SkyBox | ||
|
getVertexBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex positions.
| SkyBox | ||
|
getVertexNormalBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex normals.
| SkyBox | ||
|
getVertexTangentBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex tangents.
| SkyBox | ||
|
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 | |
|
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 | |
|
popModelViewProjection():void
Removes a model view projection matrix from the stack, used when leaving a render.
| Entity | |
|
Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space
and places it on the stack.
| SkyBox | ||
|
Removes a 3d object from the child array of the container
| ObjectContainer3D | |
|
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
|
rotate(axis:Vector3D, angle:Number):void
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(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
| ObjectContainer3D | |
|
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D | |
| Method | Defined by | ||
|---|---|---|---|
|
Factory method that returns the current partition node.
| SkyBox | ||
|
Creates the default bounding box to be used by this type of Entity.
| Entity | |
|
invalidateBounds():void
Invalidates the bounding volume, causing to be updated when requested.
| SkyBox | ||
|
invalidateSceneTransform():void
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
| Entity | |
|
invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
| ObjectContainer3D | |
|
updateBounds():void
Updates the bounding volume for the object.
| SkyBox | ||
|
updateSceneTransform():void
Updates the scene transformation matrix.
| ObjectContainer3D | |
|
updateTransform():void
| Object3D | |
| animation | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesanimation:AnimationBase [read-only]The animation used by the material to assemble the vertex code.
Implementation public function get animation():AnimationBase
| animationState | property |
animationState:AnimationStateBase [read-only]Implementation
public function get animationState():AnimationStateBase
| castsShadows | property |
castsShadows:Boolean [read-only]Implementation
public function get castsShadows():Boolean
| material | property |
material:MaterialBase [read-write]The material with which to render the object.
Implementation public function get material():MaterialBase
public function set material(value:MaterialBase):void
| mouseDetails | property |
mouseDetails:Boolean [read-only]Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
Implementation public function get mouseDetails():Boolean
| numTriangles | property |
numTriangles:uint [read-only]The amount of triangles that comprise the SkyBox geometry.
Implementation public function get numTriangles():uint
| sourceEntity | property |
sourceEntity:Entity [read-only]The entity that that initially provided the IRenderable to the render pipeline.
Implementation public function get sourceEntity():Entity
| zIndex | property |
zIndex:Number [read-only]The distance of the IRenderable object to the view, used to sort per object.
Implementation public function get zIndex():Number
| SkyBox | () | constructor |
public function SkyBox(cubeMap:CubeMap)Parameters
cubeMap:CubeMap — The CubeMap to use for the sky box's texture.
|
| createEntityPartitionNode | () | method |
protected override function createEntityPartitionNode():EntityNode
Factory method that returns the current partition node. Needs to be overridden by concrete subclasses such as Mesh to return the correct concrete subtype of EntityPartition3DNode (for Mesh = MeshPartition3DNode, most IRenderables (particles fe) would return RenderablePartition3DNode, I suppose)
ReturnsEntityNode |
| getIndexBuffer | () | method |
public function getIndexBuffer(context:Context3D, contextIndex:uint):IndexBuffer3D
Retrieves the VertexBuffer3D object that contains triangle indices.
Parameterscontext:Context3D — The Context3D for which we request the buffer
|
|
contextIndex:uint |
IndexBuffer3D — The VertexBuffer3D object that contains triangle indices.
|
| getUVBuffer | () | method |
public function getUVBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains texture coordinates.
Parameterscontext:Context3D — The Context3D for which we request the buffer
|
|
contextIndex:uint |
VertexBuffer3D — The VertexBuffer3D object that contains texture coordinates.
|
| getVertexBuffer | () | method |
public function getVertexBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex positions.
Parameterscontext:Context3D — The Context3D for which we request the buffer
|
|
contextIndex:uint |
VertexBuffer3D — The VertexBuffer3D object that contains vertex positions.
|
| getVertexNormalBuffer | () | method |
public function getVertexNormalBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex normals.
Parameterscontext:Context3D — The Context3D for which we request the buffer
|
|
contextIndex:uint |
VertexBuffer3D — The VertexBuffer3D object that contains vertex normals.
|
| getVertexTangentBuffer | () | method |
public function getVertexTangentBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex tangents.
Parameterscontext:Context3D — The Context3D for which we request the buffer
|
|
contextIndex:uint |
VertexBuffer3D — The VertexBuffer3D object that contains vertex tangents.
|
| invalidateBounds | () | method |
protected override function invalidateBounds():void
Invalidates the bounding volume, causing to be updated when requested.
| pushModelViewProjection | () | method |
public override function pushModelViewProjection(camera:Camera3D):void
Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space and places it on the stack. The stack allows nested rendering while keeping the MVP intact.
Parameterscamera:Camera3D — The camera which will perform the view transformation and projection.
|
| updateBounds | () | method |
protected override function updateBounds():void
Updates the bounding volume for the object. Overriding methods need to set invalid flag to false!