Panda3D
collisionNode.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 collisionNode.h
10  * @author drose
11  * @date 2002-03-16
12  */
13 
14 #ifndef COLLISIONNODE_H
15 #define COLLISIONNODE_H
16 
17 #include "pandabase.h"
18 
19 #include "collisionSolid.h"
20 
21 #include "collideMask.h"
22 #include "pandaNode.h"
23 
24 /**
25  * A node in the scene graph that can hold any number of CollisionSolids.
26  * This may either represent a bit of static geometry in the scene that things
27  * will collide with, or an animated object twirling around in the world and
28  * running into things.
29  */
30 class EXPCL_PANDA_COLLIDE CollisionNode : public PandaNode {
31 PUBLISHED:
32  explicit CollisionNode(const std::string &name);
33 
34 protected:
35  CollisionNode(const CollisionNode &copy);
36 
37 public:
38  virtual ~CollisionNode();
39  virtual PandaNode *make_copy() const;
40  virtual bool preserve_name() const;
41  virtual void xform(const LMatrix4 &mat);
42  virtual PandaNode *combine_with(PandaNode *other);
43  virtual CollideMask get_legal_collide_mask() const;
44 
45  virtual bool cull_callback(CullTraverser *trav, CullTraverserData &data);
46  virtual bool is_renderable() const;
47  virtual bool is_collision_node() const;
48 
49  virtual void output(std::ostream &out) const;
50 
51 PUBLISHED:
52  INLINE void set_collide_mask(CollideMask mask);
53  void set_from_collide_mask(CollideMask mask);
54  INLINE void set_into_collide_mask(CollideMask mask);
55  INLINE CollideMask get_from_collide_mask() const;
56  INLINE CollideMask get_into_collide_mask() const;
57 
58  MAKE_PROPERTY(from_collide_mask, get_from_collide_mask,
59  set_from_collide_mask);
60  MAKE_PROPERTY(into_collide_mask, get_into_collide_mask,
61  set_into_collide_mask);
62 
63  INLINE void clear_solids();
64  INLINE size_t get_num_solids() const;
65  INLINE CPT(CollisionSolid) get_solid(size_t n) const;
66  MAKE_SEQ(get_solids, get_num_solids, get_solid);
67  INLINE PT(CollisionSolid) modify_solid(size_t n);
68  INLINE void set_solid(size_t n, CollisionSolid *solid);
69  INLINE void insert_solid(size_t n, const CollisionSolid *solid);
70  INLINE void remove_solid(size_t n);
71  INLINE size_t add_solid(const CollisionSolid *solid);
72  MAKE_SEQ_PROPERTY(solids, get_num_solids, get_solid, set_solid, remove_solid, insert_solid);
73 
74  INLINE int get_collider_sort() const;
75  INLINE void set_collider_sort(int sort);
76  MAKE_PROPERTY(collider_sort, get_collider_sort, set_collider_sort);
77 
78  INLINE static CollideMask get_default_collide_mask();
79  MAKE_PROPERTY(default_collide_mask, get_default_collide_mask);
80 
81 protected:
82  virtual void compute_internal_bounds(CPT(BoundingVolume) &internal_bounds,
83  int &internal_vertices,
84  int pipeline_stage,
85  Thread *current_thread) const;
86 
87 private:
88  CPT(RenderState) get_last_pos_state();
89 
90  // This data is not cycled, for now. We assume the collision traversal will
91  // take place in App only. Perhaps we will revisit this later.
92  CollideMask _from_collide_mask;
93  int _collider_sort;
94 
95  typedef pvector< COWPT(CollisionSolid) > Solids;
96  Solids _solids;
97 
98  friend class CollisionTraverser;
99 
100 public:
101  static void register_with_read_factory();
102  virtual void write_datagram(BamWriter *manager, Datagram &dg);
103  virtual int complete_pointers(TypedWritable **plist, BamReader *manager);
104 
105 protected:
106  static TypedWritable *make_from_bam(const FactoryParams &params);
107  void fillin(DatagramIterator &scan, BamReader *manager);
108 
109 public:
110  static TypeHandle get_class_type() {
111  return _type_handle;
112  }
113  static void init_type() {
114  PandaNode::init_type();
115  register_type(_type_handle, "CollisionNode",
116  PandaNode::get_class_type());
117  }
118  virtual TypeHandle get_type() const {
119  return get_class_type();
120  }
121  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
122 
123 private:
124  static TypeHandle _type_handle;
125 };
126 
127 #include "collisionNode.I"
128 
129 #endif
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
virtual bool preserve_name() const
Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operatio...
Definition: pandaNode.cxx:262
A basic node of the scene graph or data graph.
Definition: pandaNode.h:64
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: pandaNode.cxx:3589
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
virtual PandaNode * combine_with(PandaNode *other)
Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined...
Definition: pandaNode.cxx:325
The abstract base class for all things that can collide with other things in the world,...
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.
This collects together the pieces of data that are accumulated for each node while walking the scene ...
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
static void register_with_read_factory()
Tells the BamReader how to create objects of type PandaNode.
Definition: pandaNode.cxx:3580
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
This is our own Panda specialization on the default STL vector.
Definition: pvector.h:42
This is an abstract class for any volume in any sense which can be said to define the locality of ref...
virtual void xform(const LMatrix4 &mat)
Transforms the contents of this PandaNode by the indicated matrix, if it means anything to do so.
Definition: pandaNode.cxx:310
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
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().
virtual bool is_collision_node() const
A simple downcast check.
Definition: pandaNode.cxx:2092
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:36
set_into_collide_mask
Sets the "into" CollideMask.
Definition: pandaNode.h:264
virtual PandaNode * make_copy() const
Returns a newly-allocated PandaNode that is a shallow copy of this one.
Definition: pandaNode.cxx:487
This represents a unique collection of RenderAttrib objects that correspond to a particular renderabl...
Definition: renderState.h:47
A thread; that is, a lightweight process.
Definition: thread.h:46
A node in the scene graph that can hold any number of CollisionSolids.
Definition: collisionNode.h:30
A class to retrieve the individual data elements previously stored in a Datagram.
This class manages the traversal through the scene graph to detect collisions.
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
virtual bool is_renderable() const
Returns true if there is some value to visiting this particular node during the cull traversal for an...
Definition: pandaNode.cxx:468
This object performs a depth-first traversal of the scene graph, with optional view-frustum culling,...
Definition: cullTraverser.h:45