Packageaway3d.sprites
Classpublic class DirectionalSprite
InheritanceDirectionalSprite Inheritance Sprite3D Inheritance Element Inheritance flash.events.EventDispatcher

Spherical billboard (always facing the camera) sprite object that uses an array of bitmapData objects defined with viewing direction vectors. Draws 2d directional image dependent on viewing angle inline with z-sorted triangles in a scene.

Public Properties
 PropertyDefined by
 Inheritedalign : String
Defines how the 3d sprite is aligned to its vertex
Sprite3D
 Inheritedcommands : Array
Returns an array of drawing command strings that make up the 3d element.
Element
 InheriteddistanceScaling : Boolean
Defines if the sprite should scale with distance.
Sprite3D
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties.
Element
 Inheritedheight : Number
Defines the height of the 3d sprite.
Sprite3D
 Inheritedmaterial : Material
Defines the material of the 3d sprite.
Sprite3D
  materials : Array
[read-only] Returns an array of directional materials.
DirectionalSprite
 InheritedmaxX : Number
Returns the maximum x value of the segment
Sprite3D
 InheritedmaxY : Number
Returns the maximum y value of the segment
Sprite3D
 InheritedmaxZ : Number
Returns the maximum z value of the segment
Sprite3D
 InheritedminX : Number
Returns the minimum x value of the face
Sprite3D
 InheritedminY : Number
Returns the minimum y value of the face
Sprite3D
 InheritedminZ : Number
Returns the minimum y value of the face
Sprite3D
 Inheritedparent : Geometry
Defines the parent 3d object of the segment.
Element
 InheritedpathCommands : Array
Returns an array of drawing command objects that are used by the face.
Element
 Inheritedradius2 : Number
Returns the squared bounding radius of the 3d sprite.
Sprite3D
 Inheritedrotation : Number
Defines the rotation of the 3d sprite.
Sprite3D
 Inheritedscaling : Number
Defines the scaling of the 3d sprite when an BitmapMaterial is used.
Sprite3D
 InheritedspriteVO : SpriteVO
Sprite3D
 InheritedvertexDirty : Boolean
Element
 Inheritedvertices : Array
Returns an array of vertex objects that make up the 3d element.
Element
 Inheritedvisible : Boolean
Determines whether the 3d element is visible in the scene.
Element
 Inheritedwidth : Number
Defines the width of the 3d sprite.
Sprite3D
 Inheritedx : Number
Defines the x coordinate of the 3d sprite relative to the local coordinates of the parent Mesh.
Sprite3D
 Inheritedy : Number
Defines the y coordinate of the 3d sprite relative to the local coordinates of the parent Mesh.
Sprite3D
 Inheritedz : Number
Defines the z coordinate of the 3d sprite relative to the local coordinates of the parent Mesh.
Sprite3D
Protected Properties
 PropertyDefined by
 Inherited_commands : Array
Element
 Inherited_index : int
Element
 Inherited_lastAddedVertex : Vertex
Element
 Inherited_pathCommands : Array
Element
 Inherited_vertices : Array
Element
Public Methods
 MethodDefined by
  
DirectionalSprite
(material:Material = null, width:Number = 10, height:Number = 10, rotation:Number = 0, align:String = "center", scaling:Number = 1, distanceScaling:Boolean = true)
Creates a new DirectionalSprite object.
DirectionalSprite
  
addDirectionalMaterial(vertex:Vertex, material:Material):void
Adds a new material definition to the array of directional materials.
DirectionalSprite
 Inherited
addOnMappingChange(listener:Function):void
Default method for adding a mappingchanged event listener
Element
 Inherited
addOnVertexChange(listener:Function):void
Default method for adding a vertexchanged event listener
Element
 Inherited
addOnVertexValueChange(listener:Function):void
Default method for adding a vertexvaluechanged event listener
Element
 Inherited
addOnVisibleChange(listener:Function):void
Default method for adding a visiblechanged event listener
Element
 Inherited
offset(x:Number, y:Number, z:Number):void
Offsets the vertices of the face by given amounts in x, y and z.
Element
 Inherited
removeOnMappingChange(listener:Function):void
Default method for removing a mappingchanged event listener
Element
 Inherited
removeOnVertexChange(listener:Function):void
Default method for removing a vertexchanged event listener
Element
 Inherited
removeOnVertexValueChange(listener:Function):void
Default method for removing a vertexvaluechanged event listener
Element
 Inherited
removeOnVisibleChange(listener:Function):void
Default method for removing a visiblechanged event listener
Element
Events
 EventSummaryDefined by
 Inherited
materialchanged
Dispatched when the material of the sprite3d changes.Sprite3D
 Inherited
vertexChanged
Dispatched when the vertex of a 3d element changes.Element
 Inherited
vertexvalueChanged
Dispatched when the vertex value of a 3d element changes.Element
 Inherited
visibleChanged
Dispatched when the visiblity of a 3d element changes.Element
Property detail
materialsproperty
materials:Array  [read-only]

Returns an array of directional materials.

Implementation
    public function get materials():Array
Constructor detail
DirectionalSprite()constructor
public function DirectionalSprite(material:Material = null, width:Number = 10, height:Number = 10, rotation:Number = 0, align:String = "center", scaling:Number = 1, distanceScaling:Boolean = true)Parameters
material:Material (default = null)
 
width:Number (default = 10)
 
height:Number (default = 10)
 
rotation:Number (default = 0)
 
align:String (default = "center")
 
scaling:Number (default = 1)
 
distanceScaling:Boolean (default = true)
Init Parameters
Method detail
addDirectionalMaterial()method
public function addDirectionalMaterial(vertex:Vertex, material:Material):void

Adds a new material definition to the array of directional materials.

Parameters
vertex:Vertex — vertex The orienting vertex to be used by the directional material.
 
material:Material — bitmap The bitmapData object to be used as the directional material.
Wiki link
Click to go to the wiki page for 'away3d.sprites.DirectionalSprite'

Code examples

Comments