away3d.entities.Sprite3D

Public Properties

	Property		Defined By
		animator : IAnimator [read-only] Defines the animator of the mesh.	Sprite3D
		assetFullPath : Array [read-only]	NamedAssetBase
		assetNamespace : String [read-only]	NamedAssetBase
		assetType : String [override] [read-only]	Entity
		backVector : Vector3D [read-only]	Object3D
		bounds : BoundingVolumeBase The bounding volume approximating the volume occupied by the Entity.	Entity
		castsShadows : Boolean [read-only]	Sprite3D
		downVector : Vector3D [read-only]	Object3D
		eulers : Vector3D Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis.	Object3D
		extra : Object An object that can contain any extra data.	Object3D
		forwardVector : Vector3D [read-only]	Object3D
		height : Number	Sprite3D
		ignoreTransform : Boolean [override]	Entity
		indexData : Vector.<uint> [read-only]	Sprite3D
		inverseSceneTransform : Matrix3D [read-only] The inverse scene transform object that transforms from world to model space.	ObjectContainer3D
		leftVector : Vector3D [read-only]	Object3D
		material : MaterialBase	Sprite3D
		maxX : Number [override] [read-only] The maximum extremum of the object along the X-axis.	Entity
		maxY : Number [override] [read-only] The maximum extremum of the object along the Y-axis.	Entity
		maxZ : Number [override] [read-only] The maximum extremum of the object along the Z-axis.	Entity
		minX : Number [override] [read-only] The minimum extremum of the object along the X-axis.	Entity
		minY : Number [override] [read-only] The minimum extremum of the object along the Y-axis.	Entity
		minZ : Number [override] [read-only] The minimum extremum of the object along the Z-axis.	Entity
		mouseChildren : Boolean	ObjectContainer3D
		mouseEnabled : Boolean Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.	ObjectContainer3D
		name : String	NamedAssetBase
		numChildren : uint [read-only] The amount of child objects of the ObjectContainer3D.	ObjectContainer3D
		numTriangles : uint [read-only]	Sprite3D
		numVertices : uint [read-only]	Sprite3D
		originalName : String [read-only] The original name used for this asset in the resource (e.g.	NamedAssetBase
		parent : ObjectContainer3D [read-only] The parent ObjectContainer3D to which this object's transformation is relative.	ObjectContainer3D
		partition : Partition3D The space partition to be used by the object container and all its recursive children, unless it has its own space partition assigned.	ObjectContainer3D
		pickingCollider : IPickingCollider [override]	Sprite3D
		pickingCollisionVO : PickingCollisionVO [read-only] Returns a unique picking collision value object for the entity.	Entity
		pivotPoint : Vector3D Defines the local point around which the object rotates.	Object3D
		position : Vector3D Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		rightVector : Vector3D [read-only]	Object3D
		rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		rotationY : Number Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		rotationZ : Number Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		scaleX : Number Defines the scale of the 3d object along the x-axis, relative to local coordinates.	Object3D
		scaleY : Number Defines the scale of the 3d object along the y-axis, relative to local coordinates.	Object3D
		scaleZ : Number Defines the scale of the 3d object along the z-axis, relative to local coordinates.	Object3D
		scene : Scene3D [override] A reference to the Scene3D object to which this object belongs.	Entity
		scenePosition : Vector3D [read-only] The global position of the ObjectContainer3D in the scene.	ObjectContainer3D
		sceneTransform : Matrix3D [read-only] The transformation matrix that transforms from model to world space.	ObjectContainer3D
		shaderPickingDetails : Boolean Used by the shader-based picking system to determine whether a separate render pass is made in order to offer more details for the picking collision object, including local position, normal vector and uv value.	Entity
		showBounds : Boolean	Entity
		sourceEntity : Entity [read-only]	Sprite3D
		staticNode : Boolean Defines whether or not the object will be moved or animated at runtime.	Entity
		transform : Matrix3D The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		upVector : Vector3D [read-only]	Object3D
		UVData : Vector.<Number> [read-only]	Sprite3D
		uvTransform : Matrix [read-only]	Sprite3D
		vertexData : Vector.<Number> [read-only]	Sprite3D
		vertexNormalData : Vector.<Number> [read-only]	Sprite3D
		vertexNormalOffset : int [read-only]	Sprite3D
		vertexOffset : int [read-only]	Sprite3D
		vertexStride : uint [read-only]	Sprite3D
		vertexTangentData : Vector.<Number> [read-only]	Sprite3D
		vertexTangentOffset : int [read-only]	Sprite3D
		visible : Boolean	ObjectContainer3D
		width : Number	Sprite3D
		worldBounds : BoundingVolumeBase [read-only]	Entity
		x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.	Object3D
		zOffset : int	Object3D

	Property	Defined By
		_bounds : BoundingVolumeBase	Entity
		_boundsInvalid : Boolean = true	Entity
		_explicitPartition : Partition3D	ObjectContainer3D
		_ignoreTransform : Boolean = false	ObjectContainer3D
		_implicitPartition : Partition3D	ObjectContainer3D
		_mouseEnabled : Boolean	ObjectContainer3D
		_parent : ObjectContainer3D	ObjectContainer3D
		_pivotPoint : Vector3D	Object3D
		_pivotZero : Boolean = true	Object3D
		_pos : Vector3D	Object3D
		_rot : Vector3D	Object3D
		_sca : Vector3D	Object3D
		_scaleX : Number = 1	Object3D
		_scaleY : Number = 1	Object3D
		_scaleZ : Number = 1	Object3D
		_scene : Scene3D	ObjectContainer3D
		_sceneTransform : Matrix3D	ObjectContainer3D
		_sceneTransformDirty : Boolean = true	ObjectContainer3D
		_transform : Matrix3D	Object3D
		_transformComponents : Vector.<Vector3D>	Object3D
		_x : Number = 0	Object3D
		_y : Number = 0	Object3D
		_z : Number = 0	Object3D
		_zOffset : int = 0	Object3D

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Sprite3D(material:MaterialBase, width:Number, height:Number)	Sprite3D
		activateSecondaryUVBuffer(index:int, stage3DProxy:Stage3DProxy):void	Sprite3D
		activateUVBuffer(index:int, stage3DProxy:Stage3DProxy):void	Sprite3D
		activateVertexBuffer(index:int, stage3DProxy:Stage3DProxy):void	Sprite3D
		activateVertexNormalBuffer(index:int, stage3DProxy:Stage3DProxy):void	Sprite3D
		activateVertexTangentBuffer(index:int, stage3DProxy:Stage3DProxy):void	Sprite3D
		addChild(child:ObjectContainer3D):ObjectContainer3D Adds a child ObjectContainer3D to the current object.	ObjectContainer3D
		addChildren(... childarray):void Adds an array of 3d objects to the scene as children of the container	ObjectContainer3D
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]	ObjectContainer3D
		assetPathEquals(name:String, ns:String):Boolean	NamedAssetBase
		clone():Object3D [override] Clones this ObjectContainer3D instance along with all it's children, and returns the result (which will be a copy of this container, containing copies of all it's children.)	ObjectContainer3D
		contains(child:ObjectContainer3D):Boolean	ObjectContainer3D
		dispatchEvent(event:Event):Boolean [override]	ObjectContainer3D
		dispose():void [override] Cleans up resources used by this asset.	ObjectContainer3D
		disposeAsset():void	Object3D
		getChildAt(index:uint):ObjectContainer3D Retrieves the child object at the given index.	ObjectContainer3D
		getEntityPartitionNode():EntityNode Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance	Entity
		getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D	Sprite3D
		getRenderSceneTransform(camera:Camera3D):Matrix3D	Sprite3D
		isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Boolean	Entity
		lookAt(target:Vector3D, upAxis:Vector3D = null):void [override] Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.	ObjectContainer3D
		moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
		moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
		moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
		moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
		movePivot(dx:Number, dy:Number, dz:Number):void Moves the local point around which the object rotates.	Object3D
		moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
		moveTo(dx:Number, dy:Number, dz:Number):void Moves the 3d object directly to a point in space	Object3D
		moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
		pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
		removeChild(child:ObjectContainer3D):void Removes a 3d object from the child array of the container	ObjectContainer3D
		removeChildAt(index:uint):void Removes a 3d object from the child array of the container	ObjectContainer3D
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]	ObjectContainer3D
		resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void	NamedAssetBase
		roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
		rotate(axis:Vector3D, angle:Number):void [override]	ObjectContainer3D
		rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
		scale(value:Number):void Appends a uniform scale to the current transformation.	Object3D
		translate(axis:Vector3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
		translateLocal(axis:Vector3D, distance:Number):void [override]	ObjectContainer3D
		updateImplicitVisibility():void	ObjectContainer3D
		yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

	Method	Defined By
		createEntityPartitionNode():EntityNode [override]	Sprite3D
		getDefaultBoundingVolume():BoundingVolumeBase [override]	Sprite3D
		invalidateBounds():void Invalidates the bounding volume, causing to be updated when requested.	Entity
		invalidateSceneTransform():void [override] Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.	Entity
		updateBounds():void [override]	Sprite3D
		updateMouseChildren():void [override]	Entity
		updateSceneTransform():void Updates the scene transformation matrix.	ObjectContainer3D
		updateTransform():void [override]	Sprite3D

Summary	Defined By
mouseDown3d	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	ObjectContainer3D
mouseMove3d	Dispatched when a user moves the cursor while it is over the 3d object.	ObjectContainer3D
mouseOut3d	Dispatched when a user moves the cursor away from the 3d object.	ObjectContainer3D
mouseOver3d	Dispatched when a user moves the cursor over the 3d object.	ObjectContainer3D
mouseUp3d	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	ObjectContainer3D
positionChanged	Dispatched when the position of the 3d object changes.	Object3D
rotationChanged	Dispatched when the rotation of the 3d object changes.	Object3D
scaleChanged	Dispatched when the scale of the 3d object changes.	Object3D
sceneChanged	Dispatched when the parent scene of the 3d object changes.	ObjectContainer3D
scenetransformChanged	Dispatched when the scene transform matrix of the 3d object changes.	ObjectContainer3D

	Constant	Defined By
		DEFAULT_NAMESPACE : String = default [static]	NamedAssetBase

Property Detail

animator

property

animator:IAnimator [read-only]

Defines the animator of the mesh. Act on the mesh's geometry. Defaults to null

Implementation
public function get animator():IAnimator

castsShadows

property

castsShadows:Boolean [read-only]

Implementation
public function get castsShadows():Boolean

height

property

height:Number

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

indexData

property

indexData:Vector.<uint> [read-only]

Implementation
public function get indexData():Vector.<uint>

material

property

material:MaterialBase

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

numTriangles

property

numTriangles:uint [read-only]

Implementation
public function get numTriangles():uint

numVertices

property

numVertices:uint [read-only]

Implementation
public function get numVertices():uint

pickingCollider

property

pickingCollider:IPickingCollider[override]

Implementation
public function get pickingCollider():IPickingCollider
public function set pickingCollider(value:IPickingCollider):void

sourceEntity

property

sourceEntity:Entity [read-only]

Implementation
public function get sourceEntity():Entity

UVData

property

UVData:Vector.<Number> [read-only]

Implementation
public function get UVData():Vector.<Number>

uvTransform

property

uvTransform:Matrix [read-only]

Implementation
public function get uvTransform():Matrix

vertexData

property

vertexData:Vector.<Number> [read-only]

Implementation
public function get vertexData():Vector.<Number>

vertexNormalData

property

vertexNormalData:Vector.<Number> [read-only]

Implementation
public function get vertexNormalData():Vector.<Number>

vertexNormalOffset

property

vertexNormalOffset:int [read-only]

Implementation
public function get vertexNormalOffset():int

vertexOffset

property

vertexOffset:int [read-only]

Implementation
public function get vertexOffset():int

vertexStride

property

vertexStride:uint [read-only]

Implementation
public function get vertexStride():uint

vertexTangentData

property

vertexTangentData:Vector.<Number> [read-only]

Implementation
public function get vertexTangentData():Vector.<Number>

vertexTangentOffset

property

vertexTangentOffset:int [read-only]

Implementation
public function get vertexTangentOffset():int

width

property

width:Number

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

Constructor Detail

Sprite3D

()

Constructor

public function Sprite3D(material:MaterialBase, width:Number, height:Number)

Parameters

	`material:MaterialBase`

	`width:Number`

	`height:Number`

Method Detail

activateSecondaryUVBuffer

()

method

public function activateSecondaryUVBuffer(index:int, stage3DProxy:Stage3DProxy):void

Parameters

	`index:int`

	`stage3DProxy:Stage3DProxy`

activateUVBuffer

()

method

public function activateUVBuffer(index:int, stage3DProxy:Stage3DProxy):void

Parameters

	`index:int`

	`stage3DProxy:Stage3DProxy`

activateVertexBuffer

()

method

public function activateVertexBuffer(index:int, stage3DProxy:Stage3DProxy):void

Parameters

	`index:int`

	`stage3DProxy:Stage3DProxy`

activateVertexNormalBuffer

()

method

public function activateVertexNormalBuffer(index:int, stage3DProxy:Stage3DProxy):void

Parameters

	`index:int`

	`stage3DProxy:Stage3DProxy`

activateVertexTangentBuffer

()

method

public function activateVertexTangentBuffer(index:int, stage3DProxy:Stage3DProxy):void

Parameters

	`index:int`

	`stage3DProxy:Stage3DProxy`

collidesBefore

()

method

override arcane function collidesBefore(shortestCollisionDistance:Number, findClosest:Boolean):Boolean

Parameters

	`shortestCollisionDistance:Number`

	`findClosest:Boolean`

Returns

Boolean

createEntityPartitionNode

()

method

override protected function createEntityPartitionNode():EntityNode

Returns

EntityNode

getDefaultBoundingVolume

()

method

override protected function getDefaultBoundingVolume():BoundingVolumeBase

Returns

BoundingVolumeBase

getIndexBuffer

()

method

public function getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D

Parameters

stage3DProxy:Stage3DProxy

Returns

IndexBuffer3D

getRenderSceneTransform

()

method

public function getRenderSceneTransform(camera:Camera3D):Matrix3D

Parameters

camera:Camera3D

Returns

Matrix3D

updateBounds

()

method

override protected function updateBounds():void

updateTransform

()

method

override protected function updateTransform():void

Tue May 7 2013, 10:42 PM +01:00

Away3D 4.1Beta Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Sprite3D	Properties \| Methods \| Events \| Constants

Package	away3d.entities
Class	public class Sprite3D
Inheritance	Sprite3D Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher
Implements	IRenderable