Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Friends

RecorderController Class Reference

This object manages the process of recording the user's runtime inputs to a bam file so that the session can be recreated later. More...

#include "recorderController.h"

Inheritance diagram for RecorderController:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

List of all members.

Public Types

typedef Factory< RecorderBaseRecorderFactory

Public Member Functions

void add_recorder (const string &name, RecorderBase *recorder)
 Adds the named recorder to the set of recorders that are in use.
bool begin_playback (const Filename &filename)
 Begins playing back data from the indicated filename.
bool begin_record (const Filename &filename)
 Begins recording data to the indicated filename.
void close ()
 Finishes recording data to the indicated filename.
virtual TypeHandle force_init_type ()
double get_clock_offset () const
 Returns the delta offset between the actual frame time and the frame time written to the log.
const Filenameget_filename () const
 Returns the filename that was passed to the most recent call to begin_record() or begin_playback().
int get_frame_offset () const
 Returns the delta offset between the actual frame count and the frame count written to the log.
bool get_frame_tie () const
 See set_frame_tie().
int get_random_seed () const
 Returns the random seed that was set by a previous call to set_random_seed(), or the number read from the session file after begin_playback() has been called.
RecorderBaseget_recorder (const string &name) const
 Returns the recorder with the indicated name, or NULL if there is no such recorder.
time_t get_start_time () const
 Returns the time (and date) at which the current session was originally recorded (or, in recording mode, the time at which the current session began).
virtual TypeHandle get_type () const
bool has_recorder (const string &name) const
 Returns true if the named recorder has been added to the table by a previous call to add_recorder(), false otherwise.
bool is_error ()
 Returns true if the controller has been opened for input or output output and there is an error on the stream, or false if the controller is closed or if there is no problem.
bool is_open () const
 Returns true if the controller has been opened for either input or output, false otherwise.
bool is_playing () const
 Returns true if the controller has been opened for input, false otherwise.
bool is_recording () const
 Returns true if the controller has been opened for output, false otherwise.
void play_frame ()
 Gets the next frame of data from all of the active recorders and adds it to the output file.
void record_frame ()
 Gets the next frame of data from all of the active recorders and adds it to the output file.
bool remove_recorder (const string &name)
 Removes the named recorder from the table.
void set_frame_tie (bool frame_tie)
 Sets the frame_tie flag.
void set_random_seed (int random_seed)
 Indicates an arbitrary number to be recorded in the session file as a random seed, should the application wish to take advantage of it.

Static Public Member Functions

static TypeHandle get_class_type ()
static RecorderFactoryget_factory ()
 Returns the global RecorderFactory for generating TypedWritable objects.
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Friends

class RecorderFrame

Detailed Description

This object manages the process of recording the user's runtime inputs to a bam file so that the session can be recreated later.

Definition at line 35 of file recorderController.h.


Member Function Documentation

void RecorderController::add_recorder ( const string &  name,
RecorderBase recorder 
) [inline]

Adds the named recorder to the set of recorders that are in use.

If the controller is in recording mode, the named recorder will begin recording its status to the session file. If the controller is in playback mode and the name and type matches a recorder in the session file, the recorder will begin receiving data.

Definition at line 151 of file recorderController.I.

References RecorderTable::add_recorder(), and is_recording().

Referenced by PandaFramework::get_mouse().

bool RecorderController::begin_playback ( const Filename filename)

Begins playing back data from the indicated filename.

All of the recorders in use should already have been added, although this may define additional recorders if they are present in the file (these new recorders will not be used). This may also undefine recorders that were previously added but are not present in the file.

Definition at line 122 of file recorderController.cxx.

References close(), ClockObject::get_frame_count(), ClockObject::get_frame_time(), ClockObject::get_global_clock(), BamReader::init(), TypedObject::is_of_type(), DatagramInputFile::open(), DatagramInputFile::read_header(), BamReader::read_object(), and BamReader::resolve().

Referenced by PandaFramework::open_framework().

bool RecorderController::begin_record ( const Filename filename)

Begins recording data to the indicated filename.

All of the recorders in use should already have been added.

Definition at line 64 of file recorderController.cxx.

References close(), ClockObject::get_frame_count(), ClockObject::get_frame_time(), ClockObject::get_global_clock(), BamWriter::init(), DatagramOutputFile::open(), DatagramOutputFile::write_header(), and BamWriter::write_object().

Referenced by PandaFramework::open_framework().

void RecorderController::close ( )

Finishes recording data to the indicated filename.

Definition at line 191 of file recorderController.cxx.

References DatagramInputFile::close(), and DatagramOutputFile::close().

Referenced by begin_playback(), begin_record(), and play_frame().

double RecorderController::get_clock_offset ( ) const [inline]

Returns the delta offset between the actual frame time and the frame time written to the log.

This is essentially the time at which the recording (or playback) started.

Definition at line 120 of file recorderController.I.

RecorderController::RecorderFactory * RecorderController::get_factory ( ) [inline, static]

Returns the global RecorderFactory for generating TypedWritable objects.

Definition at line 274 of file recorderController.I.

Referenced by RecorderTable::fillin(), and MouseRecorder::register_with_read_factory().

const Filename & RecorderController::get_filename ( ) const [inline]

Returns the filename that was passed to the most recent call to begin_record() or begin_playback().

Definition at line 94 of file recorderController.I.

int RecorderController::get_frame_offset ( ) const [inline]

Returns the delta offset between the actual frame count and the frame count written to the log.

This is essentially the frame number at which the recording (or playback) started.

Definition at line 133 of file recorderController.I.

bool RecorderController::get_frame_tie ( ) const [inline]

See set_frame_tie().

Definition at line 263 of file recorderController.I.

int RecorderController::get_random_seed ( ) const [inline]

Returns the random seed that was set by a previous call to set_random_seed(), or the number read from the session file after begin_playback() has been called.

Definition at line 50 of file recorderController.I.

RecorderBase * RecorderController::get_recorder ( const string &  name) const [inline]

Returns the recorder with the indicated name, or NULL if there is no such recorder.

If the controller is in playback mode, this may return the recorder matching the indicated name as read from the session file, even if it was never added to the table by the user. In this case, has_recorder() may return false, but get_recorder() will return a non-NULL value.

Definition at line 195 of file recorderController.I.

References RecorderTable::get_recorder(), and is_playing().

time_t RecorderController::get_start_time ( ) const [inline]

Returns the time (and date) at which the current session was originally recorded (or, in recording mode, the time at which the current session began).

Definition at line 24 of file recorderController.I.

bool RecorderController::has_recorder ( const string &  name) const [inline]

Returns true if the named recorder has been added to the table by a previous call to add_recorder(), false otherwise.

If the controller is in playback mode, this will also return false for a recorder that was found in the session file but was never explicitly added via add_recorder(); see get_recorder().

Definition at line 177 of file recorderController.I.

References RecorderTable::get_recorder().

static void RecorderController::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedReferenceCount.

Definition at line 113 of file recorderController.h.

References TypedReferenceCount::init_type().

bool RecorderController::is_error ( ) [inline]

Returns true if the controller has been opened for input or output output and there is an error on the stream, or false if the controller is closed or if there is no problem.

Definition at line 107 of file recorderController.I.

References DatagramInputFile::is_error(), and DatagramOutputFile::is_error().

bool RecorderController::is_open ( ) const [inline]

Returns true if the controller has been opened for either input or output, false otherwise.

Definition at line 83 of file recorderController.I.

References is_playing(), and is_recording().

bool RecorderController::is_playing ( ) const [inline]

Returns true if the controller has been opened for input, false otherwise.

Definition at line 72 of file recorderController.I.

Referenced by get_recorder(), is_open(), play_frame(), and remove_recorder().

bool RecorderController::is_recording ( ) const [inline]

Returns true if the controller has been opened for output, false otherwise.

Definition at line 61 of file recorderController.I.

Referenced by add_recorder(), is_open(), record_frame(), and remove_recorder().

void RecorderController::play_frame ( )

Gets the next frame of data from all of the active recorders and adds it to the output file.

Definition at line 259 of file recorderController.cxx.

References close(), ClockObject::get_frame_count(), ClockObject::get_frame_time(), ClockObject::get_global_clock(), BamReader::is_eof(), is_playing(), RecorderTable::merge_from(), and RecorderFrame::play_frame().

void RecorderController::record_frame ( )

Gets the next frame of data from all of the active recorders and adds it to the output file.

Definition at line 239 of file recorderController.cxx.

References ClockObject::get_frame_count(), ClockObject::get_frame_time(), ClockObject::get_global_clock(), is_recording(), and BamWriter::write_object().

bool RecorderController::remove_recorder ( const string &  name) [inline]

Removes the named recorder from the table.

Returns true if successful, false if there was no such recorder.

If the controller is in recording mode, the named recorder will stop recording. If the controller is in playback mode, the named recorder will disassociate itself from the session file (but if the session file still has data for this name, a default recorder will take its place to decode the data from the session file).

Definition at line 219 of file recorderController.I.

References RecorderTable::get_recorder(), is_playing(), is_recording(), and RecorderTable::remove_recorder().

void RecorderController::set_frame_tie ( bool  frame_tie) [inline]

Sets the frame_tie flag.

When this is true, sessions are played back frame-for-frame, based on the frame count of the recorded session. This gives the most accurate playback, but the playback rate will vary according to the frame rate of the playback machine.

When this is false, sessions are played back at real time, based on the clock of the recorded session. This may introduce playback discrepencies if the frames do not fall at exactly the same times as they did in the original.

Definition at line 253 of file recorderController.I.

void RecorderController::set_random_seed ( int  random_seed) [inline]

Indicates an arbitrary number to be recorded in the session file as a random seed, should the application wish to take advantage of it.

This must be set before begin_record() is called.

Definition at line 37 of file recorderController.I.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations