| Package | away3d.lights |
| Class | public class LightProbe |
| Inheritance | LightProbe  LightBase Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
 | ambient : Number
The ambient emission strength of the light. | LightBase | |
| ambientColor : uint | LightBase | |
| assetFullPath : Array [read-only] | NamedAssetBase | |
| assetNamespace : String [read-only] | NamedAssetBase | |
| assetType : String [override] [read-only] | Entity | |
| backVector : Vector3D [read-only]
| Object3D | |
| bounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity. | Entity | |
| castsShadows : Boolean | LightBase | |
| color : uint
The color of the light. | LightBase | |
| diffuse : Number
The diffuse emission strength of the light. | LightBase | |
| diffuseMap : CubeTextureBase | LightProbe | ||
| downVector : Vector3D [read-only]
| Object3D | |
| 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 | |
| forwardVector : Vector3D [read-only]
| Object3D | |
| inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space. | ObjectContainer3D | |
| leftVector : Vector3D [read-only]
| Object3D | |
| maxX : Number [override] [read-only]
The maximum extremum of the object along the X-axis. | Entity | |
| maxY : Number [override] [read-only]
The maximum extremum of the object along the Y-axis. | Entity | |
| maxZ : Number [override] [read-only]
The maximum extremum of the object along the Z-axis. | Entity | |
| minX : Number [override] [read-only]
The minimum extremum of the object along the X-axis. | Entity | |
| minY : Number [override] [read-only]
The minimum extremum of the object along the Y-axis. | Entity | |
| minZ : Number [override] [read-only]
The minimum extremum of the object along the Z-axis. | Entity | |
| modelViewProjection : Matrix3D [read-only]
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 | |
| mouseChildren : Boolean | ObjectContainer3D | |
| mouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing. | ObjectContainer3D | |
| name : String | NamedAssetBase | |
| numChildren : uint [read-only]
The amount of child objects of the ObjectContainer3D. | ObjectContainer3D | |
| originalName : String [read-only]
The original name used for this asset in the resource (e.g. | NamedAssetBase | |
| parent : ObjectContainer3D [read-only]
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 | |
| pickingCollider : 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 | |
| pickingCollisionVO : PickingCollisionVO [read-only]
Returns a unique picking collision value object for the entity. | Entity | |
| 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 | |
| rightVector : Vector3D [read-only]
| 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 | |
| scene : Scene3D [override]
A reference to the Scene3D object to which this object belongs. | Entity | |
| scenePosition : Vector3D [read-only]
The global position of the ObjectContainer3D in the scene. | ObjectContainer3D | |
| sceneTransform : Matrix3D [read-only]
The transformation matrix that transforms from model to world space. | ObjectContainer3D | |
| shaderPickingDetails : 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 | |
| shadowMapper : ShadowMapperBase | LightBase | |
| showBounds : Boolean | Entity | |
| specular : Number
The specular emission strength of the light. | LightBase | |
| specularMap : CubeTextureBase | LightProbe | ||
| transform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
| upVector : Vector3D [read-only]
| Object3D | |
| visible : Boolean | 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 | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new LightProbe object. | LightProbe | ||
|
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 | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] | ObjectContainer3D | |
| assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | |
| [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 | |
| contains(child:ObjectContainer3D):Boolean | ObjectContainer3D | |
| dispatchEvent(event:Event):Boolean [override]
| ObjectContainer3D | |
| dispose():void [override]
Cleans up resources used by this asset. | ObjectContainer3D | |
| disposeAsset():void | Object3D | |
| getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index. | ObjectContainer3D | |
|
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
| Entity | |
| 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 | |
| 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 | |
| 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. | Entity | |
| removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override] | ObjectContainer3D | |
| resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase | |
| roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
| rotate(axis:Vector3D, angle:Number):void [override] | ObjectContainer3D | |
| 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 [override] | ObjectContainer3D | |
| updateImplicitVisibility():void | ObjectContainer3D | |
| yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D | |
| Method | Defined By | ||
|---|---|---|---|
[override] | LightProbe | ||
| LightBase | ||
[override]
Creates the default bounding box to be used by this type of Entity. | LightProbe | ||
| invalidateBounds():void
Invalidates the bounding volume, causing to be updated when requested. | Entity | |
| invalidateSceneTransform():void [override]
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested. | Entity | |
updateBounds():void [override]
Updates the bounding volume for the object. | LightProbe | ||
| updateMouseChildren():void [override] | Entity | |
| updateSceneTransform():void
Updates the scene transformation matrix. | ObjectContainer3D | |
| updateTransform():void | Object3D | |
| diffuseMap | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdiffuseMap:CubeTextureBase public function get diffuseMap():CubeTextureBase public function set diffuseMap(value:CubeTextureBase):void| specularMap | property |
specularMap:CubeTextureBase public function get specularMap():CubeTextureBase public function set specularMap(value:CubeTextureBase):void| LightProbe | () | Constructor |
public function LightProbe(diffuseMap:CubeTextureBase, specularMap:CubeTextureBase = null)Creates a new LightProbe object.
ParametersdiffuseMap:CubeTextureBase | |
specularMap:CubeTextureBase (default = null) |
| createEntityPartitionNode | () | method |
| getDefaultBoundingVolume | () | method |
override protected function getDefaultBoundingVolume():BoundingVolumeBaseCreates the default bounding box to be used by this type of Entity.
ReturnsBoundingVolumeBase — |
| getObjectProjectionMatrix | () | method |
override arcane function getObjectProjectionMatrix(renderable:IRenderable, target:Matrix3D = null):Matrix3DGets the optimal projection matrix to render a light-based depth map for a single object.
Parameters
renderable:IRenderable — The IRenderable object to render to a depth map.
| |
target:Matrix3D (default = null) |
Matrix3D — A Matrix3D object containing the projection transformation.
|
| updateBounds | () | method |
override protected function updateBounds():voidUpdates the bounding volume for the object. Overriding methods need to set invalid flag to false!