away3d.materials.methods.PlanarReflectionMethod

	Property	Defined By
		alpha : Number The reflectivity of the surface.	PlanarReflectionMethod
		assetFullPath : Array [read-only]	NamedAssetBase
		assetNamespace : String [read-only]	NamedAssetBase
		assetType : String [read-only] The type of the asset.	EffectMethodBase
		id : String	NamedAssetBase
		name : String	NamedAssetBase
		normalDisplacement : Number The amount of displacement on the surface, for use with water waves.	PlanarReflectionMethod
		originalName : String [read-only] The original name used for this asset in the resource (e.g.	NamedAssetBase
		passes : 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

Property

Defined By

alpha : Number

The reflectivity of the surface.

PlanarReflectionMethod

assetFullPath : Array

[read-only]

NamedAssetBase

assetNamespace : String

[read-only]

NamedAssetBase

assetType : String

[read-only] The type of the asset.

EffectMethodBase

id : String

NamedAssetBase

name : String

NamedAssetBase

normalDisplacement : Number

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

PlanarReflectionMethod

originalName : String

[read-only] The original name used for this asset in the resource (e.g.

NamedAssetBase

passes : 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

	Property	Defined By
		_passes : Vector.<MaterialPassBase>	ShadingMethodBase
		_sharedRegisters : ShaderRegisterData	ShadingMethodBase

Property

Defined By

_passes : Vector.<MaterialPassBase>

ShadingMethodBase

_sharedRegisters : ShaderRegisterData

ShadingMethodBase

	Method	Defined By
		PlanarReflectionMethod(texture:PlanarReflectionTexture, alpha:Number = 1) Creates a new PlanarReflectionMethod	PlanarReflectionMethod
		assetPathEquals(name:String, ns:String):Boolean	NamedAssetBase
		copyFrom(method:ShadingMethodBase):void Copies the state from a ShadingMethodBase object into the current object.	ShadingMethodBase
		dispose():void Cleans up any resources used by the current object.	ShadingMethodBase
		resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void	NamedAssetBase

Method

Defined By

PlanarReflectionMethod(texture:PlanarReflectionTexture, alpha:Number = 1)

Creates a new PlanarReflectionMethod

PlanarReflectionMethod

assetPathEquals(name:String, ns:String):Boolean

NamedAssetBase

copyFrom(method:ShadingMethodBase):void

Copies the state from a ShadingMethodBase object into the current object.

ShadingMethodBase

dispose():void

Cleans up any resources used by the current object.

ShadingMethodBase

resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void

NamedAssetBase

	Method	Defined By
		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
		getTexCubeSampleCode(vo:MethodVO, targetReg:ShaderRegisterElement, inputReg:ShaderRegisterElement, texture:TextureProxyBase, uvReg:ShaderRegisterElement):String A helper method that generates standard code for sampling from a cube texture.	ShadingMethodBase
		invalidateShaderProgram():void Marks the shader program as invalid, so it will be recompiled before the next render.	ShadingMethodBase

Method

Defined By

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

getTexCubeSampleCode(vo:MethodVO, targetReg:ShaderRegisterElement, inputReg:ShaderRegisterElement, texture:TextureProxyBase, uvReg:ShaderRegisterElement):String

A helper method that generates standard code for sampling from a cube texture.

ShadingMethodBase

invalidateShaderProgram():void

Marks the shader program as invalid, so it will be recompiled before the next render.

ShadingMethodBase

	Constant	Defined By
		DEFAULT_NAMESPACE : String = default [static]	NamedAssetBase

Constant

Defined By

DEFAULT_NAMESPACE : String = default

[static]

NamedAssetBase

Property Detail

alpha

property

alpha:Number

The reflectivity of the surface.

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

normalDisplacement

property

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

texture

property

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 reflectivity 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

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.

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

Away3D 4.1 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
PlanarReflectionMethod	Properties \| Methods \| Constants

Package	away3d.materials.methods
Class	public class PlanarReflectionMethod
Inheritance	PlanarReflectionMethod EffectMethodBase ShadingMethodBase NamedAssetBase flash.events.EventDispatcher