away3d.materials.methods.LightMapMethod

	Property	Defined By
		assetFullPath : Array [read-only]	NamedAssetBase
		assetNamespace : String [read-only]	NamedAssetBase
		assetType : String [read-only] The type of the asset.	EffectMethodBase
		blendMode : String The blend mode with which the light map should be applied to the lighting result.	LightMapMethod
		id : String	NamedAssetBase
		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
		texture : Texture2DBase The texture containing the light map.	LightMapMethod

Property

Defined By

assetFullPath : Array

[read-only]

NamedAssetBase

assetNamespace : String

[read-only]

NamedAssetBase

assetType : String

[read-only] The type of the asset.

EffectMethodBase

blendMode : String

The blend mode with which the light map should be applied to the lighting result.

LightMapMethod

id : String

NamedAssetBase

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

texture : Texture2DBase

The texture containing the light map.

LightMapMethod

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

Property

Defined By

_passes : Vector.<MaterialPassBase>

ShadingMethodBase

_sharedRegisters : ShaderRegisterData

ShadingMethodBase

	Method	Defined By
		LightMapMethod(texture:Texture2DBase, blendMode:String = multiply, useSecondaryUV:Boolean = false) Creates a new LightMapMethod object.	LightMapMethod
		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

LightMapMethod(texture:Texture2DBase, blendMode:String = multiply, useSecondaryUV:Boolean = false)

Creates a new LightMapMethod object.

LightMapMethod

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
		ADD : String = add [static] Indicates the light map should be added into the calculated shading result.	LightMapMethod
		DEFAULT_NAMESPACE : String = default [static]	NamedAssetBase
		MULTIPLY : String = multiply [static] Indicates the light map should be multiplied with the calculated shading result.	LightMapMethod

Constant

Defined By

ADD : String = add

[static] Indicates the light map should be added into the calculated shading result.

LightMapMethod

DEFAULT_NAMESPACE : String = default

[static]

NamedAssetBase

MULTIPLY : String = multiply

[static] Indicates the light map should be multiplied with the calculated shading result.

LightMapMethod

Property Detail

blendMode

property

blendMode:String

The blend mode with which the light map should be applied to the lighting result.

Implementation
public function get blendMode():String
public function set blendMode(value:String):void

See also

LightMapMethod.ADD
LightMapMethod.MULTIPLY

texture

property

texture:Texture2DBase

The texture containing the light map.

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

Constructor Detail

LightMapMethod

()

Constructor

public function LightMapMethod(texture:Texture2DBase, blendMode:String = multiply, useSecondaryUV:Boolean = false)

Creates a new LightMapMethod object.

Parameters

	`texture:Texture2DBase` — The texture containing the light map.

	`blendMode:String` (default = `multiply`) — The blend mode with which the light map should be applied to the lighting result.

	`useSecondaryUV:Boolean` (default = `false`) — Indicates whether the secondary UV set should be used to map the light map.

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.

Constant Detail

ADD

Constant

public static const ADD:String = add

Indicates the light map should be added into the calculated shading result.

MULTIPLY

Constant

public static const MULTIPLY:String = multiply

Indicates the light map should be multiplied with the calculated shading result.

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

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

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