away3d.materials.methods.FresnelSpecularMethod

Public Properties

	Property		Defined By
		assetFullPath : Array [read-only]	NamedAssetBase
		assetNamespace : String [read-only]	NamedAssetBase
		basedOnSurface : Boolean Defines whether the fresnel effect should be based on the view angle on the surface (if true), or on the angle between the light and the view.	FresnelSpecularMethod
		baseMethod : BasicSpecularMethod The base specular method on which this method's shading is based.	CompositeSpecularMethod
		fresnelPower : Number The power used in the Fresnel equation.	FresnelSpecularMethod
		gloss : Number [override] The sharpness of the specular highlight.	CompositeSpecularMethod
		id : String	NamedAssetBase
		name : String	NamedAssetBase
		normalReflectance : Number The minimum amount of reflectance, ie the reflectance when the view direction is normal to the surface or light direction.	FresnelSpecularMethod
		originalName : String [read-only] The original name used for this asset in the resource (e.g.	NamedAssetBase
		passes : Vector.<MaterialPassBase> [override] [read-only] Any passes required that render to a texture used by this method.	CompositeSpecularMethod
		specular : Number [override] The overall strength of the specular highlights.	CompositeSpecularMethod
		specularColor : uint The colour of the specular reflection of the surface.	BasicSpecularMethod
		texture : Texture2DBase [override] The bitmapData that encodes the specular highlight strength per texel in the red channel, and the sharpness in the green channel.	CompositeSpecularMethod

	Property	Defined By
		_isFirstLight : Boolean	BasicSpecularMethod
		_passes : Vector.<MaterialPassBase>	ShadingMethodBase
		_sharedRegisters : ShaderRegisterData	ShadingMethodBase
		_specularDataRegister : ShaderRegisterElement	BasicSpecularMethod
		_specularTexData : ShaderRegisterElement	BasicSpecularMethod
		_specularTextureRegister : ShaderRegisterElement	BasicSpecularMethod
		_totalLightColorReg : ShaderRegisterElement	BasicSpecularMethod
		_useTexture : Boolean	BasicSpecularMethod

	Method	Defined By
		FresnelSpecularMethod(basedOnSurface:Boolean = true, baseSpecularMethod:BasicSpecularMethod = null) Creates a new FresnelSpecularMethod object.	FresnelSpecularMethod
		assetPathEquals(name:String, ns:String):Boolean	NamedAssetBase
		copyFrom(method:ShadingMethodBase):void [override] Copies the state from a ShadingMethodBase object into the current object.	BasicSpecularMethod
		dispose():void [override] Cleans up any resources used by the current object.	CompositeSpecularMethod
		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

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

Property Detail

basedOnSurface

property

basedOnSurface:Boolean

Defines whether the fresnel effect should be based on the view angle on the surface (if true), or on the angle between the light and the view.

Implementation
public function get basedOnSurface():Boolean
public function set basedOnSurface(value:Boolean):void

fresnelPower

property

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

normalReflectance

property

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

Constructor Detail

FresnelSpecularMethod

()

Constructor

public function FresnelSpecularMethod(basedOnSurface:Boolean = true, baseSpecularMethod:BasicSpecularMethod = null)

Creates a new FresnelSpecularMethod object.

Parameters

	`basedOnSurface:Boolean` (default = `true`) — Defines whether the fresnel effect should be based on the view angle on the surface (if true), or on the angle between the light and the view.

	`baseSpecularMethod:BasicSpecularMethod` (default = `null`) — The specular method to which the fresnel equation. Defaults to BasicSpecularMethod.

Method Detail

activate

()

method

override arcane function activate(vo:MethodVO, stage3DProxy:Stage3DProxy):void

Parameters

	`vo:MethodVO`

	`stage3DProxy:Stage3DProxy`

cleanCompilationData

()

method

override arcane function cleanCompilationData():void

getFragmentPreLightingCode

()

method

override arcane function getFragmentPreLightingCode(vo:MethodVO, regCache:ShaderRegisterCache):String

Parameters

	`vo:MethodVO`

	`regCache:ShaderRegisterCache`

Returns

String

initConstants

()

method

override arcane function initConstants(vo:MethodVO):void

Initializes unchanging shader constants using the data from a MethodVO.

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
FresnelSpecularMethod	Properties \| Methods \| Constants

Package	away3d.materials.methods
Class	public class FresnelSpecularMethod
Inheritance	FresnelSpecularMethod CompositeSpecularMethod BasicSpecularMethod LightingMethodBase ShadingMethodBase NamedAssetBase flash.events.EventDispatcher