Packageaway3d.materials
Classpublic class TransformBitmapMaterial
InheritanceTransformBitmapMaterial Inheritance BitmapMaterial Inheritance flash.events.EventDispatcher
ImplementsITriangleMaterial, IUVMaterial
SubclassesAnimatedBitmapMaterial, BitmapFileMaterial, MovieMaterial

Basic bitmap texture material

Public Properties
 PropertyDefined by
 Inheritedalpha : Number
Defines an alpha value for the texture bitmap.
BitmapMaterial
 Inheritedbitmap : BitmapData
Returns the bitmapData object being used as the material texture.
BitmapMaterial
 InheritedblendMode : String
Defines a blendMode value for the texture bitmap.
BitmapMaterial
 Inheritedcolor : uint
Defines a colored tint for the texture bitmap.
BitmapMaterial
 InheritedcolorTransform : ColorTransform
Defines a colortransform for the texture bitmap.
BitmapMaterial
 Inheriteddebug : Boolean
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
BitmapMaterial
  globalProjection : Boolean
Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.
TransformBitmapMaterial
 Inheritedheight : Number
Returns the height of the bitmapData being used as the material texture.
BitmapMaterial
 Inheritedid : int
Unique identifier
BitmapMaterial
  offsetX : Number
Offsets the x coordinates of the texture in uv-space
TransformBitmapMaterial
  offsetY : Number
Offsets the y coordinates of the texture in uv-space
TransformBitmapMaterial
 Inheritedprecision : Number
Corrects distortion caused by the affine transformation (non-perspective) of textures.
BitmapMaterial
  projectionVector : Number3D
Projects the texture in object space, ignoring the uv coordinates of the vertex objects.
TransformBitmapMaterial
 Inheritedrepeat : Boolean
Determines if texture bitmap will tile in uv-space
BitmapMaterial
  rotation : Number
Rotates the texture in uv-space
TransformBitmapMaterial
  scaleX : Number
Scales the x coordinates of the texture in uv-space
TransformBitmapMaterial
  scaleY : Number
Scales the y coordinates of the texture in uv-space
TransformBitmapMaterial
 InheritedshowNormals : Boolean
Displays the normals per face in pink lines.
BitmapMaterial
 Inheritedsmooth : Boolean
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
BitmapMaterial
  throughProjection : Boolean
Determines whether a projected texture is visble on the faces pointing away from the projection.
TransformBitmapMaterial
  transform : Matrix
Transforms the texture in uv-space
TransformBitmapMaterial
 Inheritedvisible : Boolean
Indicates whether the material is visible
BitmapMaterial
 Inheritedwidth : Number
Returns the width of the bitmapData being used as the material texture.
BitmapMaterial
Protected Properties
 PropertyDefined by
 Inheritedini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
BitmapMaterial
Public Methods
 MethodDefined by
  
TransformBitmapMaterial
(bitmap:BitmapData, init:Object = null)
Creates a new TransformBitmapMaterial object.
TransformBitmapMaterial
 Inherited
addOnMaterialUpdate(listener:Function):void
Default method for adding a materialupdated event listener
BitmapMaterial
 Inherited
clearFaces(source:Object3D = null, view:View3D = null):void
Clears facematerial value objects when bitmap requires updating
BitmapMaterial
 Inherited
getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
BitmapMaterial
  
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
TransformBitmapMaterial
 Inherited
invalidateFaces(source:Object3D = null, view:View3D = null):void
Invalidates facematerial value objects when texturemapping requires updating
BitmapMaterial
 Inherited
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialupdated event listener
BitmapMaterial
 Inherited
Sends data from the material coupled with data from the DrawBillboard primitive to the render session.
BitmapMaterial
  
renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO
Renders a bitmapData surface object for the speficied face.
TransformBitmapMaterial
 Inherited
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):int
Renders a material layer for the specified triangle.
BitmapMaterial
  
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
TransformBitmapMaterial
  
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
TransformBitmapMaterial
Protected Methods
 MethodDefined by
  
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
TransformBitmapMaterial
  
getUVData(tri:DrawTriangle):Vector
TransformBitmapMaterial
 Inherited
Updates the colortransform object applied to the texture from the color and alpha properties.
BitmapMaterial
 Inherited
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
BitmapMaterial
Property detail
globalProjectionproperty
globalProjection:Boolean  [read-write]

Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.

Implementation
    public function get globalProjection():Boolean
    public function set globalProjection(value:Boolean):void

See also

projectionVector
offsetX
offsetY
offsetXproperty 
offsetX:Number  [read-write]

Offsets the x coordinates of the texture in uv-space

Implementation
    public function get offsetX():Number
    public function set offsetX(value:Number):void
offsetYproperty 
offsetY:Number  [read-write]

Offsets the y coordinates of the texture in uv-space

Implementation
    public function get offsetY():Number
    public function set offsetY(value:Number):void
projectionVectorproperty 
projectionVector:Number3D  [read-write]

Projects the texture in object space, ignoring the uv coordinates of the vertex objects. Texture renders normally when set to null.

Implementation
    public function get projectionVector():Number3D
    public function set projectionVector(value:Number3D):void
rotationproperty 
rotation:Number  [read-write]

Rotates the texture in uv-space

Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
scaleXproperty 
scaleX:Number  [read-write]

Scales the x coordinates of the texture in uv-space

Implementation
    public function get scaleX():Number
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number  [read-write]

Scales the y coordinates of the texture in uv-space

Implementation
    public function get scaleY():Number
    public function set scaleY(value:Number):void
throughProjectionproperty 
throughProjection:Boolean  [read-write]

Determines whether a projected texture is visble on the faces pointing away from the projection.

Implementation
    public function get throughProjection():Boolean
    public function set throughProjection(value:Boolean):void

See also

projectionVector
transformproperty 
transform:Matrix  [read-write]

Transforms the texture in uv-space

Implementation
    public function get transform():Matrix
    public function set transform(value:Matrix):void
Constructor detail
TransformBitmapMaterial()constructor
public function TransformBitmapMaterial(bitmap:BitmapData, init:Object = null)Parameters
bitmap:BitmapData — The bitmapData object to be used as the material's texture.
 
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 transform:Object (default = Matrix)
 scaleX:Number (default = _scaleX)
 scaleY:Number (default = _scaleY)
 offsetX:Number (default = _offsetX)
 offsetY:Number (default = _offsetY)
 rotation:Number (default = _rotation)
 projectionVector:Object (default = Number3D)
 throughProjection:Boolean (default = true)
 globalProjection:Boolean (default = false)
Method detail
getMapping()method
protected override function getMapping(tri:DrawTriangle):Matrix

Calculates the mapping matrix required to draw the triangle texture to screen.

Parameters
tri:DrawTriangle — The data object holding all information about the triangle to be drawn.

Returns
Matrix — The required matrix object.
getPixel32()method 
public override function getPixel32(u:Number, v:Number):uint

Returns the argb value of the bitmapData pixel at the given u v coordinate.

Parameters
u:Number — The u (horizontal) texture coordinate.
 
v:Number — The v (verical) texture coordinate.

Returns
uint — The argb pixel value.
getUVData()method 
protected override function getUVData(tri:DrawTriangle):Vector Parameters
tri:DrawTriangle

Returns
Vector
renderBitmapLayer()method 
public override function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO

Renders a bitmapData surface object for the speficied face.

Parameters
tri:DrawTriangle — The face object onto which the rendered sufrace is applied.
 
containerRect:Rectangle — The rectangle object defining the bounds of the face in uv-space.
 
parentFaceMaterialVO:FaceMaterialVO — The value object of the preceeding surface.

Returns
FaceMaterialVO
renderTriangle()method 
public override function renderTriangle(tri:DrawTriangle):void

Sends data from the material coupled with data from the DrawTriangle primitive to the render session.

Parameters
tri:DrawTriangle
updateMaterial()method 
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.TransformBitmapMaterial'

Code examples

Comments