Packageaway3d.materials.methods
Classpublic class BasicAmbientMethod
InheritanceBasicAmbientMethod Inheritance ShadingMethodBase
SubclassesEnvMapAmbientMethod

BasicAmbientMethod provides the default shading method for uniform ambient lighting.

Public Properties
 PropertyDefined by
  ambient : Number
The strength of the ambient reflection of the surface.
BasicAmbientMethod
  ambientColor : uint
The colour of the ambient reflection of the surface.
BasicAmbientMethod
 Inheritedpasses : Vector
Any passes required that render to a texture used by this method.
ShadingMethodBase
 InheritedviewDirVaryingReg : ShaderRegisterElement
ShadingMethodBase
Protected Properties
 PropertyDefined by
  _ambientInputIndex : int
BasicAmbientMethod
  _ambientInputRegister : ShaderRegisterElement
BasicAmbientMethod
 Inherited_globalPosVertexReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_mipmap : Boolean = true
ShadingMethodBase
 Inherited_needsGlobalPos : Boolean
ShadingMethodBase
 Inherited_needsNormals : Boolean
ShadingMethodBase
 Inherited_needsProjection : Boolean
ShadingMethodBase
 Inherited_needsUV : Boolean
ShadingMethodBase
 Inherited_needsView : Boolean
ShadingMethodBase
 Inherited_normalFragmentReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_numLights : int
ShadingMethodBase
 Inherited_passes : Vector
ShadingMethodBase
 Inherited_projectionReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_repeat : Boolean
ShadingMethodBase
 Inherited_smooth : Boolean = true
ShadingMethodBase
 Inherited_uvFragmentReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_viewDirFragmentReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_viewDirVaryingReg : ShaderRegisterElement
ShadingMethodBase
Public Methods
 MethodDefined by
  
Creates a new BasicAmbientMethod object.
BasicAmbientMethod
  
Copies the state from a BasicAmbientMethod object into the current object.
BasicAmbientMethod
 Inherited
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
ShadingMethodBase
Protected Methods
 MethodDefined by
 Inherited
A helper method that generates standard code for sampling from a texture using the normal uv coordinates.
ShadingMethodBase
 Inherited
Marks the shader program as invalid, so it will be recompiled before the next render.
ShadingMethodBase
Property detail
ambientproperty
ambient:Number  [read-write]

The strength of the ambient reflection of the surface.

Implementation
    public function get ambient():Number
    public function set ambient(value:Number):void
ambientColorproperty 
ambientColor:uint  [read-write]

The colour of the ambient reflection of the surface.

Implementation
    public function get ambientColor():uint
    public function set ambientColor(value:uint):void
_ambientInputIndexproperty 
protected var _ambientInputIndex:int
_ambientInputRegisterproperty 
protected var _ambientInputRegister:ShaderRegisterElement
numLightsproperty 
numLights:int  [read-write]

Implementation
    arcane function get numLights():int
    arcane function set numLights(value:int):void
Constructor detail
BasicAmbientMethod()constructor
public function BasicAmbientMethod() Init Parameters
Method detail
activate()method
arcane override function activate(context:Context3D, contextIndex:uint):void

Sets the render state for this method.

Parameters
context:Context3D — The Context3D currently used for rendering.
 
contextIndex:uint
copyFrom()method 
public override function copyFrom(method:ShadingMethodBase):void

Copies the state from a BasicAmbientMethod object into the current object.

Parameters
method:ShadingMethodBase
getFragmentPostLightingCode()method 
arcane override function getFragmentPostLightingCode(regCache:ShaderRegisterCache, targetReg:ShaderRegisterElement):String

Get the fragment shader code that should be added after all per-light code. Usually composits everything to the target register.

Parameters
regCache:ShaderRegisterCache — The register cache used during the compilation.
 
targetReg:ShaderRegisterElement

Returns
String
Wiki link
Click to go to the wiki page for 'away3d.materials.methods.BasicAmbientMethod'

Code examples

Comments