away3d.materials.SpriteSheetMaterial

Public Properties

	Property		Defined By
		alpha : Number The alpha of the surface.	TextureMaterial
		alphaBlending : Boolean Indicate whether or not the material has transparency.	SinglePassMaterialBase
		alphaPremultiplied : Boolean Indicates whether visible textures (or other pixels) used by this material have already been premultiplied.	MaterialBase
		alphaThreshold : Number The minimum alpha value for which pixels should be drawn.	SinglePassMaterialBase
		ambient : Number The strength of the ambient reflection.	SinglePassMaterialBase
		ambientColor : uint The colour of the ambient reflection.	SinglePassMaterialBase
		ambientMethod : BasicAmbientMethod The method to perform ambient shading.	SinglePassMaterialBase
		ambientTexture : Texture2DBase The texture object to use for the ambient colour.	TextureMaterial
		animateUVs : Boolean	TextureMaterial
		assetFullPath : Array [read-only]	NamedAssetBase
		assetNamespace : String [read-only]	NamedAssetBase
		assetType : String [read-only]	MaterialBase
		blendMode : String [override]	SinglePassMaterialBase
		bothSides : Boolean Defines whether or not the material should perform backface culling.	MaterialBase
		colorTransform : ColorTransform The ColorTransform object to transform the colour of the material with.	SinglePassMaterialBase
		depthCompareMode : String [override]	SinglePassMaterialBase
		diffuseLightSources : uint	SinglePassMaterialBase
		diffuseMethod : BasicDiffuseMethod The method to perform diffuse shading.	SinglePassMaterialBase
		enableLightFallOff : Boolean Whether or not to use fallOff and radius properties for lights.	SinglePassMaterialBase
		extra : Object An object to contain any extra data	MaterialBase
		gloss : Number The sharpness of the specular highlight.	SinglePassMaterialBase
		lightPicker : LightPickerBase [override]	SinglePassMaterialBase
		mipmap : Boolean [override] Indicates whether or not any used textures should use mipmapping.	SinglePassMaterialBase
		name : String	NamedAssetBase
		normalMap : Texture2DBase The tangent space normal map to influence the direction of the surface for each texel.	SinglePassMaterialBase
		normalMethod : BasicNormalMethod The method to generate the (tangent-space) normal.	SinglePassMaterialBase
		numMethods : int [read-only]	SinglePassMaterialBase
		originalName : String [read-only] The original name used for this asset in the resource (e.g.	NamedAssetBase
		repeat : Boolean Indicates whether or not any used textures should be tiled.	MaterialBase
		requiresBlending : Boolean [override] [read-only] Indicates whether or not the material requires alpha blending during rendering.	SinglePassMaterialBase
		shadowMethod : ShadowMapMethodBase The method to render shadows cast on this surface.	SinglePassMaterialBase
		smooth : Boolean Indicates whether or not any used textures should use smoothing.	MaterialBase
		specular : Number The overall strength of the specular reflection.	SinglePassMaterialBase
		specularColor : uint The colour of the specular reflection.	SinglePassMaterialBase
		specularLightSources : uint	SinglePassMaterialBase
		specularMap : 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
		specularMethod : BasicSpecularMethod The method to perform specular shading.	SinglePassMaterialBase
		texture : Texture2DBase The texture object to use for the albedo colour.	TextureMaterial
		uniqueId : uint [read-only] The unique id assigned to the material by the MaterialLibrary.	MaterialBase

	Property	Defined By
		_depthPass : DepthMapPass	MaterialBase
		_distancePass : DistanceMapPass	MaterialBase
		_lightPicker : LightPickerBase	MaterialBase
		_mipmap : Boolean = true	MaterialBase
		_numPasses : uint	MaterialBase
		_passes : Vector.<MaterialPassBase>	MaterialBase
		_repeat : Boolean	MaterialBase
		_screenPass : SuperShaderPass	SinglePassMaterialBase
		_smooth : Boolean = true	MaterialBase

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SpriteSheetMaterial(diffuses:Vector.<Texture2DBase>, normals:Vector.<Texture2DBase> = null, speculars:Vector.<Texture2DBase> = null, smooth:Boolean = true, repeat:Boolean = false, mipmap:Boolean = true) Creates a new SpriteSheetMaterial required for a SpriteSheetAnimator (the sprite sheet maps of each textures must have power of 2 sizes)	SpriteSheetMaterial
		addMethod(method:EffectMethodBase):void Adds a shading method to the end of the shader.	SinglePassMaterialBase
		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
		assetPathEquals(name:String, ns:String):Boolean	NamedAssetBase
		dispose():void Cleans up any resources used by the current object.	MaterialBase
		getMethodAt(index:int):EffectMethodBase	SinglePassMaterialBase
		hasMethod(method:EffectMethodBase):Boolean	SinglePassMaterialBase
		removeMethod(method:EffectMethodBase):void	SinglePassMaterialBase
		resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void	NamedAssetBase

	Method	Defined By
		addPass(pass:MaterialPassBase):void Adds a pass to the material	MaterialBase
		clearPasses():void Clears all passes in the material.	MaterialBase
		removePass(pass:MaterialPassBase):void	MaterialBase

	Constant	Defined By
		DEFAULT_NAMESPACE : String = default [static]	NamedAssetBase

Constructor Detail

SpriteSheetMaterial

()

Constructor

public function SpriteSheetMaterial(diffuses:Vector.<Texture2DBase>, normals:Vector.<Texture2DBase> = null, speculars:Vector.<Texture2DBase> = null, smooth:Boolean = true, repeat:Boolean = false, mipmap:Boolean = true)

Creates a new SpriteSheetMaterial required for a SpriteSheetAnimator (the sprite sheet maps of each textures must have power of 2 sizes)

Parameters

	`diffuses:Vector.<Texture2DBase>` — Vector.<Texture2DBase> : One or more Texture2DBase representing the diffuse information of the spritesheets. Must hold at least 1 diffuse.

	`normals:Vector.<Texture2DBase>` (default = `null`) — Vector.<Texture2DBase> : One or more Texture2DBase representing the normal information of the spritesheets. Default is null. If not null, must hold same amount of textures as diffuses.

	`speculars:Vector.<Texture2DBase>` (default = `null`) — Vector.<Texture2DBase> : One or more Texture2DBase representing the specular information of the spritesheets. Default is null. If not null, must hold same amount of textures as diffuses.

	`smooth:Boolean` (default = `true`) — Boolean : Material smoothing. Default is true.

	`repeat:Boolean` (default = `false`) — Boolean : Material repeat. Default is false.

	`mipmap:Boolean` (default = `true`) — Boolean : Material mipmap. Set it to false if the animation graphics have thin lines or text information in them. Default is true.

Method Detail

swap

()

method

arcane function swap(mapID:uint = 0):Boolean

Parameters

mapID:uint (default = 0)

Returns

Boolean

Tue May 7 2013, 10:42 PM +01:00

Away3D 4.1Beta Documentation	All Packages \| All Classes \| Index \| Frames No Frames
SpriteSheetMaterial	Properties \| Methods \| Constants

Package	away3d.materials
Class	public class SpriteSheetMaterial
Inheritance	SpriteSheetMaterial TextureMaterial SinglePassMaterialBase MaterialBase NamedAssetBase flash.events.EventDispatcher