g4p_controls

Class GIcon

java.lang.Object

g4p_controls.GIcon

Direct Known Subclasses:

GAnimIcon

public class GIcon
extends java.lang.Object

Class for the creation of non-animated icons to be used with GButton, GLabel, GCheckbox and GOption controls.
Introduced in v4.1

Author:

Peter Lager

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
GIcon	copy() Returns a copy of this icon to be used with another control.
processing.core.PImage	getFrame() Get the image for the current frame to be displayed.
processing.core.PImage	getFrame(int fn) Get the image to be displayed for the specified frame number.

Methods inherited from class java.lang.Object

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

Constructor Detail

GIcon

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

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

GIcon

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

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

Method Detail

copy

public GIcon copy()

Returns a copy of this icon to be used with another control.

getFrame

public processing.core.PImage getFrame(int fn)

Get the image to be displayed for the specified frame number. The supplied frame number will be constrained to a valid value.

Parameters:

fn - the frame image to retrieve.

getFrame

public processing.core.PImage getFrame()

Get the image for the current frame to be displayed.