away3d.materials.methods.FogMethod

	Property	Defined By
		assetFullPath : Array [read-only]	NamedAssetBase
		assetNamespace : String [read-only]	NamedAssetBase
		assetType : String [read-only] The type of the asset.	EffectMethodBase
		fogColor : uint The colour of the fog.	FogMethod
		id : String	NamedAssetBase
		maxDistance : Number The distance at which the fog is densest.	FogMethod
		minDistance : Number The distance from which the fog starts appearing.	FogMethod
		name : String	NamedAssetBase
		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

Property

Defined By

assetFullPath : Array

[read-only]

NamedAssetBase

assetNamespace : String

[read-only]

NamedAssetBase

assetType : String

[read-only] The type of the asset.

EffectMethodBase

fogColor : uint

The colour of the fog.

FogMethod

id : String

NamedAssetBase

maxDistance : Number

The distance at which the fog is densest.

FogMethod

minDistance : Number

The distance from which the fog starts appearing.

FogMethod

name : String

NamedAssetBase

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

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

Property

Defined By

_passes : Vector.<MaterialPassBase>

ShadingMethodBase

_sharedRegisters : ShaderRegisterData

ShadingMethodBase

	Method	Defined By
		FogMethod(minDistance:Number, maxDistance:Number, fogColor:uint = 0x808080) Creates a new FogMethod object.	FogMethod
		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

FogMethod(minDistance:Number, maxDistance:Number, fogColor:uint = 0x808080)

Creates a new FogMethod object.

FogMethod

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

fogColor

property

fogColor:uint

The colour of the fog.

Implementation
public function get fogColor():uint
public function set fogColor(value:uint):void

maxDistance

property

maxDistance:Number

The distance at which the fog is densest.

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

minDistance

property

minDistance:Number

The distance from which the fog starts appearing.

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

Constructor Detail

FogMethod

()

Constructor

public function FogMethod(minDistance:Number, maxDistance:Number, fogColor:uint = 0x808080)

Creates a new FogMethod object.

Parameters

	`minDistance:Number` — The distance from which the fog starts appearing.

	`maxDistance:Number` — The distance at which the fog is densest.

	`fogColor:uint` (default = `0x808080`) — The colour of the fog.

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

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.

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

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