Packageaway3d.materials.methods
Classpublic class PlanarReflectionMethod
InheritancePlanarReflectionMethod Inheritance EffectMethodBase Inheritance ShadingMethodBase Inheritance flash.events.EventDispatcher

PlanarReflectionMethod is a material method that adds reflections from a PlanarReflectionTexture object.

See also

away3d.textures.PlanarReflectionTexture


Public Properties
 PropertyDefined By
  alpha : Number
The reflectiveness of the surface.
PlanarReflectionMethod
  normalDisplacement : Number
The amount of displacement on the surface, for use with water waves.
PlanarReflectionMethod
 Inheritedpasses : Vector.<MaterialPassBase>
[read-only] Any passes required that render to a texture used by this method.
ShadingMethodBase
  texture : PlanarReflectionTexture
The PlanarReflectionTexture used to render the reflected view.
PlanarReflectionMethod
Protected Properties
 PropertyDefined By
 Inherited_passes : Vector.<MaterialPassBase>
ShadingMethodBase
 Inherited_sharedRegisters : ShaderRegisterData
ShadingMethodBase
Public Methods
 MethodDefined By
  
Creates a new PlanarReflectionMethod
PlanarReflectionMethod
 Inherited
Copies the state from a ShadingMethodBase object into the current object.
ShadingMethodBase
 Inherited
dispose():void
Cleans up any resources used by the current object.
ShadingMethodBase
Protected Methods
 MethodDefined By
 Inherited
getTex2DSampleCode(vo:MethodVO, targetReg:ShaderRegisterElement, inputReg:ShaderRegisterElement, texture:TextureProxyBase, uvReg:ShaderRegisterElement = null, forceWrap:String = null):String
A helper method that generates standard code for sampling from a texture using the normal uv coordinates.
ShadingMethodBase
 Inherited
ShadingMethodBase
 Inherited
Marks the shader program as invalid, so it will be recompiled before the next render.
ShadingMethodBase
Property Detail
alphaproperty
alpha:Number

The reflectiveness of the surface.


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
normalDisplacementproperty 
normalDisplacement:Number

The amount of displacement on the surface, for use with water waves.


Implementation
    public function get normalDisplacement():Number
    public function set normalDisplacement(value:Number):void
textureproperty 
texture:PlanarReflectionTexture

The PlanarReflectionTexture used to render the reflected view.


Implementation
    public function get texture():PlanarReflectionTexture
    public function set texture(value:PlanarReflectionTexture):void
Constructor Detail
PlanarReflectionMethod()Constructor
public function PlanarReflectionMethod(texture:PlanarReflectionTexture, alpha:Number = 1)

Creates a new PlanarReflectionMethod

Parameters
texture:PlanarReflectionTexture — The PlanarReflectionTexture used to render the reflected view.
 
alpha:Number (default = 1) — The reflectiveness of the surface.
Method Detail
activate()method
override arcane function activate(vo:MethodVO, stage3DProxy:Stage3DProxy):void

Parameters

vo:MethodVO
 
stage3DProxy:Stage3DProxy

getFragmentCode()method 
override arcane function getFragmentCode(vo:MethodVO, regCache:ShaderRegisterCache, targetReg:ShaderRegisterElement):String

Parameters

vo:MethodVO
 
regCache:ShaderRegisterCache
 
targetReg:ShaderRegisterElement

Returns
String
initVO()method 
override arcane function initVO(vo:MethodVO):void

Parameters

vo:MethodVO