away3d.materials.methods.AlphaMaskMethod

	Property	Defined By
		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
		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 to use as the alpha mask.	AlphaMaskMethod
		useSecondaryUV : Boolean Indicated whether or not the secondary uv set for the mask.	AlphaMaskMethod

Property

Defined By

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

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 to use as the alpha mask.

AlphaMaskMethod

useSecondaryUV : Boolean

Indicated whether or not the secondary uv set for the mask.

AlphaMaskMethod

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

Property

Defined By

_passes : Vector.<MaterialPassBase>

ShadingMethodBase

_sharedRegisters : ShaderRegisterData

ShadingMethodBase

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

AlphaMaskMethod(texture:Texture2DBase, useSecondaryUV:Boolean = false)

Creates a new AlphaMaskMethod object

AlphaMaskMethod

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

texture

property

texture:Texture2DBase

The texture to use as the alpha mask.

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

useSecondaryUV

property

useSecondaryUV:Boolean

Indicated whether or not the secondary uv set for the mask. This allows mapping alpha independently, for instance to tile the main texture and normal map while providing untiled alpha, for example to define the transparency over a tiled water surface.

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

Constructor Detail

AlphaMaskMethod

()

Constructor

public function AlphaMaskMethod(texture:Texture2DBase, useSecondaryUV:Boolean = false)

Creates a new AlphaMaskMethod object

Parameters

	`texture:Texture2DBase` — The texture to use as the alpha mask.

	`useSecondaryUV:Boolean` (default = `false`) — Indicated whether or not the secondary uv set for the mask. This allows mapping alpha independently.

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

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