Packageaway3d.materials.methods
Classpublic class FresnelPlanarReflectionMethod
InheritanceFresnelPlanarReflectionMethod Inheritance EffectMethodBase Inheritance ShadingMethodBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

FresnelPlanarReflectionMethod provides a method to add fresnel-based planar reflections from a PlanarReflectionTexture object.to a surface, which get stronger as the viewing angle becomes more grazing. This method can be used for (near-)planar objects such as mirrors or water.

See also

away3d.textures.PlanarReflectionTexture


Public Properties
 PropertyDefined By
  alpha : Number
The reflectivity of the surface.
FresnelPlanarReflectionMethod
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only] The type of the asset.
EffectMethodBase
  fresnelPower : Number
The power used in the Fresnel equation.
FresnelPlanarReflectionMethod
 Inheritedid : String
NamedAssetBase
 Inheritedname : String
NamedAssetBase
  normalDisplacement : Number
The amount of displacement caused by per-pixel normals.
FresnelPlanarReflectionMethod
  normalReflectance : Number
The minimum amount of reflectance, ie the reflectance when the view direction is normal to the surface or light direction.
FresnelPlanarReflectionMethod
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
 Inheritedpasses : Vector.<MaterialPassBase>
[read-only] Any passes required that render to a texture used by this method.
ShadingMethodBase
  texture : PlanarReflectionTexture
The PlanarReflectionTexture containing a render of the mirrored scene.
FresnelPlanarReflectionMethod
Protected Properties
 PropertyDefined By
 Inherited_passes : Vector.<MaterialPassBase>
ShadingMethodBase
 Inherited_sharedRegisters : ShaderRegisterData
ShadingMethodBase
Public Methods
 MethodDefined By
  
Creates a new FresnelPlanarReflectionMethod object.
FresnelPlanarReflectionMethod
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 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
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
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
A helper method that generates standard code for sampling from a cube texture.
ShadingMethodBase
 Inherited
Marks the shader program as invalid, so it will be recompiled before the next render.
ShadingMethodBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Property Detail
alphaproperty
alpha:Number

The reflectivity of the surface.


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
fresnelPowerproperty 
fresnelPower:Number

The power used in the Fresnel equation. Higher values make the fresnel effect more pronounced. Defaults to 5.


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

The amount of displacement caused by per-pixel normals.


Implementation
    public function get normalDisplacement():Number
    public function set normalDisplacement(value:Number):void
normalReflectanceproperty 
normalReflectance:Number

The minimum amount of reflectance, ie the reflectance when the view direction is normal to the surface or light direction.


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

The PlanarReflectionTexture containing a render of the mirrored scene.


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

See also

Constructor Detail
FresnelPlanarReflectionMethod()Constructor
public function FresnelPlanarReflectionMethod(texture:PlanarReflectionTexture, alpha:Number = 1)

Creates a new FresnelPlanarReflectionMethod object.

Parameters
texture:PlanarReflectionTexture — The PlanarReflectionTexture containing a render of the mirrored scene.
 
alpha:Number (default = 1) — The maximum reflectivity of the surface.

See also

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

Initializes the properties for a MethodVO, including register and texture indices.

Parameters

vo:MethodVO — The MethodVO object linking this method with the pass currently being compiled.