| Package | away3d.materials.methods |
| Class | public class CompositeSpecularMethod |
| Inheritance | CompositeSpecularMethod  BasicSpecularMethod LightingMethodBase ShadingMethodBase NamedAssetBase flash.events.EventDispatcher |
| Subclasses | CelSpecularMethod, FresnelSpecularMethod |
| Property | Defined By | ||
|---|---|---|---|
 | assetFullPath : Array [read-only] | NamedAssetBase | |
| assetNamespace : String [read-only] | NamedAssetBase | |
| baseMethod : BasicSpecularMethod
The base specular method on which this method's shading is based. | CompositeSpecularMethod | ||
| gloss : Number [override]
The sharpness of the specular highlight. | CompositeSpecularMethod | ||
| 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> [override] [read-only]
Any passes required that render to a texture used by this method. | CompositeSpecularMethod | ||
| specular : Number [override]
The overall strength of the specular highlights. | CompositeSpecularMethod | ||
| specularColor : uint
The colour of the specular reflection of the surface. | BasicSpecularMethod | |
| texture : Texture2DBase [override]
The bitmapData that encodes the specular highlight strength per texel in the red channel, and the sharpness
in the green channel. | CompositeSpecularMethod | ||
| Method | Defined By | ||
|---|---|---|---|
CompositeSpecularMethod(modulateMethod:Function, baseSpecularMethod:BasicSpecularMethod = null)
Creates a new WrapSpecularMethod object. | CompositeSpecularMethod | ||
| assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | |
| copyFrom(method:ShadingMethodBase):void [override]
Copies the state from a ShadingMethodBase object into the current object. | BasicSpecularMethod | |
dispose():void [override]
Cleans up any resources used by the current object. | CompositeSpecularMethod | ||
| resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase | |
| baseMethod | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbaseMethod:BasicSpecularMethodThe base specular method on which this method's shading is based.
public function get baseMethod():BasicSpecularMethod public function set baseMethod(value:BasicSpecularMethod):void| gloss | property |
gloss:Number[override] The sharpness of the specular highlight.
public function get gloss():Number public function set gloss(value:Number):void| passes | property |
passes:Vector.<MaterialPassBase> [read-only] [override] Any passes required that render to a texture used by this method.
public function get passes():Vector.<MaterialPassBase>| shadowRegister | property |
shadowRegister:ShaderRegisterElement [write-only] [override] Set internally by the compiler, so the method knows the register containing the shadow calculation.
arcane function set shadowRegister(value:ShaderRegisterElement):void| sharedRegisters | property |
sharedRegisters:ShaderRegisterData[override] The shared registers created by the compiler and possibly used by methods.
arcane function get sharedRegisters():ShaderRegisterData arcane function set sharedRegisters(value:ShaderRegisterData):void| specular | property |
specular:Number[override] The overall strength of the specular highlights.
public function get specular():Number public function set specular(value:Number):void| texture | property |
texture:Texture2DBase[override] The bitmapData that encodes the specular highlight strength per texel in the red channel, and the sharpness in the green channel. You can use SpecularBitmapTexture if you want to easily set specular and gloss maps from grayscale images, but prepared images are preferred.
public function get texture():Texture2DBase public function set texture(value:Texture2DBase):void| CompositeSpecularMethod | () | Constructor |
public function CompositeSpecularMethod(modulateMethod:Function, baseSpecularMethod:BasicSpecularMethod = null)Creates a new WrapSpecularMethod object.
ParametersmodulateMethod:Function — The method which will add the code to alter the base method's strength. It needs to have the signature modSpecular(t : ShaderRegisterElement, regCache : ShaderRegisterCache) : String, in which t.w will contain the specular strength and t.xyz will contain the half-vector or the reflection vector.
| |
baseSpecularMethod:BasicSpecularMethod (default = null) |
| activate | () | method |
override arcane function activate(vo:MethodVO, stage3DProxy:Stage3DProxy):void
Parameters
vo:MethodVO | |
stage3DProxy:Stage3DProxy |
| cleanCompilationData | () | method |
override arcane function cleanCompilationData():void
| deactivate | () | method |
override arcane function deactivate(vo:MethodVO, stage3DProxy:Stage3DProxy):voidClears the render state for this method.
Parameters
vo:MethodVO — The MethodVO object linking this method with the pass currently being compiled.
| |
stage3DProxy:Stage3DProxy — The Stage3DProxy object currently used for rendering.
|
| dispose | () | method |
override public function dispose():voidCleans up any resources used by the current object.
| getFragmentCodePerLight | () | method |
override arcane function getFragmentCodePerLight(vo:MethodVO, lightDirReg:ShaderRegisterElement, lightColReg:ShaderRegisterElement, regCache:ShaderRegisterCache):StringGet the fragment shader code that will generate the code relevant to a single light.
Parameters
vo:MethodVO — The MethodVO object containing the method data for the currently compiled material pass.
| |
lightDirReg:ShaderRegisterElement — The register containing the light direction vector.
| |
lightColReg:ShaderRegisterElement — The register containing the light colour.
| |
regCache:ShaderRegisterCache — The register cache used during the compilation.
|
String |
| getFragmentCodePerProbe | () | method |
override arcane function getFragmentCodePerProbe(vo:MethodVO, cubeMapReg:ShaderRegisterElement, weightRegister:String, regCache:ShaderRegisterCache):StringGet the fragment shader code that will generate the code relevant to a single light probe object.
Parameters
vo:MethodVO — The MethodVO object containing the method data for the currently compiled material pass.
| |
cubeMapReg:ShaderRegisterElement — The register containing the cube map for the current probe
| |
weightRegister:String — A string representation of the register + component containing the current weight
| |
regCache:ShaderRegisterCache — The register cache providing any necessary registers to the shader
|
String — |
| getFragmentPostLightingCode | () | method |
override arcane function getFragmentPostLightingCode(vo:MethodVO, regCache:ShaderRegisterCache, targetReg:ShaderRegisterElement):String
Parameters
vo:MethodVO | |
regCache:ShaderRegisterCache | |
targetReg:ShaderRegisterElement |
String |
| getFragmentPreLightingCode | () | method |
override arcane function getFragmentPreLightingCode(vo:MethodVO, regCache:ShaderRegisterCache):String
Parameters
vo:MethodVO | |
regCache:ShaderRegisterCache |
String |
| getVertexCode | () | method |
override arcane function getVertexCode(vo:MethodVO, regCache:ShaderRegisterCache):String
Parameters
vo:MethodVO | |
regCache:ShaderRegisterCache |
String |
| initConstants | () | method |
override arcane function initConstants(vo:MethodVO):voidInitializes 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):voidInitializes 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.
|
| reset | () | method |
override arcane function reset():voidResets the compilation state of the method.