Packageaway3d.core.base
Classpublic class Billboard
InheritanceBillboard Inheritance Element Inheritance flash.events.EventDispatcher

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

See also

away3d.core.base.Mesh
Public Properties
 PropertyDefined by
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties.
Element
  height : Number
Defines the height of the billboard.
Billboard
  material : IBillboardMaterial
Defines the material of the billboard.
Billboard
  maxX : Number
[read-only] Returns the maximum x value of the segment
Billboard
  maxY : Number
[read-only] Returns the maximum y value of the segment
Billboard
  maxZ : Number
[read-only] Returns the maximum z value of the segment
Billboard
  minX : Number
[read-only] Returns the minimum x value of the face
Billboard
  minY : Number
[read-only] Returns the minimum y value of the face
Billboard
  minZ : Number
[read-only] Returns the minimum y value of the face
Billboard
 Inheritedparent : Geometry
Defines the parent 3d object of the segment.
Element
  radius2 : Number
[read-only] Returns the squared bounding radius of the billboard.
Billboard
  rotation : Number
Defines the rotation of the billboard.
Billboard
  scaling : Number
Defines the scaling of the billboard when an IUVMaterial is used.
Billboard
  vertex : Vertex
Defines the vertex of the billboard.
Billboard
 InheritedvertexDirty : Boolean
Element
  vertices : Array
[read-only] Returns an array of vertex objects that are used by the segment.
Billboard
 Inheritedvisible : Boolean
Determines whether the 3d element is visible in the scene.
Element
  width : Number
Defines the width of the billboard.
Billboard
  x : Number
Defines the x coordinate of the billboard relative to the local coordinates of the parent Mesh.
Billboard
  y : Number
Defines the y coordinate of the billboard relative to the local coordinates of the parent Mesh.
Billboard
  z : Number
Defines the z coordinate of the billboard relative to the local coordinates of the parent Mesh.
Billboard
Public Methods
 MethodDefined by
  
Billboard
(vertex:Vertex, material:IBillboardMaterial = null, width:Number = 10, height:Number = 10)
Creates a new Billboard object.
Billboard
  
addOnMaterialChange(listener:Function):void
Default method for adding a materialchanged event listener
Billboard
 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
  
removeOnMaterialChange(listener:Function):void
Default method for removing a materialchanged event listener
Billboard
 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
   Dispatched when the material of the billboard changes.Billboard
 Inherited Dispatched when the vertex of a 3d element changes.Element
 Inherited Dispatched when the vertex value of a 3d element changes.Element
 Inherited Dispatched when the visiblity of a 3d element changes.Element
Property detail
heightproperty
height:Number  [read-write]

Defines the height of the billboard.

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

Defines the material of the billboard.

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

Returns the maximum x value of the segment

Implementation
    public function get maxX():Number

See also

maxYproperty 
maxY:Number  [read-only]

Returns the maximum y value of the segment

Implementation
    public function get maxY():Number

See also

maxZproperty 
maxZ:Number  [read-only]

Returns the maximum z value of the segment

Implementation
    public function get maxZ():Number

See also

minXproperty 
minX:Number  [read-only]

Returns the minimum x value of the face

Implementation
    public function get minX():Number

See also

minYproperty 
minY:Number  [read-only]

Returns the minimum y value of the face

Implementation
    public function get minY():Number

See also

minZproperty 
minZ:Number  [read-only]

Returns the minimum y value of the face

Implementation
    public function get minZ():Number

See also

radius2property 
radius2:Number  [read-only]

Returns the squared bounding radius of the billboard.

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

Defines the rotation of the billboard.

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

Defines the scaling of the billboard when an IUVMaterial is used.

Implementation
    public function get scaling():Number
    public function set scaling(value:Number):void
vertexproperty 
vertex:Vertex  [read-write]

Defines the vertex of the billboard.

Implementation
    public function get vertex():Vertex
    public function set vertex(value:Vertex):void
verticesproperty 
vertices:Array  [read-only]

Returns an array of vertex objects that are used by the segment.

Implementation
    public function get vertices():Array
widthproperty 
width:Number  [read-write]

Defines the width of the billboard.

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

Defines the x coordinate of the billboard 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 billboard 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 billboard relative to the local coordinates of the parent Mesh.

Implementation
    public function get z():Number
    public function set z(value:Number):void
Constructor detail
Billboard()constructor
public function Billboard(vertex:Vertex, material:IBillboardMaterial = null, width:Number = 10, height:Number = 10)Parameters
vertex:Vertex — The vertex object of the billboard
 
material:IBillboardMaterial (default = null) — [optional] The material used by the billboard to render
 
width:Number (default = 10)
 
height:Number (default = 10)
Init Parameters
Method detail
addOnMaterialChange()method
public function addOnMaterialChange(listener:Function):void

Default method for adding a materialchanged event listener

Parameters
listener:Function — The listener function
removeOnMaterialChange()method 
public function removeOnMaterialChange(listener:Function):void

Default method for removing a materialchanged event listener

Parameters
listener:Function — The listener function
Event detail
materialchangedevent 
Event object type: away3d.events.BillboardEvent

Dispatched when the material of the billboard changes.

Wiki link
Click to go to the wiki page for 'away3d.core.base.Billboard'

Code examples

Comments