alternativa.engine3d.objects.Sprite3D

Public Properties

	Property		Defined by
		alpha : Number = 1 Alpha transparency value.	Object3D
		autoSize : Boolean = false If `true` the size of sprite is synchronized with texture size.	Sprite3D
		blendMode : String = "normal" A value from the `flash.`	Object3D
		boundMaxX : Number = 1e+22 Right bound of object in its space.	Object3D
		boundMaxY : Number = 1e+22 Front bound of object in its space.	Object3D
		boundMaxZ : Number = 1e+22 Top bound of object in its space.	Object3D
		boundMinX : Number = -1e+22 Left bound of object in its space.	Object3D
		boundMinY : Number = -1e+22 Back bound of object in its space.	Object3D
		boundMinZ : Number = -1e+22 Bottom bound of object in its space.	Object3D
		clipping : int = 2 Object clipping mode by camera frustum.	Sprite3D
		colorTransform : ColorTransform = null A ColorTransform object containing values that universally adjust the colors in the display object.	Object3D
		concatenatedMatrix : Matrix3D A `Matrix3D` object which is the combined result of transformation matrices of object and all its parens.	Object3D
		doubleClickEnabled : Boolean = false Specifies whether the object receives `doubleClick` events.	Object3D
		filters : Array = null An indexed array that contains each filter object currently associated with the display object.	Object3D
		height : Number Sprite height.	Sprite3D
		material : Material Sprite material.	Sprite3D
		matrix : Matrix3D `Matrix3D` object.	Object3D
		mouseEnabled : Boolean = true Specifies whether this object receives mouse messages.	Object3D
		name : String Object name.	Object3D
		originX : Number = 0.5 X coordinate of the origin point.	Sprite3D
		originY : Number = 0.5 Y coordinate of the origin point.	Sprite3D
		parent : Object3DContainer Indicates the Object3DContainer object that contains this display object.	Object3D
		perspectiveScale : Boolean = true Perspective scale option.	Sprite3D
		rotation : Number = 0 Rotation angle (in radians).	Sprite3D
		rotationX : Number = 0 Rotation angle by X axis (in radians).	Object3D
		rotationY : Number = 0 Rotation angle by Y axis (in radians).	Object3D
		rotationZ : Number = 0 Rotation angle by Z axis (in radians).	Object3D
		scaleX : Number = 1 Scale by X axis.	Object3D
		scaleY : Number = 1 Scale by Y axis.	Object3D
		scaleZ : Number = 1 Scale by Z axis.	Object3D
		sorting : int = 0 Sorting mode.	Sprite3D
		useHandCursor : Boolean = false Set this property to `true` to show "hand" mouse cursor while hovering the object, `false` otherwise.	Object3D
		visible : Boolean = true Whether or not the display object is visible.	Object3D
		width : Number Sprite width.	Sprite3D
		x : Number = 0 X coordinate.	Object3D
		y : Number = 0 Y coordinate.	Object3D
		z : Number = 0 Z coordinate.	Object3D

	Method	Defined by
		Sprite3D(width:Number, height:Number, material:Material = null) Creates a new instance.	Sprite3D
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	Object3D
		calculateBounds():void Calculates object bounds in its space.	Object3D
		calculateResolution(textureWidth:int, textureHeight:int, type:int = 1, matrix:Matrix3D = null):Number Calculates how many units of 3D space correspond to one pixel of texture.	Sprite3D
		clone():Object3D Returns an object that is an exact copy of the original object.	Sprite3D
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	Object3D
		globalToLocal(point:Vector3D):Vector3D Transforms a point from global space to local spce of the object.	Object3D
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	Object3D
		intersectRay(origin:Vector3D, direction:Vector3D, excludedObjects:Dictionary = null, camera:Camera3D = null):RayIntersectionData Searches for the ray intersection.	Sprite3D
		localToGlobal(point:Vector3D):Vector3D Transforms a point from local space of object to global spce.	Object3D
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	Object3D
		toString():String Returns the string presentation of the specified object.	Object3D
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	Object3D

	Method	Defined by
		clonePropertiesFrom(source:Object3D):void Copies the base properties.	Sprite3D

Summary	Defined by
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same object.	Object3D
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same object when that object's doubleClickEnabled flag is set to true.	Object3D
mouseDown	Dispatched when a user presses the pointing device button over an object.	Object3D
mouseMove	Dispatched when a user moves the pointing device while it is over an object.	Object3D
mouseOut	Dispatched when the user moves a pointing device away from an object.	Object3D
mouseOver	Dispatched when the user moves a pointing device over an object.	Object3D
mouseUp	Dispatched when a user releases the pointing device button over an object.	Object3D
mouseWheel	Dispatched when a mouse wheel is spun over an object.	Object3D
rollOut	Dispatched when the user moves a pointing device away from an object.	Object3D
rollOver	Dispatched when the user moves a pointing device over an object.	Object3D

Property detail

autoSize

property

public var autoSize:Boolean = false

If true the size of sprite is synchronized with texture size. Default value is false.

clipping

property

public var clipping:int = 2

Object clipping mode by camera frustum. You can use following constants of Clipping class: Clipping.BOUND_CULLING, Clipping.FACE_CULLING, Clipping.FACE_CLIPPING. Default value is Clipping.FACE_CLIPPING.

See also

alternativa.engine3d.core.Clipping

height

property

public var height:Number

Sprite height.

material

property

public var material:Material

Sprite material.

See also

alternativa.engine3d.materials.Material

originX

property

public var originX:Number = 0.5

X coordinate of the origin point. Can be from 0 to 1. Default value is 0.5.

originY

property

public var originY:Number = 0.5

Y coordinate of the origin point. Can be from 0 to 1. Default value is 0.5.

perspectiveScale

property

public var perspectiveScale:Boolean = true

Perspective scale option. If false, size of sprite will be the same regardless of distance to camera. Default value is true.

rotation

property

public var rotation:Number = 0

Rotation angle (in radians).

sorting

property

public var sorting:int = 0

Sorting mode. You can use the following constants of Sorting to determine sorting property: Sorting.NONE, Sorting.AVERAGE_Z, Sorting.DYNAMIC_BSP. This property doen't mean anything with usual drawing. But if sprite is a child of ConflictContainer object, then in the sorting on polygonal level it does mean something. Default value is Sorting.NONE.

width

property

public var width:Number

Sprite width.

Constructor detail

Sprite3D

()

constructor

public function Sprite3D(width:Number, height:Number, material:Material = null)

Creates a new instance.

Parameters

	`width:Number` — Sprite width.

	`height:Number` — Sprite height.

	`material:Material` (default = `null`) — Material.

See also

alternativa.engine3d.materials.Material

Method detail

calculateResolution

()

method

public override function calculateResolution(textureWidth:int, textureHeight:int, type:int = 1, matrix:Matrix3D = null):Number

Calculates how many units of 3D space correspond to one pixel of texture. It is useful for mipmapping.

Parameters

	`textureWidth:int` — Texture width.

	`textureHeight:int` — Texture height.

	`type:int` (default = `1`) — Calculation method: 0 - by first edge, 1 - average value, 2 - max value, 3 - min value.

	`matrix:Matrix3D` (default = `null`) — Transformation matrix.

Returns

Number — Resolution.

clone

()

method

public override function clone():Object3D

Returns an object that is an exact copy of the original object.

Returns

Object3D — Original object clone.

clonePropertiesFrom

()

method

protected override function clonePropertiesFrom(source:Object3D):void

Copies the base properties.

Parameters

source:Object3D — Source object.

intersectRay

()

method

public override function intersectRay(origin:Vector3D, direction:Vector3D, excludedObjects:Dictionary = null, camera:Camera3D = null):RayIntersectionData

Searches for the ray intersection.

Parameters

	`origin:Vector3D` — Ray origin.

	`direction:Vector3D` — Ray direction.

	`excludedObjects:Dictionary` (default = `null`) — The objects that are keys of this dictionary will be exluded from intersection test.

	`camera:Camera3D` (default = `null`) — The camera for `Sprite3D` objects intersection test.

Returns

RayIntersectionData — Intersection test result - RayIntersectionData object. If there is no intersection the value of null will be returned.

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Sprite3D	Properties \| Methods \| Events

Package	alternativa.engine3d.objects
Class	public class Sprite3D
Inheritance	Sprite3D Object3D
Subclasses	AnimSprite