Packagealternativa.engine3d.objects
Classpublic class SkyBox
InheritanceSkyBox Inheritance Mesh Inheritance Object3D Inheritance Object

A polygonal box with faces turned inside. It did not cut on farClipping distance and it is difference with Box.

See also

alternativa.engine3d.core.Camera3D.farClipping

Public Properties
 PropertyDefined By
 InheritedboundBox : BoundBox
Bounds of the object described as rectangular parallelepiped.
Object3D
 InheritedconcatenatedMatrix : Matrix3D
[read-only] A Matrix3D object representing the combined transformation matrices of the Object3D and all of its parent objects, back to the root level.
Object3D
 InheriteddoubleClickEnabled : Boolean = false
Specifies whether the object receives doubleClick events.
Object3D
 InheritedexcludedLights : Vector.<Light3D>
[read-only] Returns excluded lights list of current object.
Object3D
 Inheritedgeometry : Geometry
Through geometry property you can get access to vertices.
Mesh
 Inheritedmatrix : Matrix3D
The matrix property represents a transformation matrix that determines the position and orientation of an Object3D.
Object3D
 InheritedmouseChildren : Boolean = true
Determines whether or not the children of the object are mouse, or user input device, enabled.
Object3D
 InheritedmouseEnabled : Boolean = true
Specifies whether this object receives mouse, or other user input, messages.
Object3D
 Inheritedname : String
Name of the object.
Object3D
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
Object3D
 InheritednumSurfaces : int
[read-only] Number of surfaces.
Mesh
 Inheritedparent : Object3D
[read-only] Object3D, to which this object was added as a child.
Object3D
 InheritedrotationX : Number
The angle of rotation of Object3D around the X-axis expressed in radians.
Object3D
 InheritedrotationY : Number
The angle of rotation of Object3D around the Y-axis expressed in radians.
Object3D
 InheritedrotationZ : Number
The angle of rotation of Object3D around the Z-axis expressed in radians.
Object3D
 InheritedscaleX : Number
The scale of the Object3D along the X-axis.
Object3D
 InheritedscaleY : Number
The scale of the Object3D along the Y-axis.
Object3D
 InheritedscaleZ : Number
The scale of the Object3D along the Z-axis.
Object3D
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a Object3D.
Object3D
 InheriteduserData : Object
Custom data available to store within Object3D by user.
Object3D
 Inheritedvisible : Boolean = true
Whether or not the display object is visible.
Object3D
 Inheritedx : Number
X coordinate.
Object3D
 Inheritedy : Number
Y coordinate.
Object3D
 Inheritedz : Number
Z coordinate.
Object3D
Public Methods
 MethodDefined By
  
SkyBox(size:Number, left:Material = null, right:Material = null, back:Material = null, front:Material = null, bottom:Material = null, top:Material = null, uvPadding:Number = 0)
Creates a new SkyBox instance.
SkyBox
 Inherited
addChild(child:Object3D):Object3D
Adds given Object3D instance as a child to the end of this Object3D's children list.
Object3D
 Inherited
addChildAt(child:Object3D, index:int):Object3D
Adds a child Object3D instance to this Object3D instance.
Object3D
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
Object3D
 Inherited
addSurface(material:Material, indexBegin:uint, numTriangles:uint):Surface
Adds Surface to Mesh object.
Mesh
 Inherited
calculateBoundBox():void
Calculates object's bounds in its own coordinates
Object3D
 Inherited
clearExcludedLights(updateChildren:Boolean = false):void
Resets list of lights excluded from lighting this object.
Object3D
  
clone():Object3D
[override] Returns a copy of object.
SkyBox
 Inherited
contains(child:Object3D):Boolean
Check if given object is child of this Object3D.
Object3D
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
Object3D
 Inherited
excludeLight(light:Light3D, updateChildren:Boolean = false):void
Disables lighting of the object by given light.
Object3D
 Inherited
getChildAt(index:int):Object3D
Returns the child Object3D instance that exists at the specified index.
Object3D
 Inherited
getChildByName(name:String):Object3D
Returns child Object3D instance with given name.
Object3D
 Inherited
getChildIndex(child:Object3D):int
Returns index of given child Object3D instance.
Object3D
 Inherited
getResources(hierarchy:Boolean = false, resourceType:Class = null):Vector.<Resource>
Gather the resources of this Object3D.
Object3D
  
getSide(side:String):Surface
Returns a Surface by given alias.
SkyBox
 Inherited
getSurface(index:int):Surface
Returns surface by index.
Mesh
 Inherited
globalToLocal(point:Vector3D):Vector3D
Converts the Vector3D object from the root Object3D (global) coordinates to the local Object3D's own coordinates.
Object3D
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Object3D
 Inherited
intersectRay(origin:Vector3D, direction:Vector3D):RayIntersectionData
[override] Searches for the intersection of an Object3D and given ray, defined by origin and direction.
Mesh
 Inherited
localToGlobal(point:Vector3D):Vector3D
Converts the Vector3D object from the Object3D's own (local) coordinates to the root Object3D (global) coordinates.
Object3D
 Inherited
removeChild(child:Object3D):Object3D
Removes the specified child Object3D instance from the child list of the this Object3D instance.
Object3D
 Inherited
removeChildAt(index:int):Object3D
Removes a child Object3D from the specified index position in the child list of the Object3D.
Object3D
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
Removes child objects in given range of indexes.
Object3D
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Object3D
 Inherited
setChildIndex(child:Object3D, index:int):void
Sets index for child Object3D instance.
Object3D
 Inherited
setMaterialToAllSurfaces(material:Material):void
Assign given material to all surfaces.
Mesh
 Inherited
swapChildren(child1:Object3D, child2:Object3D):void
Swaps index positions of two specified child objects.
Object3D
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps index positions of two child objects by its index.
Object3D
 Inherited
toString():String
Returns the string representation of the specified object.
Object3D
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
Object3D
Protected Methods
 MethodDefined By
  
clonePropertiesFrom(source:Object3D):void
[override] Copies basic properties of Object3D.
SkyBox
Events
 Event Summary Defined By
 Inherited
added
Dispatches when an Object3D is added as a child to another Object3D.Object3D
 Inherited
click
Dispatched when a user presses and releases the main button of the user's pointing device over the same Object3D.Object3D
 Inherited
doubleClick
Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same Object3D.Object3D
 Inherited
middleClick
Dispatched when a user presses and releases the middle button of the user's pointing device over the same Object3D.Object3D
 Inherited
middleMouseDown
Dispatched when a user presses the middle pointing device button over an Object3D instance.Object3D
 Inherited
middleMouseUp
Dispatched when a user releases the pointing device button over an Object3D instance.Object3D
 Inherited
mouseDown
Dispatched when a user presses the pointing device button over an Object3D instance.Object3D
 Inherited
mouseMove
Dispatched when a user moves the pointing device while it is over an Object3D.Object3D
 Inherited
mouseOut
Dispatched when the user moves a pointing device away from an Object3D instance.Object3D
 Inherited
mouseOver
Dispatched when the user moves a pointing device over an Object3D instance.Object3D
 Inherited
mouseUp
Dispatched when a user releases the pointing device button over an Object3D instance.Object3D
 Inherited
mouseWheel
Dispatched when a mouse wheel is spun over an Object3D instance.Object3D
 Inherited
removed
Dispatched when a Object3D is about to be removed from the children list.Object3D
 Inherited
rightClick
Dispatched when a user presses and releases the right button of the user's pointing device over the same Object3D.Object3D
 Inherited
rightMouseDown
Dispatched when a user presses the right pointing device button over an Object3D instance.Object3D
 Inherited
rightMouseUp
Dispatched when a user releases the pointing device button over an Object3D instance.Object3D
 Inherited
rollOut
Dispatched when the user moves a pointing device away from an Object3D instance.Object3D
 Inherited
rollOver
Dispatched when the user moves a pointing device over an Object3D instance.Object3D
Public Constants
 ConstantDefined By
  BACK : String = back
[static] Back side.
SkyBox
  BOTTOM : String = bottom
[static] Bottom side.
SkyBox
  FRONT : String = front
[static] Front side.
SkyBox
  LEFT : String = left
[static] Left side.
SkyBox
  RIGHT : String = right
[static] Right side.
SkyBox
  TOP : String = top
[static] Top side..
SkyBox
Constructor Detail
SkyBox()Constructor
public function SkyBox(size:Number, left:Material = null, right:Material = null, back:Material = null, front:Material = null, bottom:Material = null, top:Material = null, uvPadding:Number = 0)

Creates a new SkyBox instance.

Parameters
size:Number — Length of each edge.
 
left:Material (default = null) — Material of the left side.
 
right:Material (default = null) — Material of the right side.
 
back:Material (default = null) — Material of the back side.
 
front:Material (default = null) — Material of the front side.
 
bottom:Material (default = null) — Material of the bottom side.
 
top:Material (default = null) — Material of the top side.
 
uvPadding:Number (default = 0) — Texture padding in UV space.

See also

alternativa.engine3d.materials.Material
Method Detail
clone()method
override public function clone():Object3D

Returns a copy of object.

Returns
Object3D — A copy of this Object3D.
clonePropertiesFrom()method 
override protected function clonePropertiesFrom(source:Object3D):void

Copies basic properties of Object3D. This method calls from clone() method.

Parameters

source:Object3D — Object3D, properties of which will be copied.

getSide()method 
public function getSide(side:String):Surface

Returns a Surface by given alias. You can use SkyBox class constants as value of side parameter. They are following: SkyBox.LEFT, SkyBox.RIGHT, SkyBox.BACK, SkyBox.FRONT, SkyBox.BOTTOM, SkyBox.TOP.

Parameters

side:String — Surface alias.

Returns
Surface — Surface by given alias.
Constant Detail
BACKConstant
public static const BACK:String = back

Back side.

BOTTOMConstant 
public static const BOTTOM:String = bottom

Bottom side.

FRONTConstant 
public static const FRONT:String = front

Front side.

LEFTConstant 
public static const LEFT:String = left

Left side.

RIGHTConstant 
public static const RIGHT:String = right

Right side.

TOPConstant 
public static const TOP:String = top

Top side..




_

Tue Oct 9 2012, 06:20 PM +06:00