GTimer (Javadocs: G4P)

java.lang.Object
- g4p_controls.GTimer

```
public class GTimer
extends java.lang.Object
```
This class is used to trigger events at user defined intervals. The event will call a user defined method/function. The only restriction is that the method used has a single parameter of type GTimer and returns void eg
```
 void fireBall(GTimer timer){ ... }
 
```
Each timer object must have its own handler It has no visible GUI representation so will not appear in the GUI.
Author:

Peter Lager

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_METHOD`
`static int`	`CLIP_RUN`
`static int`	`COMBI_MODES`
`static java.lang.String`	`DEFAULT_SLIDER_STYLE`
`static int`	`DRAG_CONTROL`
`static int`	`DRAW_METHOD`
`static char`	`EOL`
`static int`	`EXCP_IN_HANDLER`
`static int[][]`	`grid`
`static int`	`GROUP_CONTROL_METHOD`
`static int`	`I_CL`
`static int`	`I_COVERED`
`static int`	`I_CR`
`static int`	`I_INSIDE`
`static int`	`I_MODES`
`static int`	`I_NONE`
`static int`	`I_TL`
`static int`	`I_TR`
`static int`	`INVALID_PAPPLET`
`static int`	`INVALID_TYPE`
`static int`	`KEY_METHOD`
`static int`	`MERGE_RUNS`
`static int`	`MISSING`
`static int`	`MOUSE_METHOD`
`static int`	`NONEXISTANT`
`static int`	`OFF_CONTROL`
`static int`	`OVER_CONTROL`
`static java.awt.BasicStroke`	`pen_1_0`
`static java.awt.BasicStroke`	`pen_2_0`
`static java.awt.BasicStroke`	`pen_3_0`
`static java.awt.BasicStroke`	`pen_4_0`
`static int`	`POST_METHOD`
`static int`	`PRE_METHOD`
`static int`	`PRESS_CONTROL`
`static int`	`SCROLLBAR_HORIZONTAL`
`static int`	`SCROLLBAR_VERTICAL`
`static java.lang.String`	`SLIDER_STYLES`
`static int`	`TINT_FOR_ALPHA`
`static int`	`TPAD2`
`static int`	`TPAD4`
`static int`	`TPAD6`
`static int`	`TPAD8`
`static float`	`WHEEL_DELTA`
`static float`	`WHEEL_STICK_FACTOR`
`static int`	`Z_PANEL`
`static int`	`Z_SLIPPY`
`static int`	`Z_SLIPPY_EXPANDS`
`static int`	`Z_STICKY`

Constructor Summary

Constructors
Constructor and Description
`GTimer(processing.core.PApplet theApplet, java.lang.Object obj, java.lang.String methodName, int delay)` Create the GTimer object with this ctor.
`GTimer(processing.core.PApplet theApplet, java.lang.Object obj, java.lang.String methodName, int delay, int initDelay)` Create the GTimer object with this ctor.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getInitialDelay()` Get the initial delay time (milliseconds).
`int`	`getInterval()` Get the interval time (milliseconds) between events.
`int`	`getNbrRepeats()` The number of times an event is to be fired.
`boolean`	`isRunning()` Is the timer running?
`boolean`	`isValid()` See if the GTimer object has been created successfully
`void`	`setDelay(int delay)` Sets the initial delay and the interval between events.
`void`	`setInitialDelay(int initDelay)` Set the delay before the first event is triggered
`void`	`setInterval(int interval)` Set the interval between events
`void`	`setNbrRepeats(int nbrRepeats)` The number of times an event is to be fired.
`void`	`start()` Start the timer (call the method forever)
`void`	`start(int nrepeats)` Start the timer and call the method for the number of times indicated by nrepeats If nrepeats is <=0 then repeat forever
`void`	`stop()` Stop the timer (can be restarted with start() method)

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SLIDER_STYLES
```
public static final java.lang.String SLIDER_STYLES
```
    See Also:
    Constant Field Values
  - DEFAULT_SLIDER_STYLE
```
public static final java.lang.String DEFAULT_SLIDER_STYLE
```
    See Also:
    Constant Field Values
  - DRAW_METHOD
```
public static final int DRAW_METHOD
```
    See Also:
    Constant Field Values
  - MOUSE_METHOD
```
public static final int MOUSE_METHOD
```
    See Also:
    Constant Field Values
  - PRE_METHOD
```
public static final int PRE_METHOD
```
    See Also:
    Constant Field Values
  - KEY_METHOD
```
public static final int KEY_METHOD
```
    See Also:
    Constant Field Values
  - POST_METHOD
```
public static final int POST_METHOD
```
    See Also:
    Constant Field Values
  - ALL_METHOD
```
public static final int ALL_METHOD
```
    See Also:
    Constant Field Values
  - GROUP_CONTROL_METHOD
```
public static final int GROUP_CONTROL_METHOD
```
    See Also:
    Constant Field Values
  - MISSING
```
public static final int MISSING
```
    See Also:
    Constant Field Values
  - NONEXISTANT
```
public static final int NONEXISTANT
```
    See Also:
    Constant Field Values
  - INVALID_TYPE
```
public static final int INVALID_TYPE
```
    See Also:
    Constant Field Values
  - INVALID_PAPPLET
```
public static final int INVALID_PAPPLET
```
    See Also:
    Constant Field Values
  - EXCP_IN_HANDLER
```
public static final int EXCP_IN_HANDLER
```
    See Also:
    Constant Field Values
  - OFF_CONTROL
```
public static final int OFF_CONTROL
```
    See Also:
    Constant Field Values
  - OVER_CONTROL
```
public static final int OVER_CONTROL
```
    See Also:
    Constant Field Values
  - PRESS_CONTROL
```
public static final int PRESS_CONTROL
```
    See Also:
    Constant Field Values
  - DRAG_CONTROL
```
public static final int DRAG_CONTROL
```
    See Also:
    Constant Field Values
  - TINT_FOR_ALPHA
```
public static final int TINT_FOR_ALPHA
```
    See Also:
    Constant Field Values
  - I_NONE
```
public static final int I_NONE
```
    See Also:
    Constant Field Values
  - I_TL
```
public static final int I_TL
```
    See Also:
    Constant Field Values
  - I_TR
```
public static final int I_TR
```
    See Also:
    Constant Field Values
  - I_CL
```
public static final int I_CL
```
    See Also:
    Constant Field Values
  - I_CR
```
public static final int I_CR
```
    See Also:
    Constant Field Values
  - I_INSIDE
```
public static final int I_INSIDE
```
    See Also:
    Constant Field Values
  - I_COVERED
```
public static final int I_COVERED
```
    See Also:
    Constant Field Values
  - I_MODES
```
public static final int I_MODES
```
    See Also:
    Constant Field Values
  - MERGE_RUNS
```
public static final int MERGE_RUNS
```
    See Also:
    Constant Field Values
  - CLIP_RUN
```
public static final int CLIP_RUN
```
    See Also:
    Constant Field Values
  - COMBI_MODES
```
public static final int COMBI_MODES
```
    See Also:
    Constant Field Values
  - grid
```
public static final int[][] grid
```
  - pen_1_0
```
public static final java.awt.BasicStroke pen_1_0
```
  - pen_2_0
```
public static final java.awt.BasicStroke pen_2_0
```
  - pen_3_0
```
public static final java.awt.BasicStroke pen_3_0
```
  - pen_4_0
```
public static final java.awt.BasicStroke pen_4_0
```
  - TPAD2
```
public static final int TPAD2
```
    See Also:
    Constant Field Values
  - TPAD4
```
public static final int TPAD4
```
    See Also:
    Constant Field Values
  - TPAD6
```
public static final int TPAD6
```
    See Also:
    Constant Field Values
  - TPAD8
```
public static final int TPAD8
```
    See Also:
    Constant Field Values
  - SCROLLBAR_VERTICAL
```
public static final int SCROLLBAR_VERTICAL
```
    See Also:
    Constant Field Values
  - SCROLLBAR_HORIZONTAL
```
public static final int SCROLLBAR_HORIZONTAL
```
    See Also:
    Constant Field Values
  - WHEEL_DELTA
```
public static final float WHEEL_DELTA
```
    See Also:
    Constant Field Values
  - WHEEL_STICK_FACTOR
```
public static final float WHEEL_STICK_FACTOR
```
    See Also:
    Constant Field Values
  - EOL
```
public static final char EOL
```
    See Also:
    Constant Field Values
  - Z_STICKY
```
public static final int Z_STICKY
```
    See Also:
    Constant Field Values
  - Z_SLIPPY
```
public static final int Z_SLIPPY
```
    See Also:
    Constant Field Values
  - Z_SLIPPY_EXPANDS
```
public static final int Z_SLIPPY_EXPANDS
```
    See Also:
    Constant Field Values
  - Z_PANEL
```
public static final int Z_PANEL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - GTimer
```
public GTimer(processing.core.PApplet theApplet,
      java.lang.Object obj,
      java.lang.String methodName,
      int delay)
```
    Create the GTimer object with this ctor. 'methodName' is the method/function to be called every 'interval' milliseconds. 'obj' is the object that contains the method/function 'methodName' For most users 'methodName' will be in their main sketch so this parameter has the same value as 'theApplet'
    
    Parameters:
    theApplet - a reference to the PApplet object (invariably this)
    obj - the object that has the method to be executed (likely to be this)
    methodName - the name of the method to be called by the timer
    delay - the initial delay and the time (in millisecs) between function calls
  - GTimer
```
public GTimer(processing.core.PApplet theApplet,
      java.lang.Object obj,
      java.lang.String methodName,
      int delay,
      int initDelay)
```
    Create the GTimer object with this ctor. 'methodName' is the method/function to be called every 'interval' milliseconds. 'obj' is the object that contains the method/function 'methodName' For most users 'methodName' will be in their main sketch so this parameter has the same value as 'theApplet'
    
    Parameters:
    theApplet - a reference to the PApplet object (invariably this)
    obj - the object that has the method to be executed (likely to be this)
    methodName - the name of the method to be called by the timer
    delay - the time (in millisecs) between function calls
    initDelay - the initial delay (in millisecs) before calling method
- Method Detail
  - start
```
public void start()
```
    Start the timer (call the method forever)
  - start
```
public void start(int nrepeats)
```
    Start the timer and call the method for the number of times indicated by nrepeats If nrepeats is <=0 then repeat forever
    
    Parameters:
    nrepeats -
  - stop
```
public void stop()
```
    Stop the timer (can be restarted with start() method)
  - isRunning
```
public boolean isRunning()
```
    Is the timer running?
    
    Returns:
    true if running
  - setInterval
```
public void setInterval(int interval)
```
    Set the interval between events
    
    Parameters:
    interval - delay between events in milliseconds
  - setInitialDelay
```
public void setInitialDelay(int initDelay)
```
    Set the delay before the first event is triggered
    
    Parameters:
    initDelay - initial delay in milliseconds
  - setDelay
```
public void setDelay(int delay)
```
    Sets the initial delay and the interval between events.
    This is equivalent to calling both -
```
 setInterval(delay);
 setInitialDelay(delay);
 
```
    Parameters:
    delay - initial delay and interval in milliseconds
  - getInterval
```
public int getInterval()
```
    Get the interval time (milliseconds) between events.
    
    Returns:
    interval in millsecs or -1 if the timer failed to be created.
  - getInitialDelay
```
public int getInitialDelay()
```
    Get the initial delay time (milliseconds).
    
    Returns:
    initial delay in millsecs or -1 if the timer failed to be created.
  - getNbrRepeats
```
public int getNbrRepeats()
```
    The number of times an event is to be fired.
    
    Returns:
    the nbrRepeats
  - setNbrRepeats
```
public void setNbrRepeats(int nbrRepeats)
```
    The number of times an event is to be fired.
    
    Parameters:
    nbrRepeats - <=0 keep running until stopped by user
  - isValid
```
public boolean isValid()
```
    See if the GTimer object has been created successfully
    
    Returns:
    true if successful

Class GTimer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SLIDER_STYLES

DEFAULT_SLIDER_STYLE

DRAW_METHOD

MOUSE_METHOD

PRE_METHOD

KEY_METHOD

POST_METHOD

ALL_METHOD

GROUP_CONTROL_METHOD

MISSING

NONEXISTANT

INVALID_TYPE

INVALID_PAPPLET

EXCP_IN_HANDLER

OFF_CONTROL

OVER_CONTROL

PRESS_CONTROL

DRAG_CONTROL

TINT_FOR_ALPHA

I_NONE

I_TL

I_TR

I_CL

I_CR

I_INSIDE

I_COVERED

I_MODES

MERGE_RUNS

CLIP_RUN

COMBI_MODES

grid

pen_1_0

pen_2_0

pen_3_0

pen_4_0

TPAD2

TPAD4

TPAD6

TPAD8

SCROLLBAR_VERTICAL

SCROLLBAR_HORIZONTAL

WHEEL_DELTA

WHEEL_STICK_FACTOR

EOL

Z_STICKY

Z_SLIPPY

Z_SLIPPY_EXPANDS

Z_PANEL

Constructor Detail

GTimer

GTimer

Method Detail

start

start

stop

isRunning

setInterval

setInitialDelay

setDelay

getInterval

getInitialDelay

getNbrRepeats

setNbrRepeats

isValid