Packageaway3d.materials.passes
Classpublic class SingleObjectDepthPass
InheritanceSingleObjectDepthPass Inheritance MaterialPassBase Inheritance flash.events.EventDispatcher

The SingleObjectDepthPass provides a material pass that renders a single object to a depth map from the point of view from a light.


Public Properties
 PropertyDefined By
 InheritedalphaPremultiplied : Boolean
Indicates whether visible textures (or other pixels) used by this material have already been premultiplied.
MaterialPassBase
 InheritedanimationRegisterCache : AnimationRegisterCache
MaterialPassBase
 InheritedanimationSet : IAnimationSet
Returns the animation data set adding animations to the material.
MaterialPassBase
 InheritedbothSides : Boolean
Defines whether or not the material should perform backface culling.
MaterialPassBase
 InheriteddepthCompareMode : String
The depth compare mode used to render the renderables using this material.
MaterialPassBase
 Inheritedmaterial : MaterialBase
The material to which this pass belongs.
MaterialPassBase
 Inheritedmipmap : Boolean
Defines whether any used textures should use mipmapping.
MaterialPassBase
 InheritedneedFragmentAnimation : Boolean
[read-only]
MaterialPassBase
 InheritedneedUVAnimation : Boolean
[read-only] Indicates whether the pass requires any UV animatin code.
MaterialPassBase
 InheritednumUsedFragmentConstants : uint
[read-only] The amount of used fragment constants in the fragment code.
MaterialPassBase
 InheritednumUsedStreams : uint
[read-only] The amount of used vertex streams in the vertex code.
MaterialPassBase
 InheritednumUsedVaryings : uint
[read-only]
MaterialPassBase
 InheritednumUsedVertexConstants : uint
[read-only] The amount of used vertex constants in the vertex code.
MaterialPassBase
 InheritedrenderToTexture : Boolean
[read-only] Specifies whether this pass renders to texture
MaterialPassBase
 Inheritedrepeat : Boolean
Defines whether textures should be tiled.
MaterialPassBase
 Inheritedsmooth : Boolean
Defines whether smoothing should be applied to any used textures.
MaterialPassBase
 InheritedwriteDepth : Boolean
Indicate whether this pass should write to the depth buffer or not.
MaterialPassBase
Protected Properties
 PropertyDefined By
 Inherited_alphaPremultiplied : Boolean
MaterialPassBase
 Inherited_animatableAttributes : Vector.<String>
MaterialPassBase
 Inherited_animationSet : IAnimationSet
MaterialPassBase
 Inherited_animationTargetRegisters : Vector.<String>
MaterialPassBase
 Inherited_blendFactorDest : String = zero
MaterialPassBase
 Inherited_blendFactorSource : String = one
MaterialPassBase
 Inherited_defaultCulling : String = back
MaterialPassBase
 Inherited_depthCompareMode : String = lessEqual
MaterialPassBase
 Inherited_enableBlending : Boolean
MaterialPassBase
 Inherited_lightPicker : LightPickerBase
MaterialPassBase
 Inherited_material : MaterialBase
MaterialPassBase
 Inherited_mipmap : Boolean = true
MaterialPassBase
 Inherited_needFragmentAnimation : Boolean
MaterialPassBase
 Inherited_needUVAnimation : Boolean
MaterialPassBase
 Inherited_numUsedFragmentConstants : uint
MaterialPassBase
 Inherited_numUsedStreams : uint
MaterialPassBase
 Inherited_numUsedTextures : uint
MaterialPassBase
 Inherited_numUsedVaryings : uint
MaterialPassBase
 Inherited_numUsedVertexConstants : uint
MaterialPassBase
 Inherited_repeat : Boolean = false
MaterialPassBase
 Inherited_shadedTarget : String = ft0
MaterialPassBase
 Inherited_smooth : Boolean = true
MaterialPassBase
 Inherited_UVSource : String
MaterialPassBase
 Inherited_UVTarget : String
MaterialPassBase
 Inherited_writeDepth : Boolean = true
MaterialPassBase
Public Methods
 MethodDefined By
  
SingleObjectDepthPass(textureSize:uint = 512, polyOffset:Number = 15)
Creates a new SingleObjectDepthPass object.
SingleObjectDepthPass
  
dispose():void
[override] Cleans up any resources used by the current object.
SingleObjectDepthPass
 Inherited
setBlendMode(value:String):void
The blend mode to use when drawing this renderable.
MaterialPassBase
Protected Methods
 MethodDefined By
 Inherited
updateLights():void
Implemented by subclasses if the pass uses lights to update the shader.
MaterialPassBase
Constructor Detail
SingleObjectDepthPass()Constructor
public function SingleObjectDepthPass(textureSize:uint = 512, polyOffset:Number = 15)

Creates a new SingleObjectDepthPass object.

Parameters
textureSize:uint (default = 512) — The size of the depth map texture to render to.
 
polyOffset:Number (default = 15) — The amount by which the rendered object will be inflated, to prevent depth map rounding errors. todo: provide custom vertex code to assembler
Method Detail
activate()method
override arcane function activate(stage3DProxy:Stage3DProxy, camera:Camera3D):void

Parameters

stage3DProxy:Stage3DProxy
 
camera:Camera3D

dispose()method 
override public function dispose():void

Cleans up any resources used by the current object.

getDepthMap()method 
arcane function getDepthMap(renderable:IRenderable, stage3DProxy:Stage3DProxy):Texture

Gets the depth maps rendered for this object from all lights.

Parameters

renderable:IRenderable — The renderable for which to retrieve the depth maps.
 
stage3DProxy:Stage3DProxy — The Stage3DProxy object currently used for rendering.

Returns
Texture — A list of depth map textures for all supported lights.
getFragmentCode()method 
override arcane function getFragmentCode(animationCode:String):String

Returns the fragment AGAL code for the material.

Parameters

animationCode:String

Returns
String
getProjection()method 
arcane function getProjection(renderable:IRenderable):Matrix3D

Retrieves the depth map projection maps for all lights.

Parameters

renderable:IRenderable — The renderable for which to retrieve the projection maps.

Returns
Matrix3D — A list of projection maps for all supported lights.
getVertexCode()method 
override arcane function getVertexCode():String

Returns the vertex AGAL code for the material.

Returns
String
render()method 
override arcane function render(renderable:IRenderable, stage3DProxy:Stage3DProxy, camera:Camera3D, viewProjection:Matrix3D):void

Parameters

renderable:IRenderable
 
stage3DProxy:Stage3DProxy
 
camera:Camera3D
 
viewProjection:Matrix3D





Thu Jul 11 2013, 08:55 PM +01:00