View source

class OcclusionMaterial

package away3d.materials

extends ColorMaterial › SinglePassMaterialBase › MaterialBase › NamedAssetBase

Available on all platforms

OcclusionMaterial is a ColorMaterial for an object to prevents drawing anything that is placed behind it.

Constructor

@:value({ alpha : 1, color : 0xcccccc, occlude : true })new(occlude:Bool = true, color:Int = 0xcccccc, alpha:Float = 1)

Creates a new OcclusionMaterial object.

Parameters:

occlude

Whether or not to occlude other objects.

color

The material's diffuse surface color.

alpha

The material's surface alpha.

Variables

occlude:Bool

Inherited Variables

Defined by ColorMaterial

alpha:Float

color:Int

Defined by SinglePassMaterialBase

Defined by MaterialBase

alphaPremultiplied:Bool

anisotropy:Anisotropy

read onlyassetType:String

blendMode:BlendMode

bothSides:Bool

depthCompareMode:Context3DCompareMode

extra:Dynamic

An object to contain any extra data.

lightPicker:LightPickerBase

mipmap:Bool

repeat:Bool

read onlyrequiresBlending:Bool

smooth:Bool

read onlyuniqueId:Int

Defined by NamedAssetBase

read onlyassetFullPath:Array<Dynamic>

read onlyassetNamespace:String

id:String

name:String

read onlyoriginalName:String

Inherited Methods

Defined by SinglePassMaterialBase

addMethod(method:EffectMethodBase):Void

Appends an "effect" shading method to the shader. Effect methods are those that do not influence the lighting but modulate the shaded colour, used for fog, outlines, etc. The method will be applied to the result of the methods added prior.

addMethodAt(method:EffectMethodBase, index:Int):Void

Adds an effect method at the specified index amongst the methods already added to the material. Effect methods are those that do not influence the lighting but modulate the shaded colour, used for fog, outlines, etc. The method will be applied to the result of the methods with a lower index.

getMethodAt(index:Int):EffectMethodBase

Returns the method added at the given index.

Parameters:

index

The index of the method to retrieve.

Returns:

The method at the given index.

hasMethod(method:EffectMethodBase):Bool

Queries whether a given effect method was added to the material.

Parameters:

method

The method to be queried.

Returns:

true if the method was added to the material, false otherwise.

removeMethod(method:EffectMethodBase):Void

Removes an effect method from the material.

Parameters:

method

The method to be removed.

Defined by MaterialBase

dispose():Void

Cleans up resources owned by the material, including passes. Textures are not owned by the material since they could be used by other materials and will not be disposed.

Defined by NamedAssetBase

assetPathEquals(name:String, ns:String):Bool

@:value({ overrideOriginal : true, ns : null })resetAssetPath(name:String, ?ns:String, overrideOriginal:Bool = true):Void