g4p_controls

Class GAnimIcon

java.lang.Object

g4p_controls.GIcon

g4p_controls.GAnimIcon

public class GAnimIcon
extends GIcon

Class for the creation of animated icons to be used with GButton, GLabel, GCheckbox and GOption controls.
All animated icons will have an animation clip called 'ALL' which displays all the frames starting at zero with the user specified frame interval.
Introduced in v4.1

Author:

Peter Lager

Constructor Summary

Constructors

Constructor and Description
GAnimIcon(processing.core.PApplet papp, processing.core.PImage image, int nbrCols, int nbrRows, int interval) Create an animated icon
GAnimIcon(processing.core.PApplet papp, java.lang.String fname, int nbrCols, int nbrRows, int interval) Create an animated icon

Method Summary

Methods

Modifier and Type	Method and Description
void	advanceAnimationFrame(GTimer timer)
GAnimIcon	animate() Animate the entire sequence.
GAnimIcon	animate(java.lang.String id) Animate the icon using store clip details but use the specified frame interval instead of the stored value.
GAnimIcon	copy() Returns a copy of this animated icon to be used with another control.
GAnimIcon	setFrame(int fn) Set the current frame to be displayed.
GAnimIcon	setInterval(int interval) Change the interval between frames for the current animation clip.
GAnimIcon	setInterval(java.lang.String id, int interval) Change the interval between frames for the animation clip with specified id.
GAnimIcon	start() Resume an animation that has previously been stopped with stop()
GAnimIcon	stop() Stop the current animation.
GAnimIcon	storeAnim(java.lang.String id, int start, int end, int interval) Store details of an animation sequence for later use.
GAnimIcon	storeAnim(java.lang.String id, int start, int end, int interval, int nbrLoops) Store details of an animation sequence for later use.

Methods inherited from class g4p_controls.GIcon

getFrame, getFrame

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GAnimIcon

public GAnimIcon(processing.core.PApplet papp,
         java.lang.String fname,
         int nbrCols,
         int nbrRows,
         int interval)

Create an animated icon

Parameters:

papp - the PApplet object that will be used to display this icon

fname - the name of the file containing the tiled image.

nbrCols - number of horizontal tiles

nbrRows - number of vertical tiles

interval - the time between displaying frames in milliseconds

GAnimIcon

public GAnimIcon(processing.core.PApplet papp,
         processing.core.PImage image,
         int nbrCols,
         int nbrRows,
         int interval)

Create an animated icon

Parameters:

papp - the PApplet object that will be used to display this icon

image - the tiled image containing the frames

nbrCols - number of horizontal tiles

nbrRows - number of vertical tiles

interval - the time between displaying frames in milliseconds

Method Detail

copy

public GAnimIcon copy()

Returns a copy of this animated icon to be used with another control.
Note: animated icons must only be used with one second control. Use copy() to get a duplicate icon which can be used with another control.

Overrides:

copy in class GIcon

storeAnim

public GAnimIcon storeAnim(java.lang.String id,
                  int start,
                  int end,
                  int interval)

Store details of an animation sequence for later use.

Parameters:

id - unique id for this animation clip

start - first frame for this clip

end - last frame for this clip

interval - the time (ms) between frames

Returns:

storeAnim

public GAnimIcon storeAnim(java.lang.String id,
                  int start,
                  int end,
                  int interval,
                  int nbrLoops)

Store details of an animation sequence for later use.

Parameters:

id - unique id for this animation clip

start - first frame for this clip

end - last frame for this clip

interval - the time (ms) between frames

nbrLoops - the number of times this clip is played, (0 = play forever)

animate

public GAnimIcon animate()

Animate the entire sequence.

animate

public GAnimIcon animate(java.lang.String id)

Animate the icon using store clip details but use the specified frame interval instead of the stored value.
You can also decide on the number of times the clip is to be shown.

Parameters:

id - the unique id for the clip

frameInterval - the time between frames

nbrLoops - the number of times the clip is to be shown (<=0 will repeat the clip for ever).

setInterval

public GAnimIcon setInterval(int interval)

Change the interval between frames for the current animation clip.

Parameters:

interval - the time between frames in milliseconds

setInterval

public GAnimIcon setInterval(java.lang.String id,
                    int interval)

Change the interval between frames for the animation clip with specified id.

Parameters:

interval - the time between frames in milliseconds

start

public GAnimIcon start()

Resume an animation that has previously been stopped with stop()

stop

public GAnimIcon stop()

Stop the current animation. The animation can be resumed with start()

setFrame

public GAnimIcon setFrame(int fn)

Set the current frame to be displayed. The supplied frame number will be constrained to a valid value.
This is ignored if the animation clip is running.

Parameters:

fn - the frame number to display.

advanceAnimationFrame

public void advanceAnimationFrame(GTimer timer)