Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## de.rico.engine.camera.recorder
Class Recorder

    java.lang.Object
      de.rico.engine.camera.recorder.Recorder

    public class Recorder

extends java.lang.Object

This class can be used to record a camera path by manually flying the cam across the scene.

Author:
  Frank Bruns

Constructor Summary
`Recorder(int framesPerSecond)` Creates a new recorder for camera flights with the specified frames per second (how many checkpoint are to be created in one second).

Method Summary
`CameraFlight` | `getRecordedCameraFlight()` Returns the recorded camera flight.
`boolean` | `isRecording()` Determines whether or not the recorder is recording at the moment.
`void` | `reset()` Resets the recorder to initial status.
`void` | `save(java.lang.String pathToFile)` Saves the recorded camera flight to a file with the specified file path.
`void` | `start()` Starts the recording of checkpoints (frames) according to the frames per second specified earlier.
`void` | `stop()` Stops/pauses the recording of frames (checkpoints).
`void` | `update(long elapsedTime)` Updates the recorder according to the elapsed time.

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

Constructor Detail

### Recorder

    public Recorder(int framesPerSecond)

  Creates a new recorder for camera flights with the specified frames per second (how many checkpoint are to be created in one second). To achieve a fluent camera flight movement you should specify a value close to 25 for the framesPerSecond parameter.

  Parameters:
    `framesPerSecond` - number of frames (checkpoint) that are to be recorded in one second.

Method Detail

### start

    public void start()

  Starts the recording of checkpoints (frames) according to the frames per second specified earlier.

### isRecording

    public boolean isRecording()

  Determines whether or not the recorder is recording at the moment.

  Returns:
    is recording? --> true=yes, false=no

### stop

    public void stop()

  Stops/pauses the recording of frames (checkpoints). A call to start() continues the recording process.

### reset

    public void reset()

  Resets the recorder to initial status.

### update

    public void update(long elapsedTime)

  Updates the recorder according to the elapsed time.

  Parameters:
    `elapsedTime` - time between two render frames

### getRecordedCameraFlight

    public CameraFlight getRecordedCameraFlight()

  Returns the recorded camera flight.

  Returns:
    recorded camera flight

### save

    public void save(java.lang.String pathToFile)

  Saves the recorded camera flight to a file with the specified file path. There will only be saved something if there are checkpoints assigned to the flight.

  Parameters:
    `pathToFile` - path to the file into which the recorded data gets saved

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD