| Package | alternativa.engine3d.objects |
| Class | public class Sprite3D |
| Inheritance | Sprite3D  Object3D Object |
| Subclasses | AnimSprite |
Object3D always turned in to the camera.
| Property | Defined By | ||
|---|---|---|---|
| alwaysOnTop : Boolean = false
If true, Sprite3D will drawn over all the rest objects which uses z-buffer sorting. | Sprite3D | ||
 | boundBox : BoundBox
Bounds of the object described as rectangular parallelepiped. | Object3D | |
| concatenatedMatrix : Matrix3D [read-only]
A Matrix3D object representing the combined transformation matrices of the Object3D
and all of its parent objects, back to the root level. | Object3D | |
| doubleClickEnabled : Boolean = false
Specifies whether the object receives doubleClick events. | Object3D | |
| excludedLights : Vector.<Light3D> [read-only]
Returns excluded lights list of current object. | Object3D | |
| height : Number
Height. | Sprite3D | ||
| material : Material
Material of the Sprite3D. | Sprite3D | ||
| matrix : Matrix3D
The matrix property represents a transformation matrix that determines the position
and orientation of an Object3D. | Object3D | |
| mouseChildren : Boolean = true
Determines whether or not the children of the object are mouse, or user input device, enabled. | Object3D | |
| mouseEnabled : Boolean = true
Specifies whether this object receives mouse, or other user input, messages. | Object3D | |
| name : String
Name of the object. | Object3D | |
| numChildren : int [read-only]
Returns the number of children of this object. | Object3D | |
| originX : Number = 0.5
Horizontal coordinate in the Sprite3D plane which defines what part of the plane will placed in x = 0 of the Sprite3D object. | Sprite3D | ||
| originY : Number = 0.5
Vertical coordinate in the Sprite3D plane which defines what part of the plane will placed in y = 0 of the Sprite3D object. | Sprite3D | ||
| parent : Object3D [read-only]
Object3D, to which this object was added as a child. | Object3D | |
| perspectiveScale : Boolean = true
If true, screen size of a Sprite3D will have perspective correction according to distance to a camera. | Sprite3D | ||
| rotation : Number = 0
Rotation in the screen plane, defines in radians. | Sprite3D | ||
| rotationX : Number
The angle of rotation of Object3D around the X-axis expressed in radians. | Object3D | |
| rotationY : Number
The angle of rotation of Object3D around the Y-axis expressed in radians. | Object3D | |
| rotationZ : Number
The angle of rotation of Object3D around the Z-axis expressed in radians. | Object3D | |
| scaleX : Number
The scale of the Object3D along the X-axis. | Object3D | |
| scaleY : Number
The scale of the Object3D along the Y-axis. | Object3D | |
| scaleZ : Number
The scale of the Object3D along the Z-axis. | Object3D | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor)
appears when the pointer rolls over a Object3D. | Object3D | |
| userData : Object
Custom data available to store within Object3D by user. | Object3D | |
| visible : Boolean = true
Whether or not the display object is visible. | Object3D | |
| width : Number
Width. | Sprite3D | ||
| x : Number
X coordinate. | Object3D | |
| y : Number
Y coordinate. | Object3D | |
| z : Number
Z coordinate. | Object3D | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new Sprite3D instance. | Sprite3D | ||
|
Adds given Object3D instance as a child to the end of this Object3D's children list. | Object3D | |
|
Adds a child Object3D instance to this Object3D instance. | Object3D | |
| 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 | |
| calculateBoundBox():void
Calculates object's bounds in its own coordinates
| Object3D | |
| clearExcludedLights(updateChildren:Boolean = false):void
Resets list of lights excluded from lighting this object. | Object3D | |
[override]
Returns a copy of object. | Sprite3D | ||
|
Check if given object is child of this Object3D. | Object3D | |
| dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. | Object3D | |
| excludeLight(light:Light3D, updateChildren:Boolean = false):void
Disables lighting of the object by given light. | Object3D | |
| getChildAt(index:int):Object3D
Returns the child Object3D instance that exists at the specified index. | Object3D | |
| getChildByName(name:String):Object3D
Returns child Object3D instance with given name. | Object3D | |
| getChildIndex(child:Object3D):int
Returns index of given child Object3D instance. | Object3D | |
| getResources(hierarchy:Boolean = false, resourceType:Class = null):Vector.<Resource>
Gather the resources of this Object3D. | Object3D | |
| globalToLocal(point:Vector3D):Vector3D
Converts the Vector3D object from the root Object3D (global) coordinates to the local Object3D's own coordinates. | 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):RayIntersectionData
Searches for the intersection of an Object3D and given ray, defined by origin and direction. | Object3D | |
| localToGlobal(point:Vector3D):Vector3D
Converts the Vector3D object from the Object3D's own (local) coordinates to the root Object3D (global) coordinates. | Object3D | |
|
Removes the specified child Object3D instance from the child list of the
this Object3D instance. | Object3D | |
| removeChildAt(index:int):Object3D
Removes a child Object3D from the specified index position in the child list of
the Object3D. | Object3D | |
| removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
Removes child objects in given range of indexes. | Object3D | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object. | Object3D | |
| setChildIndex(child:Object3D, index:int):void
Sets index for child Object3D instance. | Object3D | |
|
Swaps index positions of two specified child objects. | Object3D | |
| swapChildrenAt(index1:int, index2:int):void
Swaps index positions of two child objects by its index. | Object3D | |
| toString():String
Returns the string representation 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 [override]
Copies basic properties of Object3D. | Sprite3D | ||
| alwaysOnTop | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var alwaysOnTop:Boolean = false
If true, Sprite3D will drawn over all the rest objects which uses z-buffer sorting.
| height | property |
public var height:NumberHeight.
| material | property |
material:MaterialMaterial of the Sprite3D.
public function get material():Material public function set material(value:Material):voidSee also
| originX | property |
public var originX:Number = 0.5
Horizontal coordinate in the Sprite3D plane which defines what part of the plane will placed in x = 0 of the Sprite3D object. The dimension considered with UV-coordinates.
Thus, if originX = 0, image will drawn from 0 to the right, if originX = -1 – to the left.
And image will drawn in the center of the Sprite3D, if originX = 0.5.
| originY | property |
public var originY:Number = 0.5
Vertical coordinate in the Sprite3D plane which defines what part of the plane will placed in y = 0 of the Sprite3D object. The dimension considered with UV-coordinates.
Thus, if originY = 0, image will drawn from 0 to the bottom, if originY = -1 – to the top.
And image will drawn in the center of the Sprite3D, if originY = 0.5.
| perspectiveScale | property |
public var perspectiveScale:Boolean = true
If true, screen size of a Sprite3D will have perspective correction according to distance to a camera. Otherwise Sprite3D will have fixed size with no dependence on point of view.
| rotation | property |
public var rotation:Number = 0Rotation in the screen plane, defines in radians.
| width | property |
public var width:NumberWidth.
| Sprite3D | () | Constructor |
public function Sprite3D(width:Number, height:Number, material:Material = null)Creates a new Sprite3D instance.
Parameterswidth:Number — Width.
| |
height:Number — Height
| |
material:Material (default = null) |
See also
| clone | () | method |
override public function clone():Object3DReturns a copy of object.
ReturnsObject3D — A copy of this Object3D.
|
| clonePropertiesFrom | () | method |
override protected function clonePropertiesFrom(source:Object3D):void
Copies basic properties of Object3D. This method calls from clone() method.
Parameters
source:Object3D — Object3D, properties of which will be copied.
|