Panda3D
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | 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 CollisionBox &copy)
 
 CollisionBox (const LPoint3 &center, PN_stdfloat x, PN_stdfloat y, PN_stdfloat z)
 Create the Box by giving a Center and distances of each of the sides of box from the Center.
 
 CollisionBox (const LPoint3 &min, const LPoint3 &max)
 Create the Box by Specifying the Diagonal Points.
 
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.
 
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.
 
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).
 
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.
 
void draw_polygon (GeomNode *viz_geom_node, GeomNode *bounds_viz_geom_node, const Points &points) const
 
virtual TypeHandle force_init_type ()
 
const LPoint3 & get_center () const
 
virtual LPoint3 get_collision_origin () const
 Returns the point in space deemed to be the "origin" of the solid for collision purposes.
 
LVector3 get_dimensions () const
 
const LPoint3 & get_max () const
 
const LPoint3 & get_min () const
 
int get_num_planes () const
 Returns 6: the number of faces of a rectangular solid.
 
int get_num_points () const
 Returns 8: the number of vertices of a rectangular solid.
 
LPlane get_plane (int n) const
 Returns the nth face of the rectangular solid.
 
Points get_plane_points (int n)
 returns the points that form the nth plane
 
LPoint3 get_point (int n) const
 Returns the nth vertex of the OBB.
 
LPoint3 get_point_aabb (int n) const
 Returns the nth vertex of the Axis Aligned Bounding Box.
 
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.
 
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.
 
LPoint3 legacy_to_3d (const LVecBase2 &point2d, int axis) const
 
virtual CollisionSolidmake_copy ()
 
virtual void output (std::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.
 
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.
 
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.
 
void setup_box ()
 Compute parameters for each of the box's sides.
 
void setup_points (const LPoint3 *begin, const LPoint3 *end, int plane)
 Computes the plane and 2d projection of points that make up this side.
 
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.
 
virtual void write_datagram (BamWriter *manager, Datagram &me)
 Function to write the important information in the particular object to a Datagram.
 
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().
 
 CPT (BoundingVolume) get_bounds() const
 
const LVector3 & get_effective_normal () const
 Returns the normal that was set by set_effective_normal().
 
bool get_respect_effective_normal () const
 
bool has_effective_normal () const
 Returns true if a special normal was set by set_effective_normal(), false otherwise.
 
bool is_tangible () const
 
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.
 
void set_respect_effective_normal (bool respect_effective_normal)
 
void set_tangible (bool tangible)
 
virtual void write (std::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.
 
void cache_ref_only () const
 Decrements the cache reference count without affecting the normal reference count.
 
bool cache_unref () const
 Explicitly decrements the cache reference count and the normal reference count simultaneously.
 
int get_cache_ref_count () const
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
 
- 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.
 
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().
 
vector_uchar encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object.
 
bool encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
 
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.
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter.
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
 
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.
 
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.
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
 
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.
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from MemoryBase
void operator delete (void *, void *)
 
void operator delete (void *ptr)
 
void operator delete[] (void *, void *)
 
void operator delete[] (void *ptr)
 
void * operator new (size_t size)
 
void * operator new (size_t size, void *ptr)
 
void * operator new[] (size_t size)
 
void * operator new[] (size_t size, void *ptr)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
 
void ref () const
 Explicitly increments the reference count.
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero.
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
 
virtual bool unref () const
 Explicitly decrements the reference count.
 
bool unref_if_one () const
 Atomically decreases the reference count of this object if it is one.
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object.
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object.
 

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.
 
static void flush_level ()
 Flushes the PStatCollectors used during traversal.
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
static void register_with_read_factory ()
 Factory method to generate a CollisionBox object.
 
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.
 
- 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(vector_uchar data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes.
 
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.
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_center
 
 get_dimensions
 
 get_max
 
 get_min
 
- Public Attributes inherited from CollisionSolid
virtual const CullTraverserData bool bounds_only const
 
virtual const CullTraverserDatadata
 
 get_bounds
 
 get_collision_origin
 
 get_respect_effective_normal
 See set_respect_effective_normal().
 
 is_tangible
 Returns whether the solid is considered 'tangible' or not.
 
 set_bounds
 
 set_respect_effective_normal
 This is only meaningful for CollisionSolids that will be added to a traverser as colliders.
 
 set_tangible
 Sets the current state of the 'tangible' flag.
 
- Public Attributes inherited from CachedTypedWritableReferenceCount
 get_cache_ref_count
 Returns the current reference count.
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count.
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

A cuboid collision volume or object.

Definition at line 27 of file collisionBox.h.

Member Typedef Documentation

◆ Points

Definition at line 128 of file collisionBox.h.

Constructor & Destructor Documentation

◆ CollisionBox() [1/3]

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

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

Definition at line 18 of file collisionBox.I.

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

◆ CollisionBox() [2/3]

CollisionBox::CollisionBox ( const LPoint3 & min,
const LPoint3 & max )
inlineexplicit

Create the Box by Specifying the Diagonal Points.

Definition at line 35 of file collisionBox.I.

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

◆ CollisionBox() [3/3]

CollisionBox::CollisionBox ( const CollisionBox & copy)
inline

Definition at line 61 of file collisionBox.I.

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 1046 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().

◆ 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 232 of file collisionBox.I.

References get_plane(), and get_point().

Referenced by setup_points().

◆ 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 1092 of file collisionBox.cxx.

References 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 1356 of file collisionBox.cxx.

Referenced by apply_clip_plane(), 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 1176 of file collisionBox.cxx.

◆ flush_level()

void CollisionBox::flush_level ( )
inlinestatic

Flushes the PStatCollectors used during traversal.

Definition at line 82 of file collisionBox.I.

Referenced by CollisionTraverser::traverse().

◆ force_init_type()

virtual TypeHandle CollisionBox::force_init_type ( )
inlinevirtual

Reimplemented from CollisionSolid.

Definition at line 175 of file collisionBox.h.

◆ get_class_type()

static TypeHandle CollisionBox::get_class_type ( )
inlinestatic

Definition at line 164 of file collisionBox.h.

◆ 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 162 of file collisionBox.cxx.

◆ get_num_planes()

int CollisionBox::get_num_planes ( ) const
inline

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

Definition at line 172 of file collisionBox.I.

◆ get_num_points()

int CollisionBox::get_num_points ( ) const
inline

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

Definition at line 141 of file collisionBox.I.

◆ get_plane()

LPlane CollisionBox::get_plane ( int n) const
inline

Returns the nth face of the rectangular solid.

Definition at line 180 of file collisionBox.I.

Referenced by calc_to_3d_mat(), and clip_polygon().

◆ get_plane_points()

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

returns the points that form the nth plane

Definition at line 302 of file collisionBox.I.

◆ get_point()

LPoint3 CollisionBox::get_point ( int n) const
inline

Returns the nth vertex of the OBB.

Definition at line 149 of file collisionBox.I.

Referenced by calc_to_3d_mat(), clip_polygon(), 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 159 of file collisionBox.I.

Referenced by CollisionBox(), and CollisionBox().

◆ get_test_pcollector()

PStatCollector & CollisionBox::get_test_pcollector ( )
virtual

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

Reimplemented from CollisionSolid.

Definition at line 180 of file collisionBox.cxx.

◆ get_type()

virtual TypeHandle CollisionBox::get_type ( ) const
inlinevirtual

Reimplemented from CollisionSolid.

Definition at line 172 of file collisionBox.h.

◆ 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 171 of file collisionBox.cxx.

◆ init_type()

static void CollisionBox::init_type ( )
inlinestatic

Definition at line 167 of file collisionBox.h.

◆ make_copy()

CollisionSolid * CollisionBox::make_copy ( )
virtual

Implements CollisionSolid.

Definition at line 59 of file collisionBox.cxx.

◆ output()

void CollisionBox::output ( std::ostream & out) const
virtual

Reimplemented from CollisionSolid.

Definition at line 188 of file collisionBox.cxx.

◆ 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 1333 of file collisionBox.cxx.

◆ PT()

virtual CollisionBox::PT ( CollisionEntry ) const &
virtual

Reimplemented from CollisionSolid.

◆ 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 255 of file collisionBox.I.

◆ register_with_read_factory()

void CollisionBox::register_with_read_factory ( )
static

Factory method to generate a CollisionBox object.

Definition at line 1368 of file collisionBox.cxx.

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

Referenced by init_libcollide().

◆ set_center() [1/2]

void CollisionBox::set_center ( const LPoint3 & center)
inline

Definition at line 91 of file collisionBox.I.

◆ set_center() [2/2]

void CollisionBox::set_center ( PN_stdfloat x,
PN_stdfloat y,
PN_stdfloat z )
inline

Definition at line 101 of file collisionBox.I.

◆ set_plane()

LPlane CollisionBox::set_plane ( int n) const
inline

Creates the nth face of the rectangular solid.

Definition at line 189 of file collisionBox.I.

References get_point().

Referenced by CollisionBox(), and CollisionBox().

◆ setup_box()

void CollisionBox::setup_box ( )

Compute parameters for each of the box's sides.

Definition at line 67 of file collisionBox.cxx.

References get_point(), and setup_points().

Referenced by CollisionBox(), and CollisionBox().

◆ 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 82 of file collisionBox.cxx.

References calc_to_3d_mat(), and compute_vectors().

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 222 of file collisionBox.I.

Referenced by clip_polygon().

◆ 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 264 of file collisionBox.I.

◆ write_datagram()

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

Function to write the important information in the particular object to a Datagram.

Reimplemented from CollisionSolid.

Definition at line 1377 of file collisionBox.cxx.

References Datagram::add_stdfloat(), Datagram::add_uint16(), and CollisionSolid::write_datagram().

◆ xform()

virtual void CollisionBox::xform ( const LMatrix4 & mat)
virtual

Reimplemented from CollisionSolid.

Member Data Documentation

◆ get_center

const LPoint3 & CollisionBox::get_center
inline

Definition at line 69 of file collisionBox.h.

◆ get_dimensions

LVector3 CollisionBox::get_dimensions
inline

Definition at line 72 of file collisionBox.h.

◆ get_max

const LPoint3 & CollisionBox::get_max
inline

Definition at line 71 of file collisionBox.h.

◆ get_min

const LPoint3 & CollisionBox::get_min
inline

Definition at line 70 of file collisionBox.h.


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