Packageaway3d.materials
Classpublic class OcclusionMaterial
InheritanceOcclusionMaterial Inheritance ColorMaterial Inheritance SinglePassMaterialBase Inheritance MaterialBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

OcclusionMaterial is a ColorMaterial for an object, that hides all other objects behind itself.



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The alpha of the surface.
ColorMaterial
 InheritedalphaBlending : Boolean
Indicate whether or not the material has transparency.
SinglePassMaterialBase
 InheritedalphaPremultiplied : Boolean
Indicates whether visible textures (or other pixels) used by this material have already been premultiplied.
MaterialBase
 InheritedalphaThreshold : Number
The minimum alpha value for which pixels should be drawn.
SinglePassMaterialBase
 Inheritedambient : Number
The strength of the ambient reflection.
SinglePassMaterialBase
 InheritedambientColor : uint
The colour of the ambient reflection.
SinglePassMaterialBase
 InheritedambientMethod : BasicAmbientMethod
The method to perform ambient shading.
SinglePassMaterialBase
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only]
MaterialBase
 InheritedblendMode : String
[override]
SinglePassMaterialBase
 InheritedbothSides : Boolean
Defines whether or not the material should perform backface culling.
MaterialBase
 Inheritedcolor : uint
The diffuse color of the surface.
ColorMaterial
 InheritedcolorTransform : ColorTransform
The ColorTransform object to transform the colour of the material with.
SinglePassMaterialBase
 InheriteddepthCompareMode : String
[override]
SinglePassMaterialBase
 InheriteddiffuseLightSources : uint
SinglePassMaterialBase
 InheriteddiffuseMethod : BasicDiffuseMethod
The method to perform diffuse shading.
SinglePassMaterialBase
 InheritedenableLightFallOff : Boolean
Whether or not to use fallOff and radius properties for lights.
SinglePassMaterialBase
 Inheritedextra : Object
An object to contain any extra data
MaterialBase
 Inheritedgloss : Number
The sharpness of the specular highlight.
SinglePassMaterialBase
 InheritedlightPicker : LightPickerBase
[override]
SinglePassMaterialBase
 Inheritedmipmap : Boolean
[override] Indicates whether or not any used textures should use mipmapping.
SinglePassMaterialBase
 Inheritedname : String
NamedAssetBase
 InheritednormalMap : Texture2DBase
The tangent space normal map to influence the direction of the surface for each texel.
SinglePassMaterialBase
 InheritednormalMethod : BasicNormalMethod
The method to generate the (tangent-space) normal.
SinglePassMaterialBase
 InheritednumMethods : int
[read-only]
SinglePassMaterialBase
  occlude : Boolean
Whether or not an object with this material applied hides other objects.
OcclusionMaterial
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
 Inheritedrepeat : Boolean
Indicates whether or not any used textures should be tiled.
MaterialBase
 InheritedrequiresBlending : Boolean
[override] [read-only] Indicates whether or not the material requires alpha blending during rendering.
ColorMaterial
 InheritedshadowMethod : ShadowMapMethodBase
The method to render shadows cast on this surface.
SinglePassMaterialBase
 Inheritedsmooth : Boolean
Indicates whether or not any used textures should use smoothing.
MaterialBase
 Inheritedspecular : Number
The overall strength of the specular reflection.
SinglePassMaterialBase
 InheritedspecularColor : uint
The colour of the specular reflection.
SinglePassMaterialBase
 InheritedspecularLightSources : uint
SinglePassMaterialBase
 InheritedspecularMap : Texture2DBase
A specular map that defines the strength of specular reflections for each texel in the red channel, and the gloss factor in the green channel.
SinglePassMaterialBase
 InheritedspecularMethod : BasicSpecularMethod
The method to perform specular shading.
SinglePassMaterialBase
 InheriteduniqueId : uint
[read-only] The unique id assigned to the material by the MaterialLibrary.
MaterialBase
Protected Properties
 PropertyDefined By
 Inherited_depthPass : DepthMapPass
MaterialBase
 Inherited_distancePass : DistanceMapPass
MaterialBase
 Inherited_lightPicker : LightPickerBase
MaterialBase
 Inherited_mipmap : Boolean = true
MaterialBase
 Inherited_numPasses : uint
MaterialBase
 Inherited_passes : Vector.<MaterialPassBase>
MaterialBase
 Inherited_repeat : Boolean
MaterialBase
 Inherited_screenPass : SuperShaderPass
SinglePassMaterialBase
 Inherited_smooth : Boolean = true
MaterialBase
Public Methods
 MethodDefined By
  
OcclusionMaterial(occlude:Boolean = true, color:uint = 0xcccccc, alpha:Number = 1)
Creates a new OcclusionMaterial object.
OcclusionMaterial
 Inherited
Adds a shading method to the end of the shader.
SinglePassMaterialBase
 Inherited
addMethodAt(method:EffectMethodBase, index:int):void
Adds a shading method to the end of a shader, at the specified index amongst the methods in that section of the shader.
SinglePassMaterialBase
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
dispose():void
Cleans up any resources used by the current object.
MaterialBase
 Inherited
SinglePassMaterialBase
 Inherited
hasMethod(method:EffectMethodBase):Boolean
SinglePassMaterialBase
 Inherited
SinglePassMaterialBase
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Protected Methods
 MethodDefined By
 Inherited
Adds a pass to the material
MaterialBase
 Inherited
Clears all passes in the material.
MaterialBase
 Inherited
MaterialBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Property Detail
occludeproperty
occlude:Boolean

Whether or not an object with this material applied hides other objects.


Implementation
    public function get occlude():Boolean
    public function set occlude(value:Boolean):void
Constructor Detail
OcclusionMaterial()Constructor
public function OcclusionMaterial(occlude:Boolean = true, color:uint = 0xcccccc, alpha:Number = 1)

Creates a new OcclusionMaterial object.

Parameters
occlude:Boolean (default = true) — Whether or not to occlude other objects.
 
color:uint (default = 0xcccccc) — The material's diffuse surface color.
 
alpha:Number (default = 1) — The material's surface alpha.
Method Detail
activatePass()method
override arcane function activatePass(index:uint, stage3DProxy:Stage3DProxy, camera:Camera3D):void

Parameters

index:uint
 
stage3DProxy:Stage3DProxy
 
camera:Camera3D

deactivatePass()method 
override arcane function deactivatePass(index:uint, stage3DProxy:Stage3DProxy):void

Parameters

index:uint
 
stage3DProxy:Stage3DProxy