Packageaway3d.sprites
Classpublic class Sprite3D
InheritanceSprite3D Inheritance Element Inheritance flash.events.EventDispatcher
SubclassesDepthOfFieldSprite, DirectionalSprite, MovieClipSprite

A graphics element used to represent objects that always face the camera

See also

away3d.core.base.Mesh
Public Properties
 PropertyDefined by
  align : 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
  distanceScaling : Boolean
Defines if the sprite should scale with distance.
Sprite3D
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties.
Element
  height : Number
Defines the height of the 3d sprite.
Sprite3D
  material : Material
Defines the material of the 3d sprite.
Sprite3D
  maxX : Number
[read-only] Returns the maximum x value of the segment
Sprite3D
  maxY : Number
[read-only] Returns the maximum y value of the segment
Sprite3D
  maxZ : Number
[read-only] Returns the maximum z value of the segment
Sprite3D
  minX : Number
[read-only] Returns the minimum x value of the face
Sprite3D
  minY : Number
[read-only] Returns the minimum y value of the face
Sprite3D
  minZ : Number
[read-only] 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
  radius2 : Number
[read-only] Returns the squared bounding radius of the 3d sprite.
Sprite3D
  rotation : Number
Defines the rotation of the 3d sprite.
Sprite3D
  scaling : Number
Defines the scaling of the 3d sprite when an BitmapMaterial is used.
Sprite3D
  spriteVO : 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
  width : Number
Defines the width of the 3d sprite.
Sprite3D
  x : Number
Defines the x coordinate of the 3d sprite relative to the local coordinates of the parent Mesh.
Sprite3D
  y : Number
Defines the y coordinate of the 3d sprite relative to the local coordinates of the parent Mesh.
Sprite3D
  z : 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
  
Sprite3D
(material:Material = null, width:Number = 10, height:Number = 10, rotation:Number = 0, align:String = "center", scaling:Number = 1, distanceScaling:Boolean = true)
Creates a new Billboard object.
Sprite3D
 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
  
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
alignproperty
align:String  [read-write]

Defines how the 3d sprite is aligned to its vertex

Implementation
    public function get align():String
    public function set align(value:String):void

See also

away3d.sprites.SpriteAlign
distanceScalingproperty 
distanceScaling:Boolean  [read-write]

Defines if the sprite should scale with distance. Defaults to true

Implementation
    public function get distanceScaling():Boolean
    public function set distanceScaling(value:Boolean):void
heightproperty 
height:Number  [read-write]

Defines the height of the 3d sprite.

Implementation
    public function get height():Number
    public function set height(value:Number):void
materialproperty 
material:Material  [read-write]

Defines the material of the 3d sprite.

Implementation
    public function get material():Material
    public function set material(value:Material):void
maxXproperty 
maxX:Number  [read-only]

Returns the maximum x value of the segment

Implementation
    public function get maxX():Number

See also

../core/base/Vertex.html#x
maxYproperty 
maxY:Number  [read-only]

Returns the maximum y value of the segment

Implementation
    public function get maxY():Number

See also

../core/base/Vertex.html#y
maxZproperty 
maxZ:Number  [read-only]

Returns the maximum z value of the segment

Implementation
    public function get maxZ():Number

See also

../core/base/Vertex.html#z
minXproperty 
minX:Number  [read-only]

Returns the minimum x value of the face

Implementation
    public function get minX():Number

See also

../core/base/Vertex.html#x
minYproperty 
minY:Number  [read-only]

Returns the minimum y value of the face

Implementation
    public function get minY():Number

See also

../core/base/Vertex.html#y
minZproperty 
minZ:Number  [read-only]

Returns the minimum y value of the face

Implementation
    public function get minZ():Number

See also

../core/base/Vertex.html#y
radius2property 
radius2:Number  [read-only]

Returns the squared bounding radius of the 3d sprite.

Implementation
    public function get radius2():Number
rotationproperty 
rotation:Number  [read-write]

Defines the rotation of the 3d sprite.

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

Defines the scaling of the 3d sprite when an BitmapMaterial is used.

Implementation
    public function get scaling():Number
    public function set scaling(value:Number):void
spriteVOproperty 
public var spriteVO:SpriteVO
widthproperty 
width:Number  [read-write]

Defines the width of the 3d sprite.

Implementation
    public function get width():Number
    public function set width(value:Number):void
xproperty 
x:Number  [read-write]

Defines the x coordinate of the 3d sprite relative to the local coordinates of the parent Mesh.

Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number  [read-write]

Defines the y coordinate of the 3d sprite relative to the local coordinates of the parent Mesh.

Implementation
    public function get y():Number
    public function set y(value:Number):void
zproperty 
z:Number  [read-write]

Defines the z coordinate of the 3d sprite relative to the local coordinates of the parent Mesh.

Implementation
    public function get z():Number
    public function set z(value:Number):void
Constructor detail
Sprite3D()constructor
public function Sprite3D(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) — [optional] The material used by the 3d sprite to render
 
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
Event detail
materialchangedevent 
Event object type: away3d.events.BillboardEvent

Dispatched when the material of the sprite3d changes.

Wiki link
Click to go to the wiki page for 'away3d.sprites.Sprite3D'

Code examples

Comments