Panda3D
fltInstanceRef.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 fltInstanceRef.h
10  * @author drose
11  * @date 2000-08-30
12  */
13 
14 #ifndef FLTINSTANCEREF_H
15 #define FLTINSTANCEREF_H
16 
17 #include "pandatoolbase.h"
18 
19 #include "fltBead.h"
20 
22 
23 /**
24  * This bead appears in the hierarchy to refer to a FltInstanceDefinition node
25  * defined elsewhere. It indicates that the subtree beginning at the
26  * FltInstanceDefinition should be considered to be instanced here.
27  */
28 class FltInstanceRef : public FltBead {
29 public:
30  FltInstanceRef(FltHeader *header);
31 
32  int _instance_index;
33 
35 
36  virtual void write(std::ostream &out, int indent_level = 0) const;
37 
38 protected:
39  virtual bool extract_record(FltRecordReader &reader);
40  virtual FltError write_record_and_children(FltRecordWriter &writer) const;
41  virtual bool build_record(FltRecordWriter &writer) const;
42 
43 public:
44  virtual TypeHandle get_type() const {
45  return get_class_type();
46  }
47  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
48  static TypeHandle get_class_type() {
49  return _type_handle;
50  }
51  static void init_type() {
52  FltBead::init_type();
53  register_type(_type_handle, "FltInstanceRef",
54  FltBead::get_class_type());
55  }
56 
57 private:
58  static TypeHandle _type_handle;
59 };
60 
61 #endif
A base class for any of a broad family of flt records that represent particular beads in the hierarch...
Definition: fltBead.h:29
This is the first bead in the file, the top of the bead hierarchy, and the primary interface to readi...
Definition: fltHeader.h:44
This special kind of record marks the top node of an instance subtree.
This bead appears in the hierarchy to refer to a FltInstanceDefinition node defined elsewhere.
virtual void write(std::ostream &out, int indent_level=0) const
Writes a multiple-line description of the record and all of its children.
FltInstanceDefinition * get_instance() const
Returns the instance subtree referenced by this node, or NULL if the reference is invalid.
This class turns an istream into a sequence of FltRecords by reading a sequence of Datagrams and extr...
This class writes a sequence of FltRecords to an ostream, handling opcode and size counts properly.
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
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