away3d.sprites.Sprite3D

	Property	Defined By
		align : String Defines how the 3d sprite is aligned to its vertex	Sprite3D
		commands : Vector.<String> [read-only] 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
		extra : 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 [override] [read-only] Returns the maximum x value of the segment	Sprite3D
		maxY : Number [override] [read-only] Returns the maximum y value of the segment	Sprite3D
		maxZ : Number [override] [read-only] Returns the maximum z value of the segment	Sprite3D
		minX : Number [override] [read-only] Returns the minimum x value of the face	Sprite3D
		minY : Number [override] [read-only] Returns the minimum y value of the face	Sprite3D
		minZ : Number [override] [read-only] Returns the minimum y value of the face	Sprite3D
		parent : Geometry Defines the parent 3d object of the segment.	Element
		pathCommands : Array [read-only] Returns an array of drawing command objects that are used by the face.	Element
		radius2 : Number [override] [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
		vertexDirty : Boolean	Element
		vertices : Vector.<Vertex> [read-only] Returns an array of vertex objects that make up the 3d element.	Element
		visible : 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

Property

Defined By

align : String

Defines how the 3d sprite is aligned to its vertex

Sprite3D

commands : Vector.<String>

[read-only] 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

extra : 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

[override] [read-only] Returns the maximum x value of the segment

Sprite3D

maxY : Number

[override] [read-only] Returns the maximum y value of the segment

Sprite3D

maxZ : Number

[override] [read-only] Returns the maximum z value of the segment

Sprite3D

minX : Number

[override] [read-only] Returns the minimum x value of the face

Sprite3D

minY : Number

[override] [read-only] Returns the minimum y value of the face

Sprite3D

minZ : Number

[override] [read-only] Returns the minimum y value of the face

Sprite3D

parent : Geometry

Defines the parent 3d object of the segment.

Element

pathCommands : Array

[read-only] Returns an array of drawing command objects that are used by the face.

Element

radius2 : Number

[override] [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

vertexDirty : Boolean

Element

vertices : Vector.<Vertex>

[read-only] Returns an array of vertex objects that make up the 3d element.

Element

visible : 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

	Property	Defined By
		_commands : Vector.<String>	Element
		_index : int	Element
		_lastAddedVertex : Vertex	Element
		_pathCommands : Array	Element
		_uvs : Vector.<UV>	Element
		_vertices : Vector.<Vertex>	Element

Property

Defined By

_commands : Vector.<String>

Element

_index : int

Element

_lastAddedVertex : Vertex

Element

_pathCommands : Array

Element

_uvs : Vector.<UV>

Element

_vertices : Vector.<Vertex>

Element

	Method	Defined 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
		addOnMappingChange(listener:Function):void Default method for adding a mappingchanged event listener	Element
		addOnVertexChange(listener:Function):void Default method for adding a vertexchanged event listener	Element
		addOnVertexValueChange(listener:Function):void Default method for adding a vertexvaluechanged event listener	Element
		addOnVisibleChange(listener:Function):void Default method for adding a visiblechanged event listener	Element
		offset(x:Number, y:Number, z:Number):void Offsets the vertices of the face by given amounts in x, y and z.	Element
		removeOnMappingChange(listener:Function):void Default method for removing a mappingchanged event listener	Element
		removeOnVertexChange(listener:Function):void Default method for removing a vertexchanged event listener	Element
		removeOnVertexValueChange(listener:Function):void Default method for removing a vertexvaluechanged event listener	Element
		removeOnVisibleChange(listener:Function):void Default method for removing a visiblechanged event listener	Element

Method

Defined 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

addOnMappingChange(listener:Function):void

Default method for adding a mappingchanged event listener

Element

addOnVertexChange(listener:Function):void

Default method for adding a vertexchanged event listener

Element

addOnVertexValueChange(listener:Function):void

Default method for adding a vertexvaluechanged event listener

Element

addOnVisibleChange(listener:Function):void

Default method for adding a visiblechanged event listener

Element

offset(x:Number, y:Number, z:Number):void

Offsets the vertices of the face by given amounts in x, y and z.

Element

removeOnMappingChange(listener:Function):void

Default method for removing a mappingchanged event listener

Element

removeOnVertexChange(listener:Function):void

Default method for removing a vertexchanged event listener

Element

removeOnVertexValueChange(listener:Function):void

Default method for removing a vertexvaluechanged event listener

Element

removeOnVisibleChange(listener:Function):void

Default method for removing a visiblechanged event listener

Element

Summary	Defined By
materialchanged	Dispatched when the material of the sprite3d changes.	Sprite3D
vertexChanged	Dispatched when the vertex of a 3d element changes.	Element
vertexvalueChanged	Dispatched when the vertex value of a 3d element changes.	Element
visibleChanged	Dispatched when the visiblity of a 3d element changes.	Element

Event

Summary

Defined By

materialchanged

Dispatched when the material of the sprite3d changes.

Sprite3D

vertexChanged

Dispatched when the vertex of a 3d element changes.

Element

vertexvalueChanged

Dispatched when the vertex value of a 3d element changes.

Element

visibleChanged

Dispatched when the visiblity of a 3d element changes.

Element

Property Detail

align

property

align:String

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

distanceScaling

property

distanceScaling:Boolean

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

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

height

property

height:Number

Defines the height of the 3d sprite.

Implementation
public function get height():Number
public function set height(value:Number):void

material

property

material:Material

Defines the material of the 3d sprite.

Implementation
public function get material():Material
public function set material(value:Material):void

maxX

property

maxX:Number [read-only] [override]

Returns the maximum x value of the segment

Implementation
public function get maxX():Number

See also

away3d.core.base.Vertex.x

maxY

property

maxY:Number [read-only] [override]

Returns the maximum y value of the segment

Implementation
public function get maxY():Number

See also

away3d.core.base.Vertex.y

maxZ

property

maxZ:Number [read-only] [override]

Returns the maximum z value of the segment

Implementation
public function get maxZ():Number

See also

away3d.core.base.Vertex.z

minX

property

minX:Number [read-only] [override]

Returns the minimum x value of the face

Implementation
public function get minX():Number

See also

away3d.core.base.Vertex.x

minY

property

minY:Number [read-only] [override]

Returns the minimum y value of the face

Implementation
public function get minY():Number

See also

away3d.core.base.Vertex.y

minZ

property

minZ:Number [read-only] [override]

Returns the minimum y value of the face

Implementation
public function get minZ():Number

See also

away3d.core.base.Vertex.y

radius2

property

radius2:Number [read-only] [override]

Returns the squared bounding radius of the 3d sprite.

Implementation
public function get radius2():Number

rotation

property

rotation:Number

Defines the rotation of the 3d sprite.

Implementation
public function get rotation():Number
public function set rotation(value:Number):void

scaling

property

scaling:Number

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

spriteVO

property

public var spriteVO:SpriteVO

width

property

width:Number

Defines the width of the 3d sprite.

Implementation
public function get width():Number
public function set width(value:Number):void

property

x:Number

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

property

y:Number

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

property

z:Number

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)

Creates a new Billboard object.

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####

Event Detail

materialchanged

Event

Event Object Type: away3d.events.BillboardEvent
BillboardEvent.type property = away3d.events.FaceEvent

Dispatched when the material of the sprite3d changes.

Tue Jun 7 2011, 11:27 PM +01:00

Away3D FP10 V3.6.0 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Sprite3D	Properties \| Methods \| Events

Package	away3d.sprites
Class	public class Sprite3D
Inheritance	Sprite3D Element flash.events.EventDispatcher
Subclasses	DepthOfFieldSprite, DirectionalSprite, MovieClipSprite