away3d.materials.methods.RimLightMethod

	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 to add the light to the object.	RimLightMethod
		color : uint The color of the rim light.	RimLightMethod
		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
		power : Number The power of the rim light.	RimLightMethod
		strength : Number The strength of the rim light.	RimLightMethod

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 to add the light to the object.

RimLightMethod

color : uint

The color of the rim light.

RimLightMethod

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

power : Number

The power of the rim light.

RimLightMethod

strength : Number

The strength of the rim light.

RimLightMethod

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

Property

Defined By

_passes : Vector.<MaterialPassBase>

ShadingMethodBase

_sharedRegisters : ShaderRegisterData

ShadingMethodBase

	Method	Defined By
		RimLightMethod(color:uint = 0xffffff, strength:Number = .4, power:Number = 2, blend:String = mix) Creates a new RimLightMethod.	RimLightMethod
		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

RimLightMethod(color:uint = 0xffffff, strength:Number = .4, power:Number = 2, blend:String = mix)

Creates a new RimLightMethod.

RimLightMethod

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]	RimLightMethod
		DEFAULT_NAMESPACE : String = default [static]	NamedAssetBase
		MIX : String = mix [static]	RimLightMethod
		MULTIPLY : String = multiply [static]	RimLightMethod

Constant

Defined By

ADD : String = add

[static]

RimLightMethod

DEFAULT_NAMESPACE : String = default

[static]

NamedAssetBase

MIX : String = mix

[static]

RimLightMethod

MULTIPLY : String = multiply

[static]

RimLightMethod

Property Detail

blendMode

property

blendMode:String

The blend mode with which to add the light to the object. RimLightMethod.MULTIPLY multiplies the rim light with the material's colour. RimLightMethod.ADD adds the rim light with the material's colour. RimLightMethod.MIX provides normal alpha blending.

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

color

property

color:uint

The color of the rim light.

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

power

property

power:Number

The power of the rim light. Higher values will result in a higher edge fall-off.

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

strength

property

strength:Number

The strength of the rim light.

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

Constructor Detail

RimLightMethod

()

Constructor

public function RimLightMethod(color:uint = 0xffffff, strength:Number = .4, power:Number = 2, blend:String = mix)

Creates a new RimLightMethod.

Parameters

	`color:uint` (default = `0xffffff`) — The colour of the rim light.

	`strength:Number` (default = `.4`) — The strength of the rim light.

	`power:Number` (default = `2`) — The power of the rim light. Higher values will result in a higher edge fall-off.

	`blend:String` (default = `mix`) — The blend mode with which to add the light to the object.

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.

Constant Detail

ADD

Constant

public static const ADD:String = add

MIX

Constant

public static const MIX:String = mix

MULTIPLY

Constant

public static const MULTIPLY:String = multiply

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

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

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