TimerView (Nenya Core 1.6.1 API)

java.lang.Object
- com.threerings.media.TimerView

All Implemented Interfaces:

FrameParticipant, HierarchyListener, EventListener

Direct Known Subclasses:

HourglassView
```
public class TimerView
extends Object
implements FrameParticipant, HierarchyListener
```
A generic timer class that can be rendered on screen. NOTE: This base class doesn't actually render anything, but it's still useful for triggering user supplied callback functions. Derived classes are more than welcome to setup their own rendering, of course.

Constructor Summary

Constructors
Constructor and Description

TimerView(FrameManager fmgr, JComponent host, Rectangle bounds)
Constructs a timer view that fires at the default rate.

Constructors
Constructor and Description
`TimerView(FrameManager fmgr, JComponent host, Rectangle bounds)` Constructs a timer view that fires at the default rate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeComplete(float complete)` Generate an unexpected change in the timer's completion and set up the necessary details to render interpolation from the old to new states
`void`	`checkFrameParticipation()` Check that the frame knows about the timer.
`Component`	`getComponent()` If a frame participant wishes also to be actively rendered every frame rather than use passive rendering (which for Swing, at least, is hijacked when using the frame manager such that we take care of repainting dirty Swing components every frame into our off-screen buffer), it can return a component here which will have `Component.paint(java.awt.Graphics)` called on it once per frame with a translated but unclipped graphics object.
`long`	`getTransitionTime()` Get the amount of time it takes to render digital changes in the completion state.
`void`	`hierarchyChanged(HierarchyEvent e)`
`boolean`	`needsPaint()` Called immediately prior to `FrameParticipant.getComponent()` and then `Component.paint(java.awt.Graphics)` on said component, to determine whether or not this frame participant needs to be painted.
`void`	`paint(Graphics2D gfx, float complete)` Paint the timer into the given graphics context at the inputted percent complete (0f means just started, 1f means just finished).
`void`	`pause()` Pause the timer from processing.
`void`	`removeWarning()` Remove any warning this timer might have had.
`void`	`render(Graphics2D gfx)` Renders the timer to the given graphics context if enabled.
`void`	`reset()` Reset the timer.
`boolean`	`running()` Test if the timer is running right now.
`void`	`setEnabled(boolean enabled)` Sets whether this timer should be rendered.
`void`	`setTransitionTime(long time)` Set the amount of time it takes to render digital changes in the completion state (probably due to a timer reset).
`void`	`setWarning(float warnPercent, ResultListener<TimerView> warner)` Setup a warning to trigger after the timer is "warnPercent" or more completed.
`void`	`start(float startPercent, long duration, ResultListener<TimerView> finisher)` Start the timer running from the specified percentage complete, to expire at the specified time.
`void`	`stop()` Stop the timer.
`void`	`tick(long now)` This is called on all registered frame participants, one for every frame.
`void`	`unpause()` Unpause the timer.

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

- Constructor Detail
  - TimerView
```
public TimerView(FrameManager fmgr,
                 JComponent host,
                 Rectangle bounds)
```
    Constructs a timer view that fires at the default rate.
- Method Detail
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether this timer should be rendered.
  - getTransitionTime
```
public long getTransitionTime()
```
    Get the amount of time it takes to render digital changes in the completion state.
  - setTransitionTime
```
public void setTransitionTime(long time)
```
    Set the amount of time it takes to render digital changes in the completion state (probably due to a timer reset).
  - setWarning
```
public void setWarning(float warnPercent,
                       ResultListener<TimerView> warner)
```
    Setup a warning to trigger after the timer is "warnPercent" or more completed. If "warner" is non-null, it will be called at that time.
  - removeWarning
```
public void removeWarning()
```
    Remove any warning this timer might have had.
  - running
```
public boolean running()
```
    Test if the timer is running right now.
  - start
```
public void start(float startPercent,
                  long duration,
                  ResultListener<TimerView> finisher)
```
    Start the timer running from the specified percentage complete, to expire at the specified time.
    
    Parameters:
    
    startPercent - a value in [0f, 1f) indicating how much hourglass time has already elapsed when the timer starts.
    
    duration - The time interval over which the timer would run if it started at 0%.
    
    finisher - a listener that will be notified when the timer finishes, or null if nothing should be notified.
  - reset
```
public void reset()
```
    Reset the timer.
  - stop
```
public void stop()
```
    Stop the timer.
  - pause
```
public void pause()
```
    Pause the timer from processing.
  - unpause
```
public void unpause()
```
    Unpause the timer.
  - changeComplete
```
public void changeComplete(float complete)
```
    Generate an unexpected change in the timer's completion and set up the necessary details to render interpolation from the old to new states
  - render
```
public void render(Graphics2D gfx)
```
    Renders the timer to the given graphics context if enabled.
  - paint
```
public void paint(Graphics2D gfx,
                  float complete)
```
    Paint the timer into the given graphics context at the inputted percent complete (0f means just started, 1f means just finished).
  - tick
```
public void tick(long now)
```
    Description copied from interface: FrameParticipant
    
    This is called on all registered frame participants, one for every frame. Following the tick the interface will be rendered, so participants can prepare themselves for their upcoming render in this method (making use of the timestamp provided for the frame if choreography is desired between different participants).
    
    Specified by:
    
    tick in interface FrameParticipant
  - needsPaint
```
public boolean needsPaint()
```
    Description copied from interface: FrameParticipant
    
    Called immediately prior to FrameParticipant.getComponent() and then Component.paint(java.awt.Graphics) on said component, to determine whether or not this frame participant needs to be painted.
    
    Specified by:
    
    needsPaint in interface FrameParticipant
  - getComponent
```
public Component getComponent()
```
    Description copied from interface: FrameParticipant
    
    If a frame participant wishes also to be actively rendered every frame rather than use passive rendering (which for Swing, at least, is hijacked when using the frame manager such that we take care of repainting dirty Swing components every frame into our off-screen buffer), it can return a component here which will have Component.paint(java.awt.Graphics) called on it once per frame with a translated but unclipped graphics object.
    Because clipping is expensive in terms of rectangle object allocation, frame participants are given the opportunity to do their own clipping because they are likely to want to clip to a more fine grained region than their entire bounds. If a participant does not wish to be actively rendered, it can safely return null.
    
    Specified by:
    
    getComponent in interface FrameParticipant
  - hierarchyChanged
```
public void hierarchyChanged(HierarchyEvent e)
```
    Specified by:
    
    hierarchyChanged in interface HierarchyListener
  - checkFrameParticipation
```
public void checkFrameParticipation()
```
    Check that the frame knows about the timer.

Class TimerView

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TimerView

Method Detail

setEnabled

getTransitionTime

setTransitionTime

setWarning

removeWarning

running

start

reset

stop

pause

unpause

changeComplete

render

paint

tick

needsPaint

getComponent

hierarchyChanged

checkFrameParticipation