Panda3D
showBoundsEffect.cxx
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 showBoundsEffect.cxx
10  * @author drose
11  * @date 2002-03-25
12  */
13 
14 #include "showBoundsEffect.h"
15 #include "bamReader.h"
16 #include "bamWriter.h"
17 #include "datagram.h"
18 #include "datagramIterator.h"
19 
20 TypeHandle ShowBoundsEffect::_type_handle;
21 
22 /**
23  * Constructs a new ShowBoundsEffect object.
24  */
25 CPT(RenderEffect) ShowBoundsEffect::
26 make(bool tight) {
27  ShowBoundsEffect *effect = new ShowBoundsEffect;
28  effect->_tight = tight;
29  return return_new(effect);
30 }
31 
32 /**
33  * Returns true if this kind of effect can safely be combined with sibling
34  * nodes that share the exact same effect, or false if this is not a good
35  * idea.
36  */
37 bool ShowBoundsEffect::
38 safe_to_combine() const {
39  return false;
40 }
41 
42 /**
43  * Intended to be overridden by derived ShowBoundsEffect types to return a
44  * unique number indicating whether this ShowBoundsEffect is equivalent to the
45  * other one.
46  *
47  * This should return 0 if the two ShowBoundsEffect objects are equivalent, a
48  * number less than zero if this one should be sorted before the other one,
49  * and a number greater than zero otherwise.
50  *
51  * This will only be called with two ShowBoundsEffect objects whose get_type()
52  * functions return the same.
53  */
54 int ShowBoundsEffect::
55 compare_to_impl(const RenderEffect *other) const {
56  const ShowBoundsEffect *ta;
57  DCAST_INTO_R(ta, other, 0);
58 
59  return (int)_tight - (int)ta->_tight;
60 }
61 
62 /**
63  * Tells the BamReader how to create objects of type ShowBoundsEffect.
64  */
67  BamReader::get_factory()->register_factory(get_class_type(), make_from_bam);
68 }
69 
70 /**
71  * Writes the contents of this object to the datagram for shipping out to a
72  * Bam file.
73  */
75 write_datagram(BamWriter *manager, Datagram &dg) {
76  RenderEffect::write_datagram(manager, dg);
77  dg.add_bool(_tight);
78 }
79 
80 /**
81  * This function is called by the BamReader's factory when a new object of
82  * type ShowBoundsEffect is encountered in the Bam file. It should create the
83  * ShowBoundsEffect and extract its information from the file.
84  */
85 TypedWritable *ShowBoundsEffect::
86 make_from_bam(const FactoryParams &params) {
87  ShowBoundsEffect *effect = new ShowBoundsEffect;
88  DatagramIterator scan;
89  BamReader *manager;
90 
91  parse_params(params, scan, manager);
92  effect->fillin(scan, manager);
93 
94  return effect;
95 }
96 
97 /**
98  * This internal function is called by make_from_bam to read in all of the
99  * relevant data from the BamFile for the new ShowBoundsEffect.
100  */
101 void ShowBoundsEffect::
102 fillin(DatagramIterator &scan, BamReader *manager) {
103  RenderEffect::fillin(scan, manager);
104  _tight = scan.get_bool();
105 }
ShowBoundsEffect::write_datagram
virtual void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
Definition: showBoundsEffect.cxx:75
RenderEffect
This is the base class for a number of special render effects that may be set on scene graph nodes to...
Definition: renderEffect.h:48
DatagramIterator
A class to retrieve the individual data elements previously stored in a Datagram.
Definition: datagramIterator.h:27
BamReader
This is the fundamental interface for extracting binary objects from a Bam file, as generated by a Ba...
Definition: bamReader.h:110
BamWriter
This is the fundamental interface for writing binary objects to a Bam file, to be extracted later by ...
Definition: bamWriter.h:63
BamReader::get_factory
static WritableFactory * get_factory()
Returns the global WritableFactory for generating TypedWritable objects.
Definition: bamReader.I:177
showBoundsEffect.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
bamReader.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
TypedWritable
Base class for objects that can be written to and read from Bam files.
Definition: typedWritable.h:35
Datagram
An ordered list of data elements, formatted in memory for transmission over a socket or writing to a ...
Definition: datagram.h:38
ShowBoundsEffect
Applied to a GeomNode to cause a visible bounding volume to be drawn for this node.
Definition: showBoundsEffect.h:28
TypeHandle
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
DatagramIterator::get_bool
bool get_bool()
Extracts a boolean value.
Definition: datagramIterator.I:48
FactoryParams
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:36
datagram.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
RenderEffect::write_datagram
virtual void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
Definition: renderEffect.cxx:283
Factory::register_factory
void register_factory(TypeHandle handle, CreateFunc *func, void *user_data=nullptr)
Registers a new kind of thing the Factory will be able to create.
Definition: factory.I:73
ShowBoundsEffect::register_with_read_factory
static void register_with_read_factory()
Tells the BamReader how to create objects of type ShowBoundsEffect.
Definition: showBoundsEffect.cxx:66
Datagram::add_bool
void add_bool(bool value)
Adds a boolean value to the datagram.
Definition: datagram.I:34
datagramIterator.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
bamWriter.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
parse_params
void parse_params(const FactoryParams &params, DatagramIterator &scan, BamReader *&manager)
Takes in a FactoryParams, passed from a WritableFactory into any TypedWritable's make function,...
Definition: bamReader.I:275
CPT
CPT(RenderEffect) ShowBoundsEffect
Constructs a new ShowBoundsEffect object.
Definition: showBoundsEffect.cxx:25