Panda3D
Public Member Functions | Static Public Member Functions | List of all members
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...

Inheritance diagram for RecorderController:
TypedReferenceCount TypedObject ReferenceCount

Public Member Functions

 __init__ ()
 
 addRecorder (str name, RecorderBase recorder)
 Adds the named recorder to the set of recorders that are in use. More...
 
bool beginPlayback (const Filename filename)
 Begins playing back data from the indicated filename. More...
 
bool beginRecord (const Filename filename)
 Begins recording data to the indicated filename. More...
 
 close ()
 Finishes recording data to the indicated filename. More...
 
double getClockOffset ()
 Returns the delta offset between the actual frame time and the frame time written to the log. More...
 
const Filename getFilename ()
 Returns the filename that was passed to the most recent call to begin_record() or begin_playback(). More...
 
int getFrameOffset ()
 Returns the delta offset between the actual frame count and the frame count written to the log. More...
 
bool getFrameTie ()
 See set_frame_tie(). More...
 
int getRandomSeed ()
 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 getRecorder (str name)
 Returns the recorder with the indicated name, or NULL if there is no such recorder. More...
 
time_t getStartTime ()
 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...
 
bool hasRecorder (str name)
 Returns true if the named recorder has been added to the table by a previous call to add_recorder(), false otherwise. More...
 
bool isError ()
 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 isOpen ()
 Returns true if the controller has been opened for either input or output, false otherwise. More...
 
bool isPlaying ()
 Returns true if the controller has been opened for input, false otherwise. More...
 
bool isRecording ()
 Returns true if the controller has been opened for output, false otherwise. More...
 
 playFrame ()
 Gets the next frame of data from all of the active recorders and adds it to the output file. More...
 
 recordFrame ()
 Gets the next frame of data from all of the active recorders and adds it to the output file. More...
 
bool removeRecorder (str name)
 Removes the named recorder from the table. More...
 
 setFrameTie (bool frame_tie)
 Sets the frame_tie flag. More...
 
 setRandomSeed (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 TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 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.

Member Function Documentation

◆ __init__()

__init__ ( )

◆ addRecorder()

addRecorder ( str  name,
RecorderBase  recorder 
)

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.

◆ beginPlayback()

bool beginPlayback ( 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.

◆ beginRecord()

bool beginRecord ( const Filename  filename)

Begins recording data to the indicated filename.

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

◆ close()

close ( )

Finishes recording data to the indicated filename.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getClockOffset()

double getClockOffset ( )

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.

◆ getFilename()

const Filename getFilename ( )

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

◆ getFrameOffset()

int getFrameOffset ( )

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.

◆ getFrameTie()

bool getFrameTie ( )

See set_frame_tie().

◆ getRandomSeed()

int getRandomSeed ( )

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.

◆ getRecorder()

RecorderBase getRecorder ( str  name)

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.

◆ getStartTime()

time_t getStartTime ( )

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

◆ hasRecorder()

bool hasRecorder ( str  name)

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

◆ isError()

bool isError ( )

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.

◆ isOpen()

bool isOpen ( )

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

◆ isPlaying()

bool isPlaying ( )

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

◆ isRecording()

bool isRecording ( )

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

◆ playFrame()

playFrame ( )

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

◆ recordFrame()

recordFrame ( )

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

◆ removeRecorder()

bool removeRecorder ( str  name)

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

◆ setFrameTie()

setFrameTie ( bool  frame_tie)

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.

◆ setRandomSeed()

setRandomSeed ( 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.

This must be set before begin_record() is called.