| Package | sandy.core.scenegraph |
| Class | public class Sprite3D |
| Inheritance | Sprite3D Sprite2D ATransformable Node |
A Sprite3D can be seen as a special Sprite2D.
It has an appearance that is a movie clip containing 360 frames (as maximum!) with texture.
Depending on the camera position, a different frame of the clip is shown, givin a 3D effect.
| Property | Defined by | ||
|---|---|---|---|
![]() | appearance : Appearance
Set that appearance to all the children of that node
| Node | |
![]() | autoCenter : Boolean = true
When enabled, the sprite will be displayed at its graphical center.
| Sprite2D | |
![]() | boundingBox : BBox
The bounding box of this node
IMPORTANT: Do not modify it unless you perfectly know what you are doing
| Node | |
![]() | boundingSphere : BSphere
The bounding sphere of this node
IMPORTANT: Do not modify it unless you perfectly know what you are doing
| Node | |
![]() | broadcaster : BubbleEventBroadcaster
The broadcaster
The broadcaster is used to send events to listeners. | Node | |
![]() | changed : Boolean = false
This property set the cache status of the current node.
| Node | |
![]() | container : Sprite
The container of this sprite ( canvas )
| Sprite2D | |
| content : DisplayObject [write-only]
The MovieClip that will used as content of this Sprite2D.
| Sprite3D | ||
![]() | culled : CullingState
This property represent the culling state of the current node.
| Node | |
![]() | depth : Number
The depth to draw this sprite at.
| Sprite2D | |
![]() | disable : Boolean = false
Disable the local transformations applied to this Node if set to false.
| ATransformable | |
![]() | enableBackFaceCulling : Boolean
Change the backface culling state to all the shapes objects in the children list
| Node | |
![]() | enableEvents : Boolean | Sprite2D | |
![]() | enableForcedDepth : Boolean = false
Should forced depth be enable for this object?.
| Sprite2D | |
![]() | enableInteractivity : Boolean
Change the interactivity of all the children
| Node | |
![]() | fixedAngle : Boolean = false
Set this to true if you want this sprite to rotate with camera.
| Sprite2D | |
![]() | floorCenter : Boolean = false
When enabled, the sprite will be displayed at its bottom line.
| Sprite2D | |
![]() | forcedDepth : Number = 0
The forced depth for this object.
| Sprite2D | |
![]() | material : Material
Material that the sprite will be dressed in.
| Sprite2D | |
![]() | matrix : Matrix4 | ATransformable | |
![]() | name : String
Name of this node.
| Node | |
| offset : uint = 0 | Sprite3D | ||
![]() | out : Vector
Forward direction ( local z ) in parent coordinates.
| ATransformable | |
![]() | pan : Number
Pans this object around the local y axis.
| ATransformable | |
![]() | parent : Node
The parent node of this node.
| Node | |
![]() | roll : Number
Rolls this object around the local z axis.
| ATransformable | |
![]() | rotateX : Number
Rotates this object around an axis parallel to the parents x axis.
| ATransformable | |
![]() | rotateY : Number
Rotates this object around an axis parallel to the parents y axis.
| ATransformable | |
![]() | rotateZ : Number
Rotates this object around an axis paralell to the parents z axis.
| ATransformable | |
![]() | scale : Number
The scale of this sprite.
| Sprite2D | |
![]() | scaleX : Number
x scale of this object.
| ATransformable | |
![]() | scaleY : Number
y scale of this object.
| ATransformable | |
![]() | scaleZ : Number
z scale of this object.
| ATransformable | |
![]() | scene : Scene3D = null
Reference to the scene is it linked to.
| Node | |
![]() | side : Vector
Side direction ( local x ) in parent coordinates.
| ATransformable | |
![]() | target : Vector
The position in the parent frame this object should "look at".
| ATransformable | |
![]() | tilt : Number
Tilts this object around the local x axis.
| ATransformable | |
![]() | up : Vector
Up direction ( local y ) in parent coordinates.
| ATransformable | |
![]() | useSingleContainer : Boolean
Make all the Shape3D and descendants children react to this value.
| Node | |
![]() | visible : Boolean = true
Specify the visibility of this node.
| Node | |
![]() | x : Number
x position of this object in its parent frame.
| ATransformable | |
![]() | y : Number
y position of this object in its parent frame.
| ATransformable | |
![]() | z : Number
z position of the node in its parent frame.
| ATransformable | |
| Method | Defined by | ||
|---|---|---|---|
|
Sprite3D(p_sName:String = "", p_oContent:MovieClip = null, p_nScale:Number = 1, p_nOffset:Number = 0)
Creates a Sprite3D
| Sprite3D | ||
![]() |
Adds a new child to this node.
| Node | |
![]() |
addEventListener(p_sEvt:String, p_oL:*):void
Adds a listener for the specified event.
| Node | |
![]() |
clear():void
Clears the graphics object of this object's container.
| Sprite2D | |
![]() |
Tests this node against the camera frustum to get its visibility.
| Sprite2D | |
![]() |
destroy():void
Delete this node and all its child nodes.
| Node | |
![]() |
Displays this sprite.
| Sprite2D | |
![]() |
getChildByName(p_sName:String, p_bRecurs:Boolean = false):Node
Returns the child node with the specified name.
| Node | |
![]() |
getPosition(p_sMode:String = "local"):Vector
Returns the position of this group or object.
| ATransformable | |
![]() |
hasParent():Boolean
Tests if this node has a parent.
| Node | |
![]() |
initFrame():void
Initiates the local coordinate system for this object.
| ATransformable | |
![]() |
Tests if the node passed in the argument is parent of this node.
| Node | |
![]() |
lookAt(p_nX:Number, p_nY:Number, p_nZ:Number):void
Makes this object "look at" the specified position in the parent frame.
| ATransformable | |
![]() |
moveForward(p_nD:Number):void
Translates this object along its forward vector ( local z ) in the parent frame.
| ATransformable | |
![]() |
moveHorizontally(p_nD:Number):void
Translates this object parallel to its parent zx plane and in its forward direction.
| ATransformable | |
![]() |
moveLateraly(p_nD:Number):void
Translates this object laterally in its parent frame.
| ATransformable | |
![]() |
moveSideways(p_nD:Number):void
Translates this object along its side vector ( local x ) in the parent frame.
| ATransformable | |
![]() |
moveUpwards(p_nD:Number):void
Translates this object along its up vector ( local y ) in the parent frame.
| ATransformable | |
![]() |
moveVertically(p_nD:Number):void
Translates this object vertically in ots parent frame.
| ATransformable | |
![]() |
perform(p_iOperation:INodeOperation):void
Performs an operation on this node and all of its children.
| Node | |
![]() |
remove():void
Provide the classical remove behaviour, plus remove the container to the display list.
| Sprite2D | |
![]() |
removeChildByName(p_sName:String):Boolean
Removes the child node with the specified name.
| Node | |
![]() |
removeEventListener(p_sEvt:String, p_oL:*):void
Removes a listener for the specified event.
| Node | |
|
Renders this 3D sprite
| Sprite3D | ||
![]() |
rotateAxis(p_nX:Number, p_nY:Number, p_nZ:Number, p_nAngle:Number):void
Rotate this object around the specified axis in the parent frame by the specified angle.
| ATransformable | |
![]() |
setBoundingSphereRadius(p_nRadius:Number):void
Sets the radius of bounding sphere for this sprite.
| Sprite2D | |
![]() |
setPosition(p_nX:Number, p_nY:Number, p_nZ:Number):void
Sets the position of this object in coordinates of its parent frame.
| ATransformable | |
![]() |
swapParent(p_oNewParent:Node):void
Moves this node to another parent node.
| Node | |
![]() |
toString():String
| Sprite2D | |
![]() |
translate(p_nX:Number, p_nY:Number, p_nZ:Number):void
Translate this object from it's current position with the specified offsets.
| ATransformable | |
![]() |
Updates this node or object.
| ATransformable | |
![]() |
updateTransform():void
Updates the transform matrix of the current object/node before it is rendered.
| ATransformable | |
| content | property |
content:DisplayObject [write-only]The MovieClip that will used as content of this Sprite2D. If this MovieClip has already a scree position, it will be reseted to 0,0.
Implementation public function set content(value:DisplayObject):void
| offset | property |
public var offset:uint = 0
| Sprite3D | () | constructor |
public function Sprite3D(p_sName:String = "", p_oContent:MovieClip = null, p_nScale:Number = 1, p_nOffset:Number = 0)Creates a Sprite3D
Parametersp_sName:String (default = "") — A string identifier for this object
|
|
p_oContent:MovieClip (default = null) — The Movieclip containing the pre-rendered textures
|
|
p_nScale:Number (default = 1) — A number used to change the scale of the displayed object.
In case that the object projected dimension
isn't adapted to your needs.
Default value is 1.0 which means unchanged.
A value of 2.0 will double object size.
A value of 0 will force original graphics size independent of distance.
|
|
p_nOffset:Number (default = 0) — A number between [0-360] to give angle offset into the clip.
|
| render | () | method |
public override function render(p_oScene:Scene3D, p_oCamera:Camera3D):voidRenders this 3D sprite
Parametersp_oScene:Scene3D — The current scene
|
|
p_oCamera:Camera3D — The current camera
|