| Package | flare.materials |
| Class | public class Material3D |
| Inheritance | Material3D  flash.events.EventDispatcher |
| Subclasses | FLSLMaterial |
| Property | Defined By | ||
|---|---|---|---|
| blendMode : int | Material3D | ||
| cullFace : String
The culling mode. | Material3D | ||
| depthCompare : String = lessEqual
The test comparasion to be used when depthWrite is 'true'. | Material3D | ||
| depthWrite : Boolean = true
Gets or sets whatever the material writes into the z-buffer. | Material3D | ||
| destFactor : String
The factor with which to multiply the destination color. | Material3D | ||
| flags : uint
An engine defined variable to store different material properties. | Material3D | ||
| name : String
The name of the material. | Material3D | ||
| scene : Scene3D [read-only]
Gets a reference to the scene that the material is associated. | Material3D | ||
| sourceFactor : String
The factor with which to multiply the source color. | Material3D | ||
| transparent : Boolean
Sets or gets if the material should use alpha blending. | Material3D | ||
| twoSided : Boolean
Sets or gets if the material should be drawn useing both sides of the surfaces. | Material3D | ||
| Method | Defined By | ||
|---|---|---|---|
Material3D(name:String)
Creates a new Material3D. | Material3D | ||
Clones the material. | Material3D | ||
dispose():void
Eliminates all the resources associated to the material. | Material3D | ||
download():void
Downloads all the data uploaded to the graphics card. | Material3D | ||
Draw a mesh surface using the current material. | Material3D | ||
Associates and link the material with the scene to be uploaded. | Material3D | ||
Validates that the surface is compatible with the material. | Material3D | ||
| Method | Defined By | ||
|---|---|---|---|
context3DEvent(e:Event = null):void
Uploads the necesary data to the graphics card. | Material3D | ||
| Constant | Defined By | ||
|---|---|---|---|
| BLEND_ADDITIVE : int = 1 [static] | Material3D | ||
| BLEND_ALPHA_BLENDED : int = 2 [static] | Material3D | ||
| BLEND_MULTIPLY : int = 3 [static] | Material3D | ||
| BLEND_NONE : int = 0 [static] | Material3D | ||
| BLEND_SCREEN : int = 4 [static] | Material3D | ||
| FLAG_MASK : uint [static] | Material3D | ||
| FLAG_SKIN1 : uint [static] | Material3D | ||
| FLAG_SKIN2 : uint [static] | Material3D | ||
| FLAG_SKIN3 : uint [static] | Material3D | ||
| FLAG_SKIN4 : uint [static] | Material3D | ||
| blendMode | property |
blendMode:int public function get blendMode():int public function set blendMode(value:int):void| cullFace | property |
public var cullFace:StringThe culling mode. One of Context3DTriangleFace values.
| depthCompare | property |
public var depthCompare:String = lessEqualThe test comparasion to be used when depthWrite is 'true'. Should be one of the values of Context3DCompareMode.
| depthWrite | property |
public var depthWrite:Boolean = trueGets or sets whatever the material writes into the z-buffer.
| destFactor | property |
public var destFactor:StringThe factor with which to multiply the destination color. Souldd be one of Context3DBlendFactor values.
| flags | property |
public var flags:uintAn engine defined variable to store different material properties.
| name | property |
public var name:StringThe name of the material.
| scene | property |
scene:Scene3D [read-only] Gets a reference to the scene that the material is associated.
public function get scene():Scene3D| sourceFactor | property |
public var sourceFactor:StringThe factor with which to multiply the source color. Souldd be one of Context3DBlendFactor values.
| transparent | property |
transparent:BooleanSets or gets if the material should use alpha blending. This property changes the source and dest factor propertys.
public function get transparent():Boolean public function set transparent(value:Boolean):void| twoSided | property |
twoSided:BooleanSets or gets if the material should be drawn useing both sides of the surfaces. This proeprty affects the cullFace property of the material.
public function get twoSided():Boolean public function set twoSided(value:Boolean):void| Material3D | () | Constructor |
public function Material3D(name:String)Creates a new Material3D.
Parametersname:String — Name of the material.
|
| clone | () | method |
public function clone():Material3DClones the material.
ReturnsMaterial3D — The new cloned material.
|
| context3DEvent | () | method |
protected function context3DEvent(e:Event = null):voidUploads the necesary data to the graphics card.
Parameters
e:Event (default = null) |
| dispose | () | method |
public function dispose():voidEliminates all the resources associated to the material.
| download | () | method |
public function download():voidDownloads all the data uploaded to the graphics card.
| draw | () | method |
public function draw(pivot:Pivot3D, surf:Surface3D, firstIndex:int = 0, count:int = -1):voidDraw a mesh surface using the current material.
Parameters
pivot:Pivot3D — Pivot3D to be drawn.
| |
surf:Surface3D — Surface3D to be drawn.
| |
firstIndex:int (default = 0) | |
count:int (default = -1) |
| upload | () | method |
public function upload(scene:Scene3D):voidAssociates and link the material with the scene to be uploaded.
Parameters
scene:Scene3D |
| validate | () | method |
public function validate(surf:Surface3D):BooleanValidates that the surface is compatible with the material.
Parameters
surf:Surface3D — The surface to validate.
|
Boolean |
| BLEND_ADDITIVE | Constant |
public static const BLEND_ADDITIVE:int = 1| BLEND_ALPHA_BLENDED | Constant |
public static const BLEND_ALPHA_BLENDED:int = 2| BLEND_MULTIPLY | Constant |
public static const BLEND_MULTIPLY:int = 3| BLEND_NONE | Constant |
public static const BLEND_NONE:int = 0| BLEND_SCREEN | Constant |
public static const BLEND_SCREEN:int = 4| FLAG_MASK | Constant |
public static const FLAG_MASK:uint| FLAG_SKIN1 | Constant |
public static const FLAG_SKIN1:uint| FLAG_SKIN2 | Constant |
public static const FLAG_SKIN2:uint| FLAG_SKIN3 | Constant |
public static const FLAG_SKIN3:uint| FLAG_SKIN4 | Constant |
public static const FLAG_SKIN4:uint