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:

Public Types
typedef Factory< RecorderBase >	RecorderFactory

Public Member Functions
void	add_recorder (const std::string &name, RecorderBase *recorder)
	Adds the named recorder to the set of recorders that are in use. More...

bool	begin_playback (const Filename &filename)
	Begins playing back data from the indicated filename. More...

bool	begin_record (const Filename &filename)
	Begins recording data to the indicated filename. More...

void	close ()
	Finishes recording data to the indicated filename. More...

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. More...

const Filename &	get_filename () const
	Returns the filename that was passed to the most recent call to begin_record() or begin_playback(). More...

int	get_frame_offset () const
	Returns the delta offset between the actual frame count and the frame count written to the log. More...

bool	get_frame_tie () const
	See set_frame_tie(). More...

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. More...

RecorderBase *	get_recorder (const std::string &name) const
	Returns the recorder with the indicated name, or NULL if there is no such recorder. More...

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). More...

virtual TypeHandle	get_type () const

bool	has_recorder (const std::string &name) const
	Returns true if the named recorder has been added to the table by a previous call to add_recorder(), false otherwise. More...

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. More...

bool	is_open () const
	Returns true if the controller has been opened for either input or output, false otherwise. More...

bool	is_playing () const
	Returns true if the controller has been opened for input, false otherwise. More...

bool	is_recording () const
	Returns true if the controller has been opened for output, false otherwise. More...

void	play_frame ()
	Gets the next frame of data from all of the active recorders and adds it to the output file. More...

void	record_frame ()
	Gets the next frame of data from all of the active recorders and adds it to the output file. More...

bool	remove_recorder (const std::string &name)
	Removes the named recorder from the table. More...

void	set_frame_tie (bool frame_tie)
	Sets the frame_tie flag. More...

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. More...

Public Member Functions inherited from TypedReferenceCount
	TypedReferenceCount (const TypedReferenceCount &copy)

void	operator= (const TypedReferenceCount &copy)

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

int	get_best_parent_from_Set (const std::set< int > &) const

int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...

bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly. More...

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type. More...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object. More...

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...

void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...

void	ref () const
	Explicitly increments the reference count. More...

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. More...

bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus. More...

bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...

virtual bool	unref () const
	Explicitly decrements the reference count. More...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object. More...

Static Public Member Functions
static TypeHandle	get_class_type ()

static RecorderFactory *	get_factory ()
	Returns the global RecorderFactory for generating TypedWritable objects. More...

static void	init_type ()

Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedObject
static TypeHandle	get_class_type ()

static void	init_type ()
	This function is declared non-inline to work around a compiler bug in g++ 2.96. More...

Static Public Member Functions inherited from ReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Friends
class	RecorderFrame

Additional Inherited Members
Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count. More...

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 32 of file recorderController.h.

Member Function Documentation

◆ add_recorder()

void RecorderController::add_recorder	(	const std::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 118 of file recorderController.I.

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

◆ begin_playback()

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 104 of file recorderController.cxx.

References close(), ClockObject::get_frame_count, ClockObject::get_frame_time, ClockObject::get_global_clock(), DatagramInputFile::open(), and DatagramInputFile::read_header().

◆ begin_record()

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 56 of file recorderController.cxx.

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

◆ close()

void RecorderController::close ( )

Finishes recording data to the indicated filename.

Definition at line 171 of file recorderController.cxx.

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

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

◆ get_clock_offset()

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 94 of file recorderController.I.

◆ get_factory()

RecorderController::RecorderFactory * RecorderController::get_factory ( )

inlinestatic

Returns the global RecorderFactory for generating TypedWritable objects.

Definition at line 219 of file recorderController.I.

Referenced by MouseRecorder::register_with_read_factory().

◆ get_filename()

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 74 of file recorderController.I.

◆ get_frame_offset()

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 104 of file recorderController.I.

◆ get_frame_tie()

bool RecorderController::get_frame_tie ( ) const

inline

See set_frame_tie().

Definition at line 211 of file recorderController.I.

◆ get_random_seed()

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 40 of file recorderController.I.

◆ get_recorder()

RecorderBase * RecorderController::get_recorder ( const std::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 154 of file recorderController.I.

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

◆ get_start_time()

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 20 of file recorderController.I.

◆ has_recorder()

bool RecorderController::has_recorder ( const std::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 140 of file recorderController.I.

References RecorderTable::get_recorder().

◆ is_error()

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 84 of file recorderController.I.

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

◆ is_open()

bool RecorderController::is_open ( ) const

inline

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

Definition at line 65 of file recorderController.I.

References is_playing(), and is_recording().

◆ is_playing()

bool RecorderController::is_playing ( ) const

inline

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

Definition at line 56 of file recorderController.I.

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

◆ is_recording()

bool RecorderController::is_recording ( ) const

inline

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

Definition at line 48 of file recorderController.I.

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

◆ play_frame()

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 223 of file recorderController.cxx.

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

◆ record_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 205 of file recorderController.cxx.

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

◆ remove_recorder()

bool RecorderController::remove_recorder ( const std::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 173 of file recorderController.I.

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

◆ set_frame_tie()

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 203 of file recorderController.I.

◆ set_random_seed()

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 30 of file recorderController.I.

The documentation for this class was generated from the following files:

panda/src/recorder/recorderController.h
panda/src/recorder/recorderController.cxx
panda/src/recorder/recorderController.I

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_recorder()

◆ begin_playback()

◆ begin_record()

◆ close()

◆ get_clock_offset()

◆ get_factory()

◆ get_filename()

◆ get_frame_offset()

◆ get_frame_tie()

◆ get_random_seed()

◆ get_recorder()

◆ get_start_time()

◆ has_recorder()

◆ is_error()

◆ is_open()

◆ is_playing()

◆ is_recording()

◆ play_frame()

◆ record_frame()

◆ remove_recorder()

◆ set_frame_tie()

◆ set_random_seed()