Panda3D
recorderFrame.h
Go to the documentation of this file.
1 /**
2  * PANDA 3D SOFTWARE
3  * Copyright (c) Carnegie Mellon University. All rights reserved.
4  *
5  * All use of this software is subject to the terms of the revised BSD
6  * license. You should have received a copy of this license along
7  * with this source code in a file named "LICENSE."
8  *
9  * @file recorderFrame.h
10  * @author drose
11  * @date 2004-01-28
12  */
13 
14 #ifndef RECORDERFRAME_H
15 #define RECORDERFRAME_H
16 
17 #include "pandabase.h"
18 #include "recorderBase.h"
19 #include "typedWritable.h"
20 #include "recorderTable.h"
21 #include "datagram.h"
22 
23 class BamWriter;
24 class BamReader;
25 class FactoryParams;
26 
27 /**
28  * This object represents one frame of data in the recorded session file. One
29  * of these is repeatedly created and destructed in recording and playback,
30  * respectively.
31  */
32 class EXPCL_PANDA_RECORDER RecorderFrame : public TypedWritable {
33 public:
34  INLINE RecorderFrame();
35  INLINE RecorderFrame(double timestamp, int frame,
36  bool table_changed, RecorderTable *table);
37  INLINE ~RecorderFrame();
38 
39  void play_frame(BamReader *manager);
40 
41  double _timestamp;
42  int _frame;
43  bool _table_changed;
44  RecorderTable *_table;
45 
46  Datagram _data;
47  size_t _data_pos;
48 
49 private:
50  RecorderTable _local_table;
51 
52 public:
53  static void register_with_read_factory();
54  virtual void write_datagram(BamWriter *manager, Datagram &dg);
55  virtual int complete_pointers(TypedWritable **plist, BamReader *manager);
56 
57 protected:
58  static TypedWritable *make_from_bam(const FactoryParams &params);
59  void fillin(DatagramIterator &scan, BamReader *manager);
60 
61 public:
62  static TypeHandle get_class_type() {
63  return _type_handle;
64  }
65  static void init_type() {
66  TypedWritable::init_type();
67  register_type(_type_handle, "RecorderFrame",
68  TypedWritable::get_class_type());
69  }
70  virtual TypeHandle get_type() const {
71  return get_class_type();
72  }
73  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
74 
75 private:
76  static TypeHandle _type_handle;
77 };
78 
79 #include "recorderFrame.I"
80 
81 #endif
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
This is the fundamental interface for extracting binary objects from a Bam file, as generated by a Ba...
Definition: bamReader.h:110
Base class for objects that can be written to and read from Bam files.
Definition: typedWritable.h:35
void register_type(TypeHandle &type_handle, const std::string &name)
This inline function is just a convenient way to call TypeRegistry::register_type(),...
Definition: register_type.I:22
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
This is the fundamental interface for writing binary objects to a Bam file, to be extracted later by ...
Definition: bamWriter.h:63
This is our own Panda specialization on the default STL list.
Definition: plist.h:35
virtual void fillin(DatagramIterator &scan, BamReader *manager)
This internal function is intended to be called by each class's make_from_bam() method to read in all...
virtual void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
This object is used by the RecorderController to write (and read) a record of the set of recorders in...
Definition: recorderTable.h:32
virtual int complete_pointers(TypedWritable **p_list, BamReader *manager)
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:36
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
This object represents one frame of data in the recorded session file.
Definition: recorderFrame.h:32
A class to retrieve the individual data elements previously stored in a Datagram.
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
An ordered list of data elements, formatted in memory for transmission over a socket or writing to a ...
Definition: datagram.h:38
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.