Packageaway3d.primitives
Classpublic class SkyBox
InheritanceSkyBox Inheritance Entity Inheritance ObjectContainer3D Inheritance Object3D Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher
Implements IRenderable

A SkyBox class is used to render a sky in the scene. It's always considered static and 'at infinity', and as such it's always centered at the camera's position and sized to exactly fit within the camera's frustum, ensuring the sky box is always as large as possible without being clipped.



Public Properties
 PropertyDefined By
  animator : IAnimator
[read-only]
SkyBox
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
  assetType : String
[override] [read-only]
SkyBox
 InheritedbackVector : Vector3D
[read-only]
Object3D
 Inheritedbounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity.
Entity
  castsShadows : Boolean
[read-only]
SkyBox
 InheriteddownVector : Vector3D
[read-only]
Object3D
 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
 InheritedforwardVector : Vector3D
[read-only]
Object3D
 Inheritedid : String
NamedAssetBase
 InheritedignoreTransform : Boolean
[override]
Entity
  indexData : Vector.<uint>
[read-only]
SkyBox
 InheritedinverseSceneTransform : Matrix3D
[read-only] The inverse scene transform object that transforms from world to model space.
ObjectContainer3D
 InheritedleftVector : Vector3D
[read-only]
Object3D
  material : MaterialBase
The material with which to render the object.
SkyBox
 InheritedmaxX : Number
[override] [read-only] The maximum extremum of the object along the X-axis.
Entity
 InheritedmaxY : Number
[override] [read-only] The maximum extremum of the object along the Y-axis.
Entity
 InheritedmaxZ : Number
[override] [read-only] The maximum extremum of the object along the Z-axis.
Entity
 InheritedminX : Number
[override] [read-only] The minimum extremum of the object along the X-axis.
Entity
 InheritedminY : Number
[override] [read-only] The minimum extremum of the object along the Y-axis.
Entity
 InheritedminZ : Number
[override] [read-only] The minimum extremum of the object along the Z-axis.
Entity
 InheritedmouseChildren : Boolean
ObjectContainer3D
 InheritedmouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
ObjectContainer3D
 Inheritedname : String
NamedAssetBase
 InheritednumChildren : uint
[read-only] The amount of child objects of the ObjectContainer3D.
ObjectContainer3D
  numTriangles : uint
[read-only] The amount of triangles that comprise the SkyBox geometry.
SkyBox
  numVertices : uint
[read-only]
SkyBox
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
 Inheritedparent : ObjectContainer3D
[read-only] 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
 InheritedpickingCollider : IPickingCollider
Used by the raycast-based picking system to determine how the geometric contents of an entity are processed in order to offer more details for the picking collision object, including local position, normal vector and uv value.
Entity
 InheritedpickingCollisionVO : PickingCollisionVO
[read-only] Returns a unique picking collision value object for the entity.
Entity
 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
 InheritedrightVector : Vector3D
[read-only]
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
 Inheritedscene : Scene3D
[override] A reference to the Scene3D object to which this object belongs.
Entity
 InheritedscenePosition : Vector3D
[read-only] The global position of the ObjectContainer3D in the scene.
ObjectContainer3D
 InheritedsceneTransform : Matrix3D
[read-only] The transformation matrix that transforms from model to world space.
ObjectContainer3D
 InheritedshaderPickingDetails : Boolean
Used by the shader-based picking system to determine whether a separate render pass is made in order to offer more details for the picking collision object, including local position, normal vector and uv value.
Entity
 InheritedshowBounds : Boolean
Entity
  sourceEntity : Entity
[read-only] The entity that that initially provided the IRenderable to the render pipeline.
SkyBox
 InheritedstaticNode : Boolean
Defines whether or not the object will be moved or animated at runtime.
Entity
 Inheritedtransform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedupVector : Vector3D
[read-only]
Object3D
  UVData : Vector.<Number>
[read-only]
SkyBox
  uvTransform : Matrix
[read-only]
SkyBox
  vertexData : Vector.<Number>
[read-only]
SkyBox
  vertexNormalData : Vector.<Number>
[read-only]
SkyBox
  vertexNormalOffset : int
[read-only]
SkyBox
  vertexOffset : int
[read-only]
SkyBox
  vertexStride : uint
[read-only]
SkyBox
  vertexTangentData : Vector.<Number>
[read-only]
SkyBox
  vertexTangentOffset : int
[read-only]
SkyBox
 Inheritedvisible : Boolean
ObjectContainer3D
 InheritedworldBounds : BoundingVolumeBase
[read-only]
Entity
 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
 InheritedzOffset : int
Object3D
Protected Properties
 PropertyDefined By
 Inherited_bounds : BoundingVolumeBase
Entity
 Inherited_boundsInvalid : Boolean = true
Entity
 Inherited_explicitPartition : Partition3D
ObjectContainer3D
 Inherited_ignoreTransform : Boolean = false
ObjectContainer3D
 Inherited_implicitPartition : Partition3D
ObjectContainer3D
 Inherited_mouseEnabled : Boolean
ObjectContainer3D
 Inherited_parent : ObjectContainer3D
ObjectContainer3D
 Inherited_pivotPoint : Vector3D
Object3D
 Inherited_pivotZero : Boolean = true
Object3D
 Inherited_pos : Vector3D
Object3D
 Inherited_rot : Vector3D
Object3D
 Inherited_sca : Vector3D
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_transform : Matrix3D
Object3D
 Inherited_transformComponents : Vector.<Vector3D>
Object3D
 Inherited_x : Number = 0
Object3D
 Inherited_y : Number = 0
Object3D
 Inherited_z : Number = 0
Object3D
 Inherited_zOffset : int = 0
Object3D
Public Methods
 MethodDefined By
  
Create a new SkyBox object.
SkyBox
  
activateSecondaryUVBuffer(index:int, stage3DProxy:Stage3DProxy):void
SkyBox
  
activateUVBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for UV coordinates
SkyBox
  
activateVertexBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for vertex positions.
SkyBox
  
activateVertexNormalBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for vertex normals
SkyBox
  
activateVertexTangentBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for vertex tangents
SkyBox
 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
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override]
ObjectContainer3D
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
[override] Clones this ObjectContainer3D instance along with all it's children, and returns the result (which will be a copy of this container, containing copies of all it's children.)
ObjectContainer3D
 Inherited
ObjectContainer3D
 Inherited
dispatchEvent(event:Event):Boolean
[override]
ObjectContainer3D
 Inherited
dispose():void
[override] Cleans up resources used by this asset.
ObjectContainer3D
 Inherited
Object3D
 Inherited
Disposes the current ObjectContainer3D including all of its children.
ObjectContainer3D
 Inherited
Retrieves the child object at the given index.
ObjectContainer3D
 Inherited
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
Entity
  
getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D
Retrieves the IndexBuffer3D object that contains triangle indices.
SkyBox
  
SkyBox
 Inherited
isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Boolean
Entity
 Inherited
lookAt(target:Vector3D, upAxis:Vector3D = null):void
[override] 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 3d object from the child array of the container
ObjectContainer3D
 Inherited
removeChildAt(index:uint):void
Removes a 3d object from the child array of the container
ObjectContainer3D
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override]
ObjectContainer3D
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Vector3D, angle:Number):void
[override]
ObjectContainer3D
 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
[override]
ObjectContainer3D
 Inherited
ObjectContainer3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined By
  
[override] Factory method that returns the current partition node.
SkyBox
  
[override]
SkyBox
  
[override] Invalidates the bounding volume, causing to be updated when requested.
SkyBox
 Inherited
[override] Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
Entity
  
[override] Updates the bounding volume for the object.
SkyBox
 Inherited
[override]
Entity
 Inherited
Updates the scene transformation matrix.
ObjectContainer3D
 Inherited
Object3D
Events
 Event Summary Defined By
 InheritedDispatched when a user presses the left hand mouse button while the cursor is over the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor while it is over the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor away from the 3d object.ObjectContainer3D
 InheritedDispatched when a user moves the cursor over the 3d object.ObjectContainer3D
 InheritedDispatched when a user releases the left hand mouse button while the cursor is over the 3d object.ObjectContainer3D
 InheritedDispatched when the position of the 3d object changes.Object3D
 InheritedDispatched when the rotation of the 3d object changes.Object3D
 InheritedDispatched when the scale of the 3d object changes.Object3D
 InheritedDispatched when the parent scene of the 3d object changes.ObjectContainer3D
 InheritedDispatched when the scene transform matrix of the 3d object changes.ObjectContainer3D
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Property Detail
animatorproperty
animator:IAnimator  [read-only]


Implementation
    public function get animator():IAnimator
assetTypeproperty 
assetType:String  [read-only] [override]


Implementation
    public function get assetType():String
castsShadowsproperty 
castsShadows:Boolean  [read-only]


Implementation
    public function get castsShadows():Boolean
indexDataproperty 
indexData:Vector.<uint>  [read-only]


Implementation
    public function get indexData():Vector.<uint>
materialproperty 
material:MaterialBase

The material with which to render the object.


Implementation
    public function get material():MaterialBase
    public function set material(value:MaterialBase):void
numTrianglesproperty 
numTriangles:uint  [read-only]

The amount of triangles that comprise the SkyBox geometry.


Implementation
    public function get numTriangles():uint
numVerticesproperty 
numVertices:uint  [read-only]


Implementation
    public function get numVertices():uint
sourceEntityproperty 
sourceEntity:Entity  [read-only]

The entity that that initially provided the IRenderable to the render pipeline.


Implementation
    public function get sourceEntity():Entity
UVDataproperty 
UVData:Vector.<Number>  [read-only]


Implementation
    public function get UVData():Vector.<Number>
uvTransformproperty 
uvTransform:Matrix  [read-only]


Implementation
    public function get uvTransform():Matrix
vertexDataproperty 
vertexData:Vector.<Number>  [read-only]


Implementation
    public function get vertexData():Vector.<Number>
vertexNormalDataproperty 
vertexNormalData:Vector.<Number>  [read-only]


Implementation
    public function get vertexNormalData():Vector.<Number>
vertexNormalOffsetproperty 
vertexNormalOffset:int  [read-only]


Implementation
    public function get vertexNormalOffset():int
vertexOffsetproperty 
vertexOffset:int  [read-only]


Implementation
    public function get vertexOffset():int
vertexStrideproperty 
vertexStride:uint  [read-only]


Implementation
    public function get vertexStride():uint
vertexTangentDataproperty 
vertexTangentData:Vector.<Number>  [read-only]


Implementation
    public function get vertexTangentData():Vector.<Number>
vertexTangentOffsetproperty 
vertexTangentOffset:int  [read-only]


Implementation
    public function get vertexTangentOffset():int
Constructor Detail
SkyBox()Constructor
public function SkyBox(cubeMap:CubeTextureBase)

Create a new SkyBox object.

Parameters
cubeMap:CubeTextureBase — The CubeMap to use for the sky box's texture.
Method Detail
activateSecondaryUVBuffer()method
public function activateSecondaryUVBuffer(index:int, stage3DProxy:Stage3DProxy):void

Parameters

index:int
 
stage3DProxy:Stage3DProxy

activateUVBuffer()method 
public function activateUVBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for UV coordinates

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

activateVertexBuffer()method 
public function activateVertexBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for vertex positions.

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

activateVertexNormalBuffer()method 
public function activateVertexNormalBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for vertex normals

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

activateVertexTangentBuffer()method 
public function activateVertexTangentBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for vertex tangents

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

createEntityPartitionNode()method 
override protected 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)

Returns
EntityNode
getDefaultBoundingVolume()method 
override protected function getDefaultBoundingVolume():BoundingVolumeBase

Returns
BoundingVolumeBase
getIndexBuffer()method 
public function getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D

Retrieves the IndexBuffer3D object that contains triangle indices.

Parameters

stage3DProxy:Stage3DProxy — The Context3D for which we request the buffer

Returns
IndexBuffer3D — The VertexBuffer3D object that contains triangle indices.
getRenderSceneTransform()method 
public function getRenderSceneTransform(camera:Camera3D):Matrix3D

Parameters

camera:Camera3D

Returns
Matrix3D
invalidateBounds()method 
override protected function invalidateBounds():void

Invalidates the bounding volume, causing to be updated when requested.

updateBounds()method 
override protected function updateBounds():void

Updates the bounding volume for the object. Overriding methods need to set invalid flag to false!