Panda3D
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
CollisionBox Class Reference

A cuboid collision volume or object. More...

#include "collisionBox.h"

Inheritance diagram for CollisionBox:
CollisionSolid CopyOnWriteObject CachedTypedWritableReferenceCount TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Classes

class  PointDef
 

Public Types

typedef pvector< PointDefPoints
 

Public Member Functions

 CollisionBox (const LPoint3 &center, PN_stdfloat x, PN_stdfloat y, PN_stdfloat z)
 Create the Box by giving a Center and distances of of each of the sides of box from the Center. More...
 
 CollisionBox (const LPoint3 &min, const LPoint3 &max)
 Create the Box by Specifying the Diagonal Points. More...
 
 CollisionBox (const CollisionBox &copy)
 
bool apply_clip_plane (Points &new_points, const ClipPlaneAttrib *cpa, const TransformState *net_transform, int plane_no) const
 Clips the polygon by all of the clip planes named in the clip plane attribute and fills new_points up with the resulting points. More...
 
void calc_to_3d_mat (LMatrix4 &to_3d_mat, int plane) const
 Fills the indicated matrix with the appropriate rotation transform to move points from the 2-d plane into the 3-d (X, 0, Z) plane. More...
 
bool clip_polygon (Points &new_points, const Points &source_points, const LPlane &plane, int plane_no) const
 Clips the source_points of the polygon by the indicated clipping plane, and modifies new_points to reflect the new set of clipped points (but does not compute the vectors in new_points). More...
 
PN_stdfloat dist_to_polygon (const LPoint2 &p, const Points &points) const
 Returns the linear distance from the 2-d point to the nearest part of the polygon defined by the points vector. More...
 
void draw_polygon (GeomNode *viz_geom_node, GeomNode *bounds_viz_geom_node, const Points &points) const
 
virtual TypeHandle force_init_type ()
 
virtual LPoint3 get_approx_center () const
 
const LPoint3get_center () const
 
virtual LPoint3 get_collision_origin () const
 Returns the point in space deemed to be the "origin" of the solid for collision purposes. More...
 
virtual LPoint3 get_max () const
 
virtual LPoint3 get_min () const
 
int get_num_planes () const
 Returns 6: the number of faces of a rectangular solid. More...
 
int get_num_points () const
 Returns 8: the number of vertices of a rectangular solid. More...
 
LPlane get_plane (int n) const
 Returns the nth face of the rectangular solid. More...
 
Points get_plane_points (int n)
 returns the points that form the nth plane More...
 
LPoint3 get_point (int n) const
 Returns the nth vertex of the OBB. More...
 
LPoint3 get_point_aabb (int n) const
 Returns the nth vertex of the Axis Aligned Bounding Box. More...
 
PN_stdfloat get_radius () const
 
virtual PStatCollectorget_test_pcollector ()
 Returns a PStatCollector that is used to count the number of intersection tests made against a solid of this type in a given frame. More...
 
virtual TypeHandle get_type () const
 
virtual PStatCollectorget_volume_pcollector ()
 Returns a PStatCollector that is used to count the number of bounding volume tests made against a solid of this type in a given frame. More...
 
LPoint3 legacy_to_3d (const LVecBase2 &point2d, int axis) const
 
virtual CollisionSolidmake_copy ()
 
virtual void output (ostream &out) const
 
bool point_is_inside (const LPoint2 &p, const Points &points) const
 Returns true if the indicated point is within the polygon's 2-d space, false otherwise. More...
 
virtual PT (CollisionEntry) test_intersection(const CollisionEntry &entry) const
 
void rederive_to_3d_mat (LMatrix4 &to_3d_mat, int plane) const
 Fills the indicated matrix with the appropriate rotation transform to move points from the 2-d plane into the 3-d (X, 0, Z) plane. More...
 
void set_center (const LPoint3 &center)
 
void set_center (PN_stdfloat x, PN_stdfloat y, PN_stdfloat z)
 
LPlane set_plane (int n) const
 Creates the nth face of the rectangular solid. More...
 
void setup_box ()
 Compute parameters for each of the box's sides. More...
 
void setup_points (const LPoint3 *begin, const LPoint3 *end, int plane)
 Computes the plane and 2d projection of points that make up this side. More...
 
LPoint2 to_2d (const LVecBase3 &point3d, int plane) const
 Assuming the indicated point in 3-d space lies within the polygon's plane, returns the corresponding point in the polygon's 2-d definition space. More...
 
virtual void write_datagram (BamWriter *manager, Datagram &me)
 Function to write the important information in the particular object to a Datagram. More...
 
virtual void xform (const LMatrix4 &mat)
 
- Public Member Functions inherited from CollisionSolid
 CollisionSolid (const CollisionSolid &copy)
 
void clear_effective_normal ()
 Removes the normal previously set by set_effective_normal(). More...
 
 CPT (BoundingVolume) get_bounds() const
 
const LVector3get_effective_normal () const
 Returns the normal that was set by set_effective_normal(). More...
 
bool get_respect_effective_normal () const
 See set_respect_effective_normal(). More...
 
bool has_effective_normal () const
 Returns true if a special normal was set by set_effective_normal(), false otherwise. More...
 
bool is_tangible () const
 Returns whether the solid is considered 'tangible' or not. More...
 
virtual PT (PandaNode) get_viz(const CullTraverser *trav
 
void set_bounds (const BoundingVolume &bounding_volume)
 
void set_effective_normal (const LVector3 &effective_normal)
 Records a false normal for this CollisionSolid that will be reported by the collision system with all collisions into it, instead of its actual normal. More...
 
void set_respect_effective_normal (bool respect_effective_normal)
 This is only meaningful for CollisionSolids that will be added to a traverser as colliders. More...
 
void set_tangible (bool tangible)
 Sets the current state of the 'tangible' flag. More...
 
virtual void write (ostream &out, int indent_level=0) const
 
- Public Member Functions inherited from CopyOnWriteObject
 CopyOnWriteObject (const CopyOnWriteObject &copy)
 
void operator= (const CopyOnWriteObject &copy)
 
- Public Member Functions inherited from CachedTypedWritableReferenceCount
void cache_ref () const
 Explicitly increments the cache reference count and the normal reference count simultaneously. More...
 
bool cache_unref () const
 Explicitly decrements the cache reference count and the normal reference count simultaneously. More...
 
int get_cache_ref_count () const
 Returns the current reference count. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
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(). More...
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static void compute_vectors (Points &points)
 Now that the _p members of the given points array have been computed, go back and compute all of the _v members. More...
 
static void flush_level ()
 Flushes the PStatCollectors used during traversal. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
static void register_with_read_factory ()
 Factory method to generate a CollisionBox object. More...
 
static LPoint3 to_3d (const LVecBase2 &point2d, const LMatrix4 &to_3d_mat)
 Extrude the indicated point in the polygon's 2-d definition space back into 3-d coordinates. More...
 
- Static Public Member Functions inherited from CollisionSolid
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from CopyOnWriteObject
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from CachedTypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Additional Inherited Members

- Public Attributes inherited from CollisionSolid
virtual const CullTraverserData bool bounds_only const
 
virtual const CullTraverserDatadata
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

Detailed Description

A cuboid collision volume or object.

Definition at line 30 of file collisionBox.h.

Constructor & Destructor Documentation

◆ CollisionBox() [1/2]

CollisionBox::CollisionBox ( const LPoint3 center,
PN_stdfloat  x,
PN_stdfloat  y,
PN_stdfloat  z 
)
inline

Create the Box by giving a Center and distances of of each of the sides of box from the Center.

Definition at line 23 of file collisionBox.I.

References get_point_aabb(), set_plane(), and setup_box().

◆ CollisionBox() [2/2]

CollisionBox::CollisionBox ( const LPoint3 min,
const LPoint3 max 
)
inline

Create the Box by Specifying the Diagonal Points.

Definition at line 42 of file collisionBox.I.

References flush_level(), get_point_aabb(), set_plane(), and setup_box().

Member Function Documentation

◆ apply_clip_plane()

bool CollisionBox::apply_clip_plane ( CollisionBox::Points new_points,
const ClipPlaneAttrib cpa,
const TransformState *  net_transform,
int  plane_no 
) const

Clips the polygon by all of the clip planes named in the clip plane attribute and fills new_points up with the resulting points.

The return value is true if the set of points is unmodified (all points are behind all the clip planes), or false otherwise.

Definition at line 714 of file collisionBox.cxx.

References clip_polygon(), compute_vectors(), PlaneNode::get_clip_effect(), ClipPlaneAttrib::get_num_on_planes(), ClipPlaneAttrib::get_on_plane(), PlaneNode::get_plane(), and NodePath::node().

Referenced by get_test_pcollector().

◆ calc_to_3d_mat()

void CollisionBox::calc_to_3d_mat ( LMatrix4 to_3d_mat,
int  plane 
) const
inline

Fills the indicated matrix with the appropriate rotation transform to move points from the 2-d plane into the 3-d (X, 0, Z) plane.

Definition at line 261 of file collisionBox.I.

References get_plane(), get_point(), rederive_to_3d_mat(), and LMatrix4f::set_row().

Referenced by setup_points(), and to_2d().

◆ clip_polygon()

bool CollisionBox::clip_polygon ( CollisionBox::Points new_points,
const Points source_points,
const LPlane &  plane,
int  plane_no 
) const

Clips the source_points of the polygon by the indicated clipping plane, and modifies new_points to reflect the new set of clipped points (but does not compute the vectors in new_points).

The return value is true if the set of points is unmodified (all points are behind the clip plane), or false otherwise.

Definition at line 764 of file collisionBox.cxx.

References dist_to_polygon(), get_plane(), get_point(), and to_2d().

Referenced by apply_clip_plane().

◆ compute_vectors()

void CollisionBox::compute_vectors ( Points points)
static

Now that the _p members of the given points array have been computed, go back and compute all of the _v members.

Definition at line 1041 of file collisionBox.cxx.

References register_with_read_factory().

Referenced by apply_clip_plane(), point_is_inside(), and setup_points().

◆ dist_to_polygon()

PN_stdfloat CollisionBox::dist_to_polygon ( const LPoint2 p,
const Points points 
) const

Returns the linear distance from the 2-d point to the nearest part of the polygon defined by the points vector.

The result is negative if the point is within the polygon.

Definition at line 852 of file collisionBox.cxx.

References LVecBase2f::length(), and point_is_inside().

Referenced by clip_polygon(), and get_test_pcollector().

◆ flush_level()

void CollisionBox::flush_level ( )
inlinestatic

Flushes the PStatCollectors used during traversal.

Definition at line 96 of file collisionBox.I.

References get_num_points().

Referenced by CollisionTraverser::clear_colliders(), and CollisionBox().

◆ get_collision_origin()

LPoint3 CollisionBox::get_collision_origin ( ) const
virtual

Returns the point in space deemed to be the "origin" of the solid for collision purposes.

The closest intersection point to this origin point is considered to be the most significant.

Implements CollisionSolid.

Definition at line 174 of file collisionBox.cxx.

References get_volume_pcollector().

Referenced by setup_points().

◆ get_num_planes()

int CollisionBox::get_num_planes ( ) const
inline

Returns 6: the number of faces of a rectangular solid.

Definition at line 186 of file collisionBox.I.

References get_plane().

Referenced by get_point_aabb().

◆ get_num_points()

int CollisionBox::get_num_points ( ) const
inline

Returns 8: the number of vertices of a rectangular solid.

Definition at line 149 of file collisionBox.I.

References get_point().

Referenced by flush_level().

◆ get_plane()

LPlane CollisionBox::get_plane ( int  n) const
inline

Returns the nth face of the rectangular solid.

Definition at line 196 of file collisionBox.I.

References set_plane().

Referenced by calc_to_3d_mat(), clip_polygon(), get_num_planes(), and get_test_pcollector().

◆ get_plane_points()

CollisionBox::Points CollisionBox::get_plane_points ( int  n)
inline

returns the points that form the nth plane

Definition at line 349 of file collisionBox.I.

Referenced by to_3d().

◆ get_point()

LPoint3 CollisionBox::get_point ( int  n) const
inline

Returns the nth vertex of the OBB.

Definition at line 159 of file collisionBox.I.

References get_point_aabb(), and LPoint3f::zero().

Referenced by calc_to_3d_mat(), clip_polygon(), get_num_points(), set_plane(), and setup_box().

◆ get_point_aabb()

LPoint3 CollisionBox::get_point_aabb ( int  n) const
inline

Returns the nth vertex of the Axis Aligned Bounding Box.

Definition at line 171 of file collisionBox.I.

References get_num_planes(), and LPoint3f::zero().

Referenced by CollisionBox(), and get_point().

◆ get_test_pcollector()

PStatCollector & CollisionBox::get_test_pcollector ( )
virtual

◆ get_volume_pcollector()

PStatCollector & CollisionBox::get_volume_pcollector ( )
virtual

Returns a PStatCollector that is used to count the number of bounding volume tests made against a solid of this type in a given frame.

Reimplemented from CollisionSolid.

Definition at line 216 of file collisionBox.cxx.

References get_test_pcollector().

Referenced by get_collision_origin().

◆ point_is_inside()

bool CollisionBox::point_is_inside ( const LPoint2 p,
const Points points 
) const

Returns true if the indicated point is within the polygon's 2-d space, false otherwise.

Definition at line 1015 of file collisionBox.cxx.

References compute_vectors().

Referenced by dist_to_polygon(), and get_test_pcollector().

◆ rederive_to_3d_mat()

void CollisionBox::rederive_to_3d_mat ( LMatrix4 to_3d_mat,
int  plane 
) const
inline

Fills the indicated matrix with the appropriate rotation transform to move points from the 2-d plane into the 3-d (X, 0, Z) plane.

This is essentially similar to calc_to_3d_mat, except that the matrix is rederived from whatever is stored in _to_2d_mat, guaranteeing that it will match whatever algorithm produced that one, even if it was produced on a different machine with different numerical precision.

Definition at line 290 of file collisionBox.I.

References LMatrix4f::invert_from(), and to_3d().

Referenced by calc_to_3d_mat().

◆ register_with_read_factory()

void CollisionBox::register_with_read_factory ( )
static

Factory method to generate a CollisionBox object.

Definition at line 1055 of file collisionBox.cxx.

References BamReader::get_factory(), Factory< Type >::register_factory(), and write_datagram().

Referenced by compute_vectors().

◆ set_plane()

LPlane CollisionBox::set_plane ( int  n) const
inline

Creates the nth face of the rectangular solid.

Definition at line 207 of file collisionBox.I.

References get_point(), and to_2d().

Referenced by CollisionBox(), get_plane(), and setup_points().

◆ setup_box()

void CollisionBox::setup_box ( )

Compute parameters for each of the box's sides.

Definition at line 68 of file collisionBox.cxx.

References get_point(), and setup_points().

Referenced by CollisionBox(), and setup_points().

◆ setup_points()

void CollisionBox::setup_points ( const LPoint3 begin,
const LPoint3 end,
int  plane 
)

Computes the plane and 2d projection of points that make up this side.

Definition at line 86 of file collisionBox.cxx.

References calc_to_3d_mat(), compute_vectors(), get_collision_origin(), CollisionEntry::get_into(), LMatrix4f::invert_from(), set_plane(), and setup_box().

Referenced by setup_box().

◆ to_2d()

LPoint2 CollisionBox::to_2d ( const LVecBase3 point3d,
int  plane 
) const
inline

Assuming the indicated point in 3-d space lies within the polygon's plane, returns the corresponding point in the polygon's 2-d definition space.

Definition at line 248 of file collisionBox.I.

References calc_to_3d_mat().

Referenced by clip_polygon(), get_test_pcollector(), and set_plane().

◆ to_3d()

LPoint3 CollisionBox::to_3d ( const LVecBase2 point2d,
const LMatrix4 to_3d_mat 
)
inlinestatic

Extrude the indicated point in the polygon's 2-d definition space back into 3-d coordinates.

Definition at line 301 of file collisionBox.I.

References get_plane_points().

Referenced by rederive_to_3d_mat().

◆ write_datagram()

void CollisionBox::write_datagram ( BamWriter manager,
Datagram me 
)
virtual

The documentation for this class was generated from the following files: