Packageaway3d.materials
Classpublic class SpriteSheetMaterial
InheritanceSpriteSheetMaterial Inheritance TextureMaterial Inheritance SinglePassMaterialBase Inheritance MaterialBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

SpriteSheetMaterial is a material required for a SpriteSheetAnimator if you have an animation spreaded over more maps and/or have animated normalmaps, specularmaps



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The alpha of the surface.
TextureMaterial
 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
 InheritedambientTexture : Texture2DBase
The texture object to use for the ambient colour.
TextureMaterial
 InheritedanimateUVs : Boolean
TextureMaterial
 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
 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
 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.
SinglePassMaterialBase
 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
 Inheritedtexture : Texture2DBase
The texture object to use for the albedo colour.
TextureMaterial
 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
  
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
 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
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