CPAnimationSprite

class CPAnimationSprite(id: String, anis: Seq[CPAnimation], x: Int, y: Int, z: Int, initAniId: String, collidable: Boolean, shaders: Seq[CPShader], tags: String*) extends CPSceneObject

A scene objet tailor-made for showing animations based on CPAnimation.

This sprite allows to implement a visual scene object that has one or more animations associated with it. These animations can be controlled either by the sprite itself or from the outside. This class provides necessary implementation for update and render methods. Make sure to call super if overriding any of these methods.

There are additional methods that allow access to and the control of the animation in the sprite:

Typically, to create a moving sprite, one would override this class and implement movement logic in overridden update method (making sure to call super), as well as overriding getX, getY and getDim methods to return current coordinates and dimension. Note that in most cases, one do need to override or change render method.

Value parameters:
anis

Sequence of animation. Must have at least one animation in it.

collidable

Whether or not this sprite is collidable.

id

Optional ID of the sprite.

initAniId

ID of the initial animation to play. This animation starts to play immediately.

shaders

Optional sequence of shaders for this sprite. Default value is an empty list.

tags

Optional set of organizational or grouping tags. By default, the empty set is used.

x

Initial X-coordinate.

y

Initial Y-coordinate.

z

Initial Z-index.

See also:
Example:

See CPAnimationExample source code for an example of animation functionality.

Source:
CPAnimationSprite.scala
class Object
trait Matchable
class Any

Value members

Concrete methods

def change(id: String, reset: Boolean, finish: Boolean): Unit

Changes the currently playing animation.

Changes the currently playing animation.

Value parameters:
finish

Whether or not to finish the current animation before changing to the given one. If false current animation will stop immediately and the next frame will play the new animation. The default value is true.

id

ID of the new animation to change to. Note that this animation should have been passed into the constructor of this sprite.

reset

Whether or not to reset() the animation before it is played. Default value is true.

Source:
CPAnimationSprite.scala
def contains(id: String): Boolean

Checks whether this sprite contains given animation.

Checks whether this sprite contains given animation.

Value parameters:
id

ID of the animation to check.

Source:
CPAnimationSprite.scala

Gets sequence of animation for this sprite.

Gets sequence of animation for this sprite.

Source:
CPAnimationSprite.scala
override def getCollisionRect: Option[CPRect]

Gets optional collision shape or hit box for this sprite.

Gets optional collision shape or hit box for this sprite.

Definition Classes
Source:
CPAnimationSprite.scala

Gets currently running animation. Note that animation sprite always has a running animation.

Gets currently running animation. Note that animation sprite always has a running animation.

Source:
CPAnimationSprite.scala
override def getDim: CPDim

Gets current dimension (width and height) of this object.

Gets current dimension (width and height) of this object.

Definition Classes
Source:
CPAnimationSprite.scala
override def getShaders: Seq[CPShader]

Gets the optional list of shaders attached to this scene object. By default, returns an empty list. Note that shaders are called regardless of whether the object visible, in camera frame or invisible.

Gets the optional list of shaders attached to this scene object. By default, returns an empty list. Note that shaders are called regardless of whether the object visible, in camera frame or invisible.

Definition Classes
Source:
CPAnimationSprite.scala
override def getX: Int

Gets current X-coordinate of this object within dimensions of its scene. Note that returned value is allowed to be outside scene's dimension (e.g. negative value). In such cases, the clipping of the scene rendering will result in showing only portion or none of the object.

Gets current X-coordinate of this object within dimensions of its scene. Note that returned value is allowed to be outside scene's dimension (e.g. negative value). In such cases, the clipping of the scene rendering will result in showing only portion or none of the object.

Definition Classes
Source:
CPAnimationSprite.scala
override def getY: Int

Gets current Y-coordinate of this object within dimensions of its scene. Note that returned value is allowed to be outside scene's dimension (e.g. negative value). In such cases, the clipping of the scene rendering will result in showing only portion or none of the object.

Gets current Y-coordinate of this object within dimensions of its scene. Note that returned value is allowed to be outside scene's dimension (e.g. negative value). In such cases, the clipping of the scene rendering will result in showing only portion or none of the object.

Definition Classes
Source:
CPAnimationSprite.scala
override def getZ: Int

Gets Z-index or order to use in rendering of this object. A pixel with higher Z-index visually overrides the overlapping pixel in the same XY-coordinate with equal or smaller Z-index.

Gets Z-index or order to use in rendering of this object. A pixel with higher Z-index visually overrides the overlapping pixel in the same XY-coordinate with equal or smaller Z-index.

Definition Classes
Source:
CPAnimationSprite.scala
override def render(ctx: CPSceneObjectContext): Unit

Called to render this scene object. Only visible and in camera frame objects will receive this callback. This callback is called on scene object after all scene objects received update callback. Note that unlike update callbacks and shaders that are called for all scene objects on each frame, this callback is only called for scene objects that are visible and, at least partially, in camera frame.

Called to render this scene object. Only visible and in camera frame objects will receive this callback. This callback is called on scene object after all scene objects received update callback. Note that unlike update callbacks and shaders that are called for all scene objects on each frame, this callback is only called for scene objects that are visible and, at least partially, in camera frame.

Definition Classes
Source:
CPAnimationSprite.scala
def resetAni(): Unit

Resets current animation by calling its CPAnimation.reset method.

Resets current animation by calling its CPAnimation.reset method.

Source:
CPAnimationSprite.scala
def resetXyz(): Unit

Resets this sprite to its initial XYZ-coordinates.

Resets this sprite to its initial XYZ-coordinates.

Source:
CPAnimationSprite.scala
def rewind(reset: Boolean, finish: Boolean): Unit

Rewinds this sprite by changing to initial animation.

Rewinds this sprite by changing to initial animation.

Value parameters:
finish

Whether or not to finish the current animation before changing to the initial one. If false current animation will stop immediately and the next frame will play the initial animation. The default value is true.

reset

Whether or not to reset the initial animation. Default value is true.

Source:
CPAnimationSprite.scala
def setOnKeyFrameChange(id: String, f: Option[(CPAnimation, CPSceneObjectContext) => Unit]): Unit

Sets or removes the callback on key frame change.

Sets or removes the callback on key frame change.

Value parameters:
f

Key frame change callback function that takes CPAnimation and CPSceneObjectContext as its parameters. Use None to remove previously set callback.

id

ID of animation.

Source:
CPAnimationSprite.scala
def setX(d: Int): Unit

Sets current X-coordinate. This coordinate will be returned from getX method.

Sets current X-coordinate. This coordinate will be returned from getX method.

Value parameters:
d

X-coordinate to set.

Source:
CPAnimationSprite.scala
def setXY(a: Int, b: Int): Unit

Sets both current XY-coordinates.

Sets both current XY-coordinates.

Value parameters:
a

X-coordinate to set.

b

Y-coordinate to set.

Source:
CPAnimationSprite.scala
def setY(d: Int): Unit

Sets current Y-coordinate. This coordinate will be returned from getY method.

Sets current Y-coordinate. This coordinate will be returned from getY method.

Value parameters:
d

Y-coordinate to set.

Source:
CPAnimationSprite.scala
def setZ(d: Int): Unit

Sets current Z-index. This index will be returned from getZ method.

Sets current Z-index. This index will be returned from getZ method.

Value parameters:
d

Z-index to set.

Source:
CPAnimationSprite.scala
def splice(id: String, reset: Boolean, finish: Boolean): Unit

Splices in given animation. Current animation will be stopped, put on hold and the spliced in animation will play. After it is finished the algorithm will revert back to the stored animation.

Splices in given animation. Current animation will be stopped, put on hold and the spliced in animation will play. After it is finished the algorithm will revert back to the stored animation.

Value parameters:
finish

Whether or not to finish the current animation before the spliced in one starts. If false current animation will stop immediately and the next frame will play the spliced in animation. The default value is true.

id

ID of the animation to splice in. Note that this animation should have been passed into the constructor of this sprite.

reset

Whether or not to reset() spliced in animation before it is played. Default value is true.

Source:
CPAnimationSprite.scala
override def update(ctx: CPSceneObjectContext): Unit

Called to update the internal state of this scene object. This callback is called each frame on every object in the scene and it is called before any render callback. Note that all scene object will receive this callback before first render callback.

Called to update the internal state of this scene object. This callback is called each frame on every object in the scene and it is called before any render callback. Note that all scene object will receive this callback before first render callback.

Definition Classes
Source:
CPAnimationSprite.scala

Inherited methods

override def equals(obj: Any): Boolean
Definition Classes
Inherited from:
CPGameObject
Source:
CPGameObject.scala
inline def getHeight: Int

Gets current height of this object.

Gets current height of this object.

See also:
Inherited from:
CPSceneObject
Source:
CPSceneObject.scala
def getId: String

Gets unique ID of this game object.

Gets unique ID of this game object.

Inherited from:
CPGameObject
Source:
CPGameObject.scala

Gets rectangular shape of this sprite. It is basically a combination of its top-left corner XY-coordinate and sprite's dimension.

Gets rectangular shape of this sprite. It is basically a combination of its top-left corner XY-coordinate and sprite's dimension.

See also:
Inherited from:
CPSceneObject
Source:
CPSceneObject.scala
final def getState: State

Gets current lifecycle state.

Gets current lifecycle state.

Inherited from:
CPLifecycle
Source:
CPLifecycle.scala
def getTags: Set[String]

Gets optional set of organizational tags. Note that by default the set of tags is empty.

Gets optional set of organizational tags. Note that by default the set of tags is empty.

See also:
Inherited from:
CPGameObject
Source:
CPGameObject.scala
inline def getWidth: Int

Gets current width of this object.

Gets current width of this object.

See also:
Inherited from:
CPSceneObject
Source:
CPSceneObject.scala
def hide(): Unit

Shortcut method for hiding this object. Note that by default all scene objects are visible.

Shortcut method for hiding this object. Note that by default all scene objects are visible.

See also:
Inherited from:
CPSceneObject
Source:
CPSceneObject.scala
def isVisible: Boolean

Checks the visibility flag.

Checks the visibility flag.

If object is invisible than only update method will be called on each frame. If object is visible and in camera frame - method render will be called as well to render itself. Note that shaders are called regardless of whether the object visible, in camera frame or invisible.

See also:
Inherited from:
CPSceneObject
Source:
CPSceneObject.scala
def onActivate(): Unit

Callback on lifecycle object activation. Default implementation is no-op.

Callback on lifecycle object activation. Default implementation is no-op.

See also:

CPLifecycle.State.LF_ACTIVE

Inherited from:
CPLifecycle
Source:
CPLifecycle.scala
def onDeactivate(): Unit

Callback on lifecycle object deactivation. Default implementation is no-op.

Callback on lifecycle object deactivation. Default implementation is no-op.

See also:

CPLifecycle.State.LF_INACTIVE

Inherited from:
CPLifecycle
Source:
CPLifecycle.scala
def onStart(): Unit

Callback on lifecycle object start. Default implementation is no-op.

Callback on lifecycle object start. Default implementation is no-op.

See also:

CPLifecycle.State.LF_STARTED

Inherited from:
CPLifecycle
Source:
CPLifecycle.scala
def onStop(): Unit

Callback on lifecycle object stop. Default implementation is no-op.

Callback on lifecycle object stop. Default implementation is no-op.

See also:

CPLifecycle.State.LF_STOPPED

Inherited from:
CPLifecycle
Source:
CPLifecycle.scala
def setVisible(vis: Boolean): Unit

Sets visibility flag. Note that by default all scene objects are visible.

Sets visibility flag. Note that by default all scene objects are visible.

Value parameters:
vis

true to make this object visible, false otherwise.

See also:
Inherited from:
CPSceneObject
Source:
CPSceneObject.scala
def show(): Unit

Shortcut method for showing this object. Note that by default all scene objects are visible.

Shortcut method for showing this object. Note that by default all scene objects are visible.

See also:
Inherited from:
CPSceneObject
Source:
CPSceneObject.scala

Concrete fields

final val initX: Int

Initial X-coordinate of the sprite.

Initial X-coordinate of the sprite.

See also:
Source:
CPAnimationSprite.scala
final val initY: Int

Initial Y-coordinate of the sprite.

Initial Y-coordinate of the sprite.

See also:
Source:
CPAnimationSprite.scala
final val initZ: Int

Initial Z-index of the sprite.

Initial Z-index of the sprite.

See also:
Source:
CPAnimationSprite.scala