Difference between revisions of "Sprite"

From GiderosMobile
(quick and dirty missing gideros methods descriptions)
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Supported platforms:''' android, ios, mac, pc<br/>
+
<!-- GIDEROSOBJ:Sprite -->
 +
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Inherits from:''' [[EventDispatcher]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
The Sprite class is the base class for all objects that can be placed on the scene tree. It is the basic scene tree building block.
The `Sprite` class is the base class for all objects that can be placed on the scene tree. It is the basic scene tree building block.<br />
+
 
A sprite can contain child sprites which makes the scene tree hierarchy.
+
A sprite can contain child sprites which makes the scene tree hierarchy. Transformations such as translation, rotation, scaling, and color transforms, propagate its effect to all of its children.
Transformations such as translation, rotation, scaling and color transforms propogates its effect to all of its children.<br />
+
 
The drawing order is defined by the order of children. First child is drawn first and last child is drawn last. It is possible to change the drawing order by modifying the order of child list.<br />
+
The drawing order is defined by the order of children. The first child is drawn first and the last child is drawn last. It is possible to change the drawing order by modifying the order of child list.
A `Sprite` instance can exists without attaching the scene tree.<br />
+
 
An unattached sprite can receive `Event.ENTER_FRAME` event but it will only receive mouse and touch events when it is attached to the scene tree.<br />
+
A Sprite instance can exist without attaching the scene tree.
 +
 
 +
An unattached sprite can receive [[Event.ENTER_FRAME]] event but it will only receive mouse and touch events when it is attached to the scene tree.
 +
 
 
{|-
 
{|-
| style="width: 50%;"|
+
| style="width: 50%; vertical-align:top;"|
 
=== Methods ===
 
=== Methods ===
[[Sprite.new]] - creates a new Sprite object<br/>
+
[[Sprite.new]] ''creates a new Sprite object''<br/><!--GIDEROSMTD:Sprite.new() creates a new Sprite object-->
[[Sprite:addChild]] - adds a sprite as a child<br/>
+
[[Sprite:addChild]] ''adds a sprite as a child''<br/><!--GIDEROSMTD:Sprite:addChild(child) adds a sprite as a child-->
[[Sprite:addChildAt]] - add a sprite as a child at the index position specified<br/>
+
[[Sprite:addChildAt]] ''adds a sprite as a child at the index position specified''<br/><!--GIDEROSMTD:Sprite:addChildAt(child,index) adds a sprite as a child at the index position specified-->
[[Sprite:clearBlendMode]] - clears the blending mode<br/>
+
[[Sprite:clearBlendMode]] ''clears the blending mode''<br/><!--GIDEROSMTD:Sprite:clearBlendMode() clears the blending mode-->
[[Sprite:contains]] - determines whether the specified sprite is contained in the subtree of this sprite<br/>
+
[[Sprite:contains]] ''determines whether the specified sprite is contained in the subtree of this sprite''<br/><!--GIDEROSMTD:Sprite:contains(child) determines whether the specified sprite is contained in the subtree of this sprite-->
[[Sprite:get]] - gets the specified property by its name<br/>
+
[[Sprite:get]] ''gets the specified property by its name''<br/><!--GIDEROSMTD:Sprite:get(param) gets the specified property by its name-->
[[Sprite:getAlpha]] - returns the alpha transparency of this sprite<br/>
+
[[Sprite:getAlpha]] ''returns the alpha transparency of this sprite''<br/><!--GIDEROSMTD:Sprite:getAlpha() returns the alpha transparency of this sprite-->
[[Sprite:getAnchorPosition]] - Returns anchor position of Sprite<br/>
+
[[Sprite:getAnchorPosition]] ''returns anchor position of Sprite''<br/><!--GIDEROSMTD:Sprite:getAnchorPosition() returns anchor position of Sprite-->
[[Sprite:getBounds]] - returns the bounds as it appears in another sprite's coordinate system<br/>
+
[[Sprite:getBounds]] ''returns the bounds as it appears in another sprite coordinate system''<br/><!--GIDEROSMTD:Sprite:getBounds(targetSprite) returns the bounds as it appears in another sprite coordinate system-->
[[Sprite:getChildAt]] - returns the child sprite that exists at the specified index<br/>
+
[[Sprite:getChildAt]] ''returns the child sprite that exists at the specified index''<br/><!--GIDEROSMTD:Sprite:getChildAt(index) returns the child sprite that exists at the specified index-->
[[Sprite:getChildIndex]] - returns the index of the specified child sprite<br/>
+
[[Sprite:getChildIndex]] ''returns the index of the specified child sprite''<br/><!--GIDEROSMTD:Sprite:getChildIndex(child) returns the index of the specified child sprite-->
[[Sprite:getClip]] - <br/>
+
[[Sprite:getChildrenAtPoint]] ''returns the children sprites that corresponds to the given screen coordinates''<br/><!--GIDEROSMTD:Sprite:getChildrenAtPoint(x,y,visible,nosubs) returns the children sprites that corresponds to the given screen coordinates-->
[[Sprite:getColorTransform]] - returns the red, green, blue and alpha channel multipliers<br/>
+
[[Sprite:getClip]] returns the coordinates of the Sprite clip range if set with setClip<br/><!--GIDEROSMTD:Sprite:getClip() returns the coordinates of the Sprite clip range if set with setClip-->
[[Sprite:getHeight]] - returns the height<br/>
+
[[Sprite:getColorTransform]] ''returns the red, green, blue and alpha channel multipliers''<br/><!--GIDEROSMTD:Sprite:getColorTransform() returns the red, green, blue and alpha channel multipliers-->
[[Sprite:getMatrix]] - returns the transformation matrix of the sprite<br/>
+
[[Sprite:getDrawCount]] ''returns the number of Sprites actually drawn each frame on this subtree''<br/><!--GIDEROSMTD:Sprite:getDrawCount() returns the number of Sprites actually drawn each frame on this subtree-->
[[Sprite:getNumChildren]] - returns the number of children of this sprite<br/>
+
[[Sprite:getHeight]] ''returns the height''<br/><!--GIDEROSMTD:Sprite:getHeight(withoutTransform) returns the height-->
[[Sprite:getParent]] - returns the parent sprite<br/>
+
[[Sprite:getLayoutConstraints]] ''gets the current layout constraints''<br/><!--GIDEROSMTD:Sprite:getLayoutConstraints() gets the current layout constraints-->
[[Sprite:getPosition]] - gets the x,y and z coordinates of the sprite<br/>
+
[[Sprite:getLayoutInfo]] ''gets information of the current layout''<br/><!--GIDEROSMTD:Sprite:getLayoutInfo() gets information of the current layout-->
[[Sprite:getRotation]] - returns the rotation of the sprite in degrees<br/>
+
[[Sprite:getLayoutParameters]] ''gets the current layout parameters''<br/><!--GIDEROSMTD:Sprite:getLayoutParameters() gets the current layout parameters-->
[[Sprite:getRotationX]] - returns the rotation of the sprite around x axis in degrees<br/>
+
[[Sprite:getMatrix]] ''returns the transformation matrix of the sprite''<br/><!--GIDEROSMTD:Sprite:getMatrix() returns the transformation matrix of the sprite-->
[[Sprite:getRotationY]] - returns the rotation of the sprite around y axis in degrees<br/>
+
[[Sprite:getNumChildren]] ''returns the number of children of this sprite''<br/><!--GIDEROSMTD:Sprite:getNumChildren() returns the number of children of this sprite-->
[[Sprite:getScale]] - returns the horizontal, vertical and z scales of the sprite<br/>
+
[[Sprite:getParent]] ''returns the parent sprite''<br/><!--GIDEROSMTD:Sprite:getParent() returns the parent sprite-->
[[Sprite:getScaleX]] - returns the horizontal scale of the sprite<br/>
+
[[Sprite:getPosition]] ''gets the x,y and z coordinates of the sprite''<br/><!--GIDEROSMTD:Sprite:getPosition() gets the x,y and z coordinates of the sprite-->
[[Sprite:getScaleY]] - returns the vertical scale of the sprite<br/>
+
[[Sprite:getRotation]] ''returns the rotation of the sprite in degrees''<br/><!--GIDEROSMTD:Sprite:getRotation() returns the rotation of the sprite in degrees-->
[[Sprite:getScaleZ]] - returns the scale on z axis of the sprite<br/>
+
[[Sprite:getRotationX]] ''returns the rotation of the sprite around x axis in degrees''<br/><!--GIDEROSMTD:Sprite:getRotationX() returns the rotation of the sprite around x axis in degrees-->
[[Sprite:getSkew]] - <br/>
+
[[Sprite:getRotationY]] ''returns the rotation of the sprite around y axis in degrees''<br/><!--GIDEROSMTD:Sprite:getRotationY() returns the rotation of the sprite around y axis in degrees-->
[[Sprite:getSkewX]] - <br/>
+
[[Sprite:getScale]] ''returns the horizontal, vertical and z scales of the sprite''<br/><!--GIDEROSMTD:Sprite:getScale() returns the horizontal, vertical and z scales of the sprite-->
[[Sprite:getSkewY]] - <br/>
+
[[Sprite:getScaleX]] ''returns the horizontal scale of the sprite''<br/><!--GIDEROSMTD:Sprite:getScaleX() returns the horizontal scale of the sprite-->
[[Sprite:getWidth]] - returns the width<br/>
+
[[Sprite:getScaleY]] ''returns the vertical scale of the sprite''<br/><!--GIDEROSMTD:Sprite:getScaleY() returns the vertical scale of the sprite-->
[[Sprite:getX]] - returns the x coordinate of the sprite<br/>
+
[[Sprite:getScaleZ]] ''returns the scale on z axis of the sprite''<br/><!--GIDEROSMTD:Sprite:getScaleZ() returns the scale on z axis of the sprite-->
[[Sprite:getY]] - returns the y coordinate of the sprite<br/>
+
[[Sprite:getSkew]] returns the x and y skew parameters of the Sprite<br/><!--GIDEROSMTD:Sprite:getSkew() returns the x and y skew parameters of the Sprite-->
[[Sprite:getZ]] - returns the z coordinate of the sprite<br/>
+
[[Sprite:getSkewX]] returns the x skew parameters of the Sprite<br/><!--GIDEROSMTD:Sprite:getSkewX() returns the x skew parameters of the Sprite-->
[[Sprite:globalToLocal]] - converts the x,y coordinates from the global to the sprite's (local) coordinates<br/>
+
[[Sprite:getSkewY]] returns the y skew parameters of the Sprite<br/><!--GIDEROSMTD:Sprite:getSkewY() returns the y skew parameters of the Sprite-->
[[Sprite:hitTestPoint]] - checks the given coordinates is in bounds of the sprite<br/>
+
[[Sprite:getWidth]] ''returns the width''<br/><!--GIDEROSMTD:Sprite:getWidth(withoutTransform) returns the width-->
[[Sprite:isVisible]] - returns the visibility of sprite<br/>
+
[[Sprite:getX]] ''returns the x coordinate of the sprite''<br/><!--GIDEROSMTD:Sprite:getX() returns the x coordinate of the sprite-->
[[Sprite:localToGlobal]] - converts the x,y coordinates from the sprite's (local) coordinates to the global coordinates<br/>
+
[[Sprite:getY]] ''returns the y coordinate of the sprite''<br/><!--GIDEROSMTD:Sprite:getY() returns the y coordinate of the sprite-->
[[Sprite:removeChild]] - removes the child sprite<br/>
+
[[Sprite:getZ]] ''returns the z coordinate of the sprite''<br/><!--GIDEROSMTD:Sprite:getZ() returns the z coordinate of the sprite-->
[[Sprite:removeChildAt]] - removes the child sprite at the specifed index<br/>
+
[[Sprite:globalToLocal]] ''converts the x,y coordinates from the global to the sprite (local) coordinates''<br/><!--GIDEROSMTD:Sprite:globalToLocal(x,y) converts the x,y coordinates from the global to the sprite (local) coordinates-->
[[Sprite:removeFromParent]] - if the sprite has a parent, removes the sprite from the child list of its parent sprite.<br/>
+
[[Sprite:hitTestPoint]] ''checks the given coordinates is in bounds of the sprite''<br/><!--GIDEROSMTD:Sprite:hitTestPoint(x,y,shapeFlag) checks the given coordinates is in bounds of the sprite-->
[[Sprite:set]] - sets the specified property by its name<br/>
+
[[Sprite:isVisible]] ''returns the visibility of sprite''<br/><!--GIDEROSMTD:Sprite:isVisible() returns the visibility of sprite-->
[[Sprite:setAlpha]] - sets the alpha transparency of this sprite<br/>
+
[[Sprite:localToGlobal]] ''converts the x,y coordinates from the sprite (local) coordinates to the global coordinates''<br/><!--GIDEROSMTD:Sprite:localToGlobal(x,y) converts the x,y coordinates from the sprite (local) coordinates to the global coordinates-->
[[Sprite:setAnchorPosition]] - Set anchor position<br/>
+
[[Sprite:redrawEffects]] ''tells Gideros the effects must be recomputed''<br/><!--GIDEROSMTD:Sprite:redrawEffects() tells Gideros the effects must be recomputed-->
[[Sprite:setBlendMode]] - sets the blend mode of the sprite<br/>
+
[[Sprite:removeChild]] ''removes the child sprite''<br/><!--GIDEROSMTD:Sprite:removeChild(child) removes the child sprite-->
[[Sprite:setClip]] - Clip Sprite contents<br/>
+
[[Sprite:removeChildAt]] ''removes the child sprite at the specifed index''<br/><!--GIDEROSMTD:Sprite:removeChildAt(index) removes the child sprite at the specifed index-->
[[Sprite:setColorTransform]] - sets the red, green, blue and alpha channel multipliers<br/>
+
[[Sprite:removeFromParent]] ''if the sprite has a parent, removes the sprite from the child list of its parent sprite''<br/><!--GIDEROSMTD:Sprite:removeFromParent() if the sprite has a parent, removes the sprite from the child list of its parent sprite-->
[[Sprite:setMatrix]] - sets the transformation matrix of the sprite<br/>
+
[[Sprite:set]] ''sets the specified property by its name''<br/><!--GIDEROSMTD:Sprite:set(param,value) sets the specified property by its name-->
[[Sprite:setPosition]] - sets the x,y and z coordinates of the sprite<br/>
+
[[Sprite:setAlpha]] ''sets the alpha transparency of this sprite''<br/><!--GIDEROSMTD:Sprite:setAlpha(alpha) sets the alpha transparency of this sprite-->
[[Sprite:setRotation]] - sets the rotation of the sprite in degrees<br/>
+
[[Sprite:setAnchorPosition]] ''sets anchor position''<br/><!--GIDEROSMTD:Sprite:setAnchorPosition(anchorX,anchorY,anchorZ) sets anchor position-->
[[Sprite:setRotationX]] - sets the rotation of the sprite in degrees around x axis<br/>
+
[[Sprite:setBlendMode]] ''sets the blend mode of the sprite''<br/><!--GIDEROSMTD:Sprite:setBlendMode(blendMode or src,dst) sets the blend mode of the sprite-->
[[Sprite:setRotationY]] - sets the rotation of the sprite in degrees around y axis<br/>
+
[[Sprite:setClip]] ''clips Sprite contents''<br/><!--GIDEROSMTD:Sprite:setClip(x,y,width,height) clips Sprite contents-->
[[Sprite:setScale]] - sets the horizontal, vertical and z axis scales of the sprite<br/>
+
[[Sprite:setColorTransform]] ''sets the red, green, blue and alpha channel multipliers''<br/><!--GIDEROSMTD:Sprite:setColorTransform(redMultiplier,greenMultiplier,blueMultiplier,alphaMultiplier) sets the red, green, blue and alpha channel multipliers-->
[[Sprite:setScaleX]] - sets the horizontal scale of the sprite<br/>
+
[[Sprite:setEffectConstant]] ''changes the value of a constant in the effect stack''<br/><!--GIDEROSMTD:Sprite:setEffectConstant(effectIndex,uniform name,data type,mult,data,program,variant) changes the value of a constant in the effect stack-->
[[Sprite:setScaleY]] - sets the vertical scale of the sprite<br/>
+
[[Sprite:setEffectStack]] ''associates an effect stack to this sprite''<br/><!--GIDEROSMTD:Sprite:setEffectStack(effectStack,mode) associates an effect stack to this sprite-->
[[Sprite:setScaleZ]] - Set scale on z axis<br/>
+
[[Sprite:setLayoutConstraints]] ''specifies the child placement constraints for Gideros layout system''<br/><!--GIDEROSMTD:Sprite:setLayoutConstraints(constraints) specifies the child placement constraints for Gideros layout system-->
[[Sprite:setShader]] - Set shader for this sprite<br/>
+
[[Sprite:setLayoutParameters]] ''specifies the parent parameters for Gideros layout system''<br/><!--GIDEROSMTD:Sprite:setLayoutParameters(layout) specifies the parent parameters for Gideros layout system-->
[[Sprite:setShaderConstant]] - Change the value of a uniform for this sprite<br/>
+
[[Sprite:setMatrix]] ''sets the transformation matrix of the sprite''<br/><!--GIDEROSMTD:Sprite:setMatrix(matrix) sets the transformation matrix of the sprite-->
[[Sprite:setSkew]] - <br/>
+
[[Sprite:setPosition]] ''sets the x,y and z coordinates of the sprite''<br/><!--GIDEROSMTD:Sprite:setPosition(x,y,z) sets the x,y and z coordinates of the sprite-->
[[Sprite:setSkewX]] - <br/>
+
[[Sprite:setRotation]] ''sets the rotation of the sprite in degrees''<br/><!--GIDEROSMTD:Sprite:setRotation(rotation) sets the rotation of the sprite in degrees-->
[[Sprite:setSkewY]] - <br/>
+
[[Sprite:setRotationX]] ''sets the rotation of the sprite in degrees around x axis''<br/><!--GIDEROSMTD:Sprite:setRotationX() sets the rotation of the sprite in degrees around x axis-->
[[Sprite:setStencilOperation]] - Set the stencil operation for this sprite<br/>
+
[[Sprite:setRotationY]] ''sets the rotation of the sprite in degrees around y axis''<br/><!--GIDEROSMTD:Sprite:setRotationY() sets the rotation of the sprite in degrees around y axis-->
[[Sprite:setVisible]] - sets the visibility of sprite<br/>
+
[[Sprite:setScale]] ''sets the horizontal, vertical and z axis scales of the sprite''<br/><!--GIDEROSMTD:Sprite:setScale(scaleX,scaleY,scaleZ) sets the horizontal, vertical and z axis scales of the sprite-->
[[Sprite:setX]] - sets the x coordinate of the sprite<br/>
+
[[Sprite:setScaleX]] ''sets the horizontal scale of the sprite''<br/><!--GIDEROSMTD:Sprite:setScaleX(scaleX) sets the horizontal scale of the sprite-->
[[Sprite:setY]] - sets the y coordinate of the sprite<br/>
+
[[Sprite:setScaleY]] ''sets the vertical scale of the sprite''<br/><!--GIDEROSMTD:Sprite:setScaleY(scaleY) sets the vertical scale of the sprite-->
[[Sprite:setZ]] - sets the z coordinate of the sprite<br/>
+
[[Sprite:setScaleZ]] ''sets scale on z axis''<br/><!--GIDEROSMTD:Sprite:setScaleZ(scale) sets scale on z axis-->
[[Sprite:swapChildren]] - Swap two children index places<br/>
+
[[Sprite:setShader]] ''sets shader for this sprite''<br/><!--GIDEROSMTD:Sprite:setShader(shader,programType,programVariant,inherit) sets shader for this sprite-->
[[Sprite:swapChildrenAt]] - Swaps two child sprites.<br/>
+
[[Sprite:setShaderConstant]] ''changes the value of a uniform for this sprite''<br/><!--GIDEROSMTD:Sprite:setShaderConstant(uniform name,data type,mult,data,program,variant) changes the value of a uniform for this sprite-->
| style="width: 50%;"|
+
[[Sprite:setSkew]] sets the skew (ie shear) of the Sprite<br/><!--GIDEROSMTD:Sprite:setSkew(kx,ky) sets the skew (ie shear) of the Sprite-->
 +
[[Sprite:setSkewX]] sets the Sprite x skew<br/><!--GIDEROSMTD:Sprite:setSkewX(kx) sets the Sprite x skew-->
 +
[[Sprite:setSkewY]] sets the Sprite y skew<br/><!--GIDEROSMTD:Sprite:setSkewY(ky) sets the Sprite y skew-->
 +
[[Sprite:setStencilOperation]] ''sets the stencil operation for this sprite''<br/><!--GIDEROSMTD:Sprite:setStencilOperation(mask) sets the stencil operation for this sprite-->
 +
[[Sprite:setStopEventPropagation]] ''selects which events must not be propagated to parent sprite''<br/><!--GIDEROSMTD:Sprite:setStopEventPropagation(mask) selects which events must not be propagated to parent sprite-->
 +
[[Sprite:setVisible]] ''sets the visibility of sprite''<br/><!--GIDEROSMTD:Sprite:setVisible(visible) sets the visibility of sprite-->
 +
[[Sprite:setX]] ''sets the x coordinate of the sprite''<br/><!--GIDEROSMTD:Sprite:setX(x) sets the x coordinate of the sprite-->
 +
[[Sprite:setY]] ''sets the y coordinate of the sprite''<br/><!--GIDEROSMTD:Sprite:setY(y) sets the y coordinate of the sprite-->
 +
[[Sprite:setZ]] ''sets the z coordinate of the sprite''<br/><!--GIDEROSMTD:Sprite:setZ(z) sets the z coordinate of the sprite-->
 +
[[Sprite:swapChildren]] ''swaps two children index places''<br/><!--GIDEROSMTD:Sprite:swapChildren(child1,child2) swaps two children index places-->
 +
[[Sprite:swapChildrenAt]] ''swaps two child sprites''<br/><!--GIDEROSMTD:Sprite:swapChildrenAt(index1,index2) swaps two child sprites-->
 +
 
 +
| style="width: 50%; vertical-align:top;"|
 +
 
 
=== Events ===
 
=== Events ===
[[Event.ADDED_TO_STAGE]]<br/>
+
[[Event.ADDED_TO_STAGE]]<br/><!--GIDEROSEVT:Event.ADDED_TO_STAGE addedToStage-->
[[Event.ENTER_FRAME]]<br/>
+
[[Event.ENTER_FRAME]]<br/><!--GIDEROSEVT:Event.ENTER_FRAME enterFrame-->
[[Event.KEY_DOWN]]<br/>
+
[[Event.KEY_DOWN]]<br/><!--GIDEROSEVT:Event.KEY_DOWN keyDown-->
[[Event.KEY_UP]]<br/>
+
[[Event.KEY_UP]]<br/><!--GIDEROSEVT:Event.KEY_UP keyUp-->
[[Event.LAYOUT_RESIZED]]<br/>
+
[[Event.LAYOUT_RESIZED]]<br/><!--GIDEROSEVT:Event.LAYOUT_RESIZED layout_resized-->
[[Event.MOUSE_DOWN]]<br/>
+
[[Event.MOUSE_DOWN]]<br/><!--GIDEROSEVT:Event.MOUSE_DOWN mouseDown-->
[[Event.MOUSE_HOVER]]<br/>
+
[[Event.MOUSE_HOVER]]<br/><!--GIDEROSEVT:Event.MOUSE_HOVER mouseHover-->
[[Event.MOUSE_MOVE]]<br/>
+
[[Event.MOUSE_MOVE]]<br/><!--GIDEROSEVT:Event.MOUSE_MOVE mouseMove-->
[[Event.MOUSE_UP]]<br/>
+
[[Event.MOUSE_UP]]<br/><!--GIDEROSEVT:Event.MOUSE_UP mouseUp-->
[[Event.MOUSE_WHEEL]]<br/>
+
[[Event.MOUSE_WHEEL]]<br/><!--GIDEROSEVT:Event.MOUSE_WHEEL mouseWheel-->
[[Event.REMOVED_FROM_STAGE]]<br/>
+
[[Event.REMOVED_FROM_STAGE]]<br/><!--GIDEROSEVT:Event.REMOVED_FROM_STAGE removedFromStage-->
[[Event.TOUCHES_BEGIN]]<br/>
+
[[Event.TOUCHES_BEGIN]]<br/><!--GIDEROSEVT:Event.TOUCHES_BEGIN touchesBegin-->
[[Event.TOUCHES_CANCEL]]<br/>
+
[[Event.TOUCHES_CANCEL]]<br/><!--GIDEROSEVT:Event.TOUCHES_CANCEL touchesCancel-->
[[Event.TOUCHES_END]]<br/>
+
[[Event.TOUCHES_END]]<br/><!--GIDEROSEVT:Event.TOUCHES_END touchesEnd-->
[[Event.TOUCHES_MOVE]]<br/>
+
[[Event.TOUCHES_MOVE]]<br/><!--GIDEROSEVT:Event.TOUCHES_MOVE touchesMove-->
 
=== Constants ===
 
=== Constants ===
[[Sprite.ADD]]<br/>
+
[[Sprite.ADD]]<br/><!--GIDEROSCST:Sprite.ADD add-->
[[Sprite.ALPHA]]<br/>
+
[[Sprite.ALPHA]]<br/><!--GIDEROSCST:Sprite.ALPHA alpha-->
[[Sprite.MULTIPLY]]<br/>
+
[[Sprite.EFFECT_MODE_AUTOMATIC]] ''Not yet implemented''<br/><!--GIDEROSCST:Sprite.EFFECT_MODE_AUTOMATIC 1-->
[[Sprite.NO_ALPHA]]<br/>
+
[[Sprite.EFFECT_MODE_CONTINUOUS]] ''Always update the effects, this is the default''<br/><!--GIDEROSCST:Sprite.EFFECT_MODE_CONTINUOUS 0-->
[[Sprite.SCREEN]]<br/>
+
[[Sprite.EFFECT_MODE_TRIGGERED]] ''Update effects on demand''<br/><!--GIDEROSCST:Sprite.EFFECT_MODE_TRIGGERED 2-->
 +
[[Sprite.LAYOUT_ANCHOR_CENTER]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_CENTER 0-->
 +
[[Sprite.LAYOUT_ANCHOR_EAST]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_EAST 3-->
 +
[[Sprite.LAYOUT_ANCHOR_NORTH]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_NORTH 1-->
 +
[[Sprite.LAYOUT_ANCHOR_NORTHEAST]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_NORTHEAST 2-->
 +
[[Sprite.LAYOUT_ANCHOR_NORTHWEST]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_NORTHWEST 8-->
 +
[[Sprite.LAYOUT_ANCHOR_SOUTH]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_SOUTH 5-->
 +
[[Sprite.LAYOUT_ANCHOR_SOUTHEAST]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_SOUTHEAST 4-->
 +
[[Sprite.LAYOUT_ANCHOR_SOUTHWEST]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_SOUTHWEST 6-->
 +
[[Sprite.LAYOUT_ANCHOR_WEST]]<br/><!--GIDEROSCST:Sprite.LAYOUT_ANCHOR_WEST 7-->
 +
[[Sprite.LAYOUT_FILL_BOTH]]<br/><!--GIDEROSCST:Sprite.LAYOUT_FILL_BOTH 1-->
 +
[[Sprite.LAYOUT_FILL_HORIZONTAL]]<br/><!--GIDEROSCST:Sprite.LAYOUT_FILL_HORIZONTAL 2-->
 +
[[Sprite.LAYOUT_FILL_NONE]]<br/><!--GIDEROSCST:Sprite.LAYOUT_FILL_NONE 0-->
 +
[[Sprite.LAYOUT_FILL_VERTICAL]]<br/><!--GIDEROSCST:Sprite.LAYOUT_FILL_VERTICAL 3-->
 +
[[Sprite.MULTIPLY]]<br/><!--GIDEROSCST:Sprite.MULTIPLY multiply-->
 +
[[Sprite.NO_ALPHA]]<br/><!--GIDEROSCST:Sprite.NO_ALPHA noAlpha-->
 +
[[Sprite.SCREEN]]<br/><!--GIDEROSCST:Sprite.SCREEN screen-->
 
|}
 
|}
 +
 +
{{GIDEROS IMPORTANT LINKS}}

Revision as of 07:50, 23 January 2021

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2011.6
Inherits from: EventDispatcher

Description

The Sprite class is the base class for all objects that can be placed on the scene tree. It is the basic scene tree building block.

A sprite can contain child sprites which makes the scene tree hierarchy. Transformations such as translation, rotation, scaling, and color transforms, propagate its effect to all of its children.

The drawing order is defined by the order of children. The first child is drawn first and the last child is drawn last. It is possible to change the drawing order by modifying the order of child list.

A Sprite instance can exist without attaching the scene tree.

An unattached sprite can receive Event.ENTER_FRAME event but it will only receive mouse and touch events when it is attached to the scene tree.

Methods

Sprite.new creates a new Sprite object
Sprite:addChild adds a sprite as a child
Sprite:addChildAt adds a sprite as a child at the index position specified
Sprite:clearBlendMode clears the blending mode
Sprite:contains determines whether the specified sprite is contained in the subtree of this sprite
Sprite:get gets the specified property by its name
Sprite:getAlpha returns the alpha transparency of this sprite
Sprite:getAnchorPosition returns anchor position of Sprite
Sprite:getBounds returns the bounds as it appears in another sprite coordinate system
Sprite:getChildAt returns the child sprite that exists at the specified index
Sprite:getChildIndex returns the index of the specified child sprite
Sprite:getChildrenAtPoint returns the children sprites that corresponds to the given screen coordinates
Sprite:getClip returns the coordinates of the Sprite clip range if set with setClip
Sprite:getColorTransform returns the red, green, blue and alpha channel multipliers
Sprite:getDrawCount returns the number of Sprites actually drawn each frame on this subtree
Sprite:getHeight returns the height
Sprite:getLayoutConstraints gets the current layout constraints
Sprite:getLayoutInfo gets information of the current layout
Sprite:getLayoutParameters gets the current layout parameters
Sprite:getMatrix returns the transformation matrix of the sprite
Sprite:getNumChildren returns the number of children of this sprite
Sprite:getParent returns the parent sprite
Sprite:getPosition gets the x,y and z coordinates of the sprite
Sprite:getRotation returns the rotation of the sprite in degrees
Sprite:getRotationX returns the rotation of the sprite around x axis in degrees
Sprite:getRotationY returns the rotation of the sprite around y axis in degrees
Sprite:getScale returns the horizontal, vertical and z scales of the sprite
Sprite:getScaleX returns the horizontal scale of the sprite
Sprite:getScaleY returns the vertical scale of the sprite
Sprite:getScaleZ returns the scale on z axis of the sprite
Sprite:getSkew returns the x and y skew parameters of the Sprite
Sprite:getSkewX returns the x skew parameters of the Sprite
Sprite:getSkewY returns the y skew parameters of the Sprite
Sprite:getWidth returns the width
Sprite:getX returns the x coordinate of the sprite
Sprite:getY returns the y coordinate of the sprite
Sprite:getZ returns the z coordinate of the sprite
Sprite:globalToLocal converts the x,y coordinates from the global to the sprite (local) coordinates
Sprite:hitTestPoint checks the given coordinates is in bounds of the sprite
Sprite:isVisible returns the visibility of sprite
Sprite:localToGlobal converts the x,y coordinates from the sprite (local) coordinates to the global coordinates
Sprite:redrawEffects tells Gideros the effects must be recomputed
Sprite:removeChild removes the child sprite
Sprite:removeChildAt removes the child sprite at the specifed index
Sprite:removeFromParent if the sprite has a parent, removes the sprite from the child list of its parent sprite
Sprite:set sets the specified property by its name
Sprite:setAlpha sets the alpha transparency of this sprite
Sprite:setAnchorPosition sets anchor position
Sprite:setBlendMode sets the blend mode of the sprite
Sprite:setClip clips Sprite contents
Sprite:setColorTransform sets the red, green, blue and alpha channel multipliers
Sprite:setEffectConstant changes the value of a constant in the effect stack
Sprite:setEffectStack associates an effect stack to this sprite
Sprite:setLayoutConstraints specifies the child placement constraints for Gideros layout system
Sprite:setLayoutParameters specifies the parent parameters for Gideros layout system
Sprite:setMatrix sets the transformation matrix of the sprite
Sprite:setPosition sets the x,y and z coordinates of the sprite
Sprite:setRotation sets the rotation of the sprite in degrees
Sprite:setRotationX sets the rotation of the sprite in degrees around x axis
Sprite:setRotationY sets the rotation of the sprite in degrees around y axis
Sprite:setScale sets the horizontal, vertical and z axis scales of the sprite
Sprite:setScaleX sets the horizontal scale of the sprite
Sprite:setScaleY sets the vertical scale of the sprite
Sprite:setScaleZ sets scale on z axis
Sprite:setShader sets shader for this sprite
Sprite:setShaderConstant changes the value of a uniform for this sprite
Sprite:setSkew sets the skew (ie shear) of the Sprite
Sprite:setSkewX sets the Sprite x skew
Sprite:setSkewY sets the Sprite y skew
Sprite:setStencilOperation sets the stencil operation for this sprite
Sprite:setStopEventPropagation selects which events must not be propagated to parent sprite
Sprite:setVisible sets the visibility of sprite
Sprite:setX sets the x coordinate of the sprite
Sprite:setY sets the y coordinate of the sprite
Sprite:setZ sets the z coordinate of the sprite
Sprite:swapChildren swaps two children index places
Sprite:swapChildrenAt swaps two child sprites

Events

Event.ADDED_TO_STAGE
Event.ENTER_FRAME
Event.KEY_DOWN
Event.KEY_UP
Event.LAYOUT_RESIZED
Event.MOUSE_DOWN
Event.MOUSE_HOVER
Event.MOUSE_MOVE
Event.MOUSE_UP
Event.MOUSE_WHEEL
Event.REMOVED_FROM_STAGE
Event.TOUCHES_BEGIN
Event.TOUCHES_CANCEL
Event.TOUCHES_END
Event.TOUCHES_MOVE

Constants

Sprite.ADD
Sprite.ALPHA
Sprite.EFFECT_MODE_AUTOMATIC Not yet implemented
Sprite.EFFECT_MODE_CONTINUOUS Always update the effects, this is the default
Sprite.EFFECT_MODE_TRIGGERED Update effects on demand
Sprite.LAYOUT_ANCHOR_CENTER
Sprite.LAYOUT_ANCHOR_EAST
Sprite.LAYOUT_ANCHOR_NORTH
Sprite.LAYOUT_ANCHOR_NORTHEAST
Sprite.LAYOUT_ANCHOR_NORTHWEST
Sprite.LAYOUT_ANCHOR_SOUTH
Sprite.LAYOUT_ANCHOR_SOUTHEAST
Sprite.LAYOUT_ANCHOR_SOUTHWEST
Sprite.LAYOUT_ANCHOR_WEST
Sprite.LAYOUT_FILL_BOTH
Sprite.LAYOUT_FILL_HORIZONTAL
Sprite.LAYOUT_FILL_NONE
Sprite.LAYOUT_FILL_VERTICAL
Sprite.MULTIPLY
Sprite.NO_ALPHA
Sprite.SCREEN