Packageaway3d.core.draw
Classpublic class DrawSprite
InheritanceDrawSprite Inheritance DrawPrimitive

3D Sprite primitive

Public Properties
 PropertyDefined by
  bottomleftx : Number
The bottomleft x position of the billboard primitive.
DrawSprite
  bottomlefty : Number
The bottomleft y position of the billboard primitive.
DrawSprite
  bottomrightx : Number
The bottomright x position of the billboard primitive.
DrawSprite
  bottomrighty : Number
The bottomright y position of the billboard primitive.
DrawSprite
 Inheritedcreate : Function
Placeholder function for creating new drawing primitives from a cache of objects.
DrawPrimitive
 Inheritedgenerated : Boolean
Indicator of whether primitive is the produce of a generator algorithm
DrawPrimitive
  height : Number
The height of the billboard if a non-uv material is used.
DrawSprite
 InheritedignoreSort : Boolean
DrawPrimitive
  index : int
The index of the screenvertex used to position the billboard primitive in the view.
DrawSprite
  mapping : Matrix
DrawSprite
  material : Material
The material object used as the billboard primitive's texture.
DrawSprite
 InheritedmaxX : Number
Indicates the maximum x value of the drawing primitive.
DrawPrimitive
 InheritedmaxY : Number
Indicates the maximum y value of the drawing primitive.
DrawPrimitive
 InheritedmaxZ : Number
Indicates the maximum z value of the drawing primitive.
DrawPrimitive
 InheritedminX : Number
Indicates the minimum x value of the drawing primitive.
DrawPrimitive
 InheritedminY : Number
Indicates the minimum y value of the drawing primitive.
DrawPrimitive
 InheritedminZ : Number
Indicates the minimum z value of the drawing primitive.
DrawPrimitive
 Inheritedquadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
DrawPrimitive
  rotation : Number
A rotation value used to rotate the scaled bitmap primitive.
DrawSprite
  scale : Number
A scaling value used to scale the billboard primitive relative to the dimensions of a uv material.
DrawSprite
  screenIndices : Array
DrawSprite
  screenVertices : Array
DrawSprite
 InheritedscreenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
DrawPrimitive
 Inheritedsource : Object3D
The parent 3d object of the drawing primitive.
DrawPrimitive
  spriteVO : SpriteVO
A reference to the 3d sprite value object used by the 3d sprite primitive.
DrawSprite
  topleftx : Number
The topleft x position of the billboard primitive.
DrawSprite
  toplefty : Number
The topleft y position of the billboard primitive.
DrawSprite
  toprightx : Number
The topright x position of the billboard primitive.
DrawSprite
  toprighty : Number
The topright y position of the billboard primitive.
DrawSprite
 Inheritedview : View3D
The view 3d object of the drawing primitive.
DrawPrimitive
  vx : Number
The x position of the screenvertex of the billboard primitive.
DrawSprite
  vy : Number
The y position of the screenvertex of the billboard primitive.
DrawSprite
  width : Number
The width of the billboard if a non-uv material is used.
DrawSprite
Public Methods
 MethodDefined by
  
calc():void
Calculates the min, max and screen properties required for rendering the drawing primitive.
DrawSprite
  
clear():void
Deletes the data currently held by the drawing primitive.
DrawSprite
  
contains(x:Number, y:Number):Boolean
Determines whether the given point lies inside the drawing primitive
DrawSprite
 Inherited
getZ(x:Number, y:Number):Number
Calulates the screen z value of a precise point on the drawing primitive.
DrawPrimitive
 Inherited
quarter(focus:Number):Array
Cuts the drawing primitive into 4 equally sized drawing primitives.
DrawPrimitive
  
render():void
Draws the primitive to the view.
DrawSprite
 Inherited
toString():String
Used to trace the values of a drawing primitive.
DrawPrimitive
Property detail
bottomleftxproperty
public var bottomleftx:Number

The bottomleft x position of the billboard primitive.

bottomleftyproperty 
public var bottomlefty:Number

The bottomleft y position of the billboard primitive.

bottomrightxproperty 
public var bottomrightx:Number

The bottomright x position of the billboard primitive.

bottomrightyproperty 
public var bottomrighty:Number

The bottomright y position of the billboard primitive.

heightproperty 
public var height:Number

The height of the billboard if a non-uv material is used.

indexproperty 
public var index:int

The index of the screenvertex used to position the billboard primitive in the view.

mappingproperty 
public var mapping:Matrix
materialproperty 
public var material:Material

The material object used as the billboard primitive's texture.

rotationproperty 
public var rotation:Number

A rotation value used to rotate the scaled bitmap primitive.

scaleproperty 
public var scale:Number

A scaling value used to scale the billboard primitive relative to the dimensions of a uv material.

screenIndicesproperty 
public var screenIndices:Array
screenVerticesproperty 
public var screenVertices:Array
spriteVOproperty 
public var spriteVO:SpriteVO

A reference to the 3d sprite value object used by the 3d sprite primitive.

topleftxproperty 
public var topleftx:Number

The topleft x position of the billboard primitive.

topleftyproperty 
public var toplefty:Number

The topleft y position of the billboard primitive.

toprightxproperty 
public var toprightx:Number

The topright x position of the billboard primitive.

toprightyproperty 
public var toprighty:Number

The topright y position of the billboard primitive.

vxproperty 
public var vx:Number

The x position of the screenvertex of the billboard primitive.

vyproperty 
public var vy:Number

The y position of the screenvertex of the billboard primitive.

widthproperty 
public var width:Number

The width of the billboard if a non-uv material is used.

Method detail
calc()method
public override function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

clear()method 
public override function clear():void

Deletes the data currently held by the drawing primitive.

contains()method 
public override function contains(x:Number, y:Number):Boolean

Determines whether the given point lies inside the drawing primitive

Parameters
x:Number — The x position of the point to be tested.
 
y:Number — The y position of the point to be tested.

Returns
Boolean — The result of the test.
render()method 
public override function render():void

Draws the primitive to the view.

Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawSprite'

Code examples

Comments