org.xith3d.utility.screenshots
Class ScreenshotInputAction

java.lang.Object
  extended by org.jagatoo.input.actions.AbstractInputAction
      extended by org.jagatoo.input.actions.AbstractInvokableInputAction
          extended by org.jagatoo.input.actions.AbstractLabeledInvokableInputAction
              extended by org.xith3d.utility.screenshots.ScreenshotInputAction
All Implemented Interfaces:
org.jagatoo.input.actions.InputAction, org.jagatoo.input.actions.InvokableInputAction, org.jagatoo.input.actions.LabeledInputAction, org.jagatoo.input.actions.LabeledInvokableInputAction

public class ScreenshotInputAction
extends org.jagatoo.input.actions.AbstractLabeledInvokableInputAction

Handles Screenshot generation by hot-key.


Constructor Summary
ScreenshotInputAction(int ordinal, java.lang.String text, ScreenshotEngine shotEngine)
          Creates a new SchreenshotManager.
ScreenshotInputAction(int ordinal, java.lang.String text, ScreenshotEngine shotEngine, java.lang.String filenameBase)
          Creates a new ScreenshotInputAction.
ScreenshotInputAction(ScreenshotEngine shotEngine)
          Creates a new SchreenshotManager.
ScreenshotInputAction(ScreenshotEngine shotEngine, java.lang.String filenameBase)
          Creates a new SchreenshotManager.
 
Method Summary
 java.lang.String getFilenameBase()
           
 ScreenshotEngine getScreenshotEngine()
           
 java.lang.String invokeAction(org.jagatoo.input.devices.InputDevice device, org.jagatoo.input.devices.components.DeviceComponent comp, int delta, int state, long nanoTime)
          
 void setFilenameBase(java.lang.String filenameBase)
          Sets the base filename for the screenshot files.
 void setScreenshotEngine(ScreenshotEngine shotEngine)
          Sets the ScreenshotEngine to use for screenshot generation.
 
Methods inherited from class org.jagatoo.input.actions.AbstractLabeledInvokableInputAction
getLocalizedText, getText
 
Methods inherited from class org.jagatoo.input.actions.AbstractInputAction
ordinal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jagatoo.input.actions.InputAction
ordinal
 

Constructor Detail

ScreenshotInputAction

public ScreenshotInputAction(int ordinal,
                             java.lang.String text,
                             ScreenshotEngine shotEngine,
                             java.lang.String filenameBase)
Creates a new ScreenshotInputAction.

Parameters:
ordinal -
text -
shotEngine - the ScreenshotEngine to use for screenshot generation
filenameBase - the filename-base for the screenshot file names

ScreenshotInputAction

public ScreenshotInputAction(ScreenshotEngine shotEngine,
                             java.lang.String filenameBase)
Creates a new SchreenshotManager.

Parameters:
shotEngine - the ScreenshotEngine to use for screenshot generation

ScreenshotInputAction

public ScreenshotInputAction(int ordinal,
                             java.lang.String text,
                             ScreenshotEngine shotEngine)
Creates a new SchreenshotManager.
(default filename base = "screenshot")

Parameters:
ordinal -
text -
shotEngine - the ScreenshotEngine to use for screenshot generation

ScreenshotInputAction

public ScreenshotInputAction(ScreenshotEngine shotEngine)
Creates a new SchreenshotManager.
(default filename base = "screenshot")

Parameters:
shotEngine - the ScreenshotEngine to use for screenshot generation
Method Detail

invokeAction

public java.lang.String invokeAction(org.jagatoo.input.devices.InputDevice device,
                                     org.jagatoo.input.devices.components.DeviceComponent comp,
                                     int delta,
                                     int state,
                                     long nanoTime)
                              throws org.jagatoo.input.InputSystemException

Throws:
org.jagatoo.input.InputSystemException

setScreenshotEngine

public void setScreenshotEngine(ScreenshotEngine shotEngine)
Sets the ScreenshotEngine to use for screenshot generation.

Parameters:
shotEngine - the ScreenshotEngine to use for screenshot generation

getScreenshotEngine

public final ScreenshotEngine getScreenshotEngine()
Returns:
the ScreenshotEngine to use for screenshot generation.

setFilenameBase

public void setFilenameBase(java.lang.String filenameBase)
Sets the base filename for the screenshot files.

Parameters:
filenameBase -

getFilenameBase

public final java.lang.String getFilenameBase()
Returns:
the base filename for the screenshot files.