Panda3D
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions

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

List of all members.

Classes

class  PointDef

Public Types

typedef pvector< PointDefPoints

Public Member Functions

 CollisionBox (const LPoint3f &center, float x, float y, float z)
 Create the Box by giving a Center and distances of of each of the sides of box from the Center.
 CollisionBox (float cx, float cy, float cz, float x, float y, float z)
 Center as three separate co-ordinate points.
 CollisionBox (const CollisionBox &copy)
 CollisionBox (const LPoint3f &min, const LPoint3f &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 (LMatrix4f &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 Planef &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).
float dist_to_polygon (const LPoint2f &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 ()
virtual LPoint3f get_approx_center () const
const LPoint3fget_center () const
virtual LPoint3f get_collision_origin () const
 Returns the point in space deemed to be the "origin" of the solid for collision purposes.
virtual LPoint3f get_max () const
virtual LPoint3f 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.
Planef 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
LPoint3f get_point (int n) const
 Returns the nth vertex of the OBB.
LPoint3f get_point_aabb (int n) const
 Returns the nth vertex of the Axis Aligned Bounding Box.
float 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.
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.
LPoint3f legacy_to_3d (const LVecBase2f &point2d, int axis) const
virtual CollisionSolidmake_copy ()
virtual void output (ostream &out) const
bool point_is_inside (const LPoint2f &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 (LMatrix4f &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 (float x, float y, float z)
void set_center (const LPoint3f &center)
Planef 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 LPoint3f *begin, const LPoint3f *end, int plane)
 Computes the plane and 2d projection of points that make up this side.
LPoint2f to_2d (const LVecBase3f &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 LMatrix4f &mat)
 Transforms the solid by the indicated matrix.

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 LPoint3f to_3d (const LVecBase2f &point2d, const LMatrix4f &to_3d_mat)
 Extrude the indicated point in the polygon's 2-d definition space back into 3-d coordinates.

Protected Member Functions

 CollisionBox ()
 Creates an invalid Box.
Vertexf compute_point (float latitude, float longitude) const
 Returns a point on the surface of the sphere.
virtual void fill_viz_geom ()
 Fills the _viz_geom GeomNode up with Geoms suitable for rendering this solid.
void fillin (DatagramIterator &scan, BamReader *manager)
 Function that reads out of the datagram (or asks manager to read) all of the data that is needed to re-create this object and stores it in the appropiate place.
virtual PT (CollisionEntry) test_intersection_from_box(const CollisionEntry &entry) const
virtual PT (CollisionEntry) test_intersection_from_segment(const CollisionEntry &entry) const
virtual PT (BoundingVolume) compute_internal_bounds() const
virtual PT (CollisionEntry) test_intersection_from_ray(const CollisionEntry &entry) const
virtual PT (CollisionEntry) test_intersection_from_sphere(const CollisionEntry &entry) const

Static Protected Member Functions

static TypedWritablemake_CollisionBox (const FactoryParams &params)
 Factory method to generate a CollisionBox object.

Detailed Description

A cuboid collision volume or object.

Definition at line 29 of file collisionBox.h.


Constructor & Destructor Documentation

CollisionBox::CollisionBox ( const LPoint3f center,
float  x,
float  y,
float  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::CollisionBox ( float  cx,
float  cy,
float  cz,
float  x,
float  y,
float  z 
) [inline]

Center as three separate co-ordinate points.

Definition at line 63 of file collisionBox.I.

References CollisionBox().

CollisionBox::CollisionBox ( const LPoint3f min,
const LPoint3f max 
) [inline]

Create the Box by Specifying the Diagonal Points.

Definition at line 42 of file collisionBox.I.

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

CollisionBox::CollisionBox ( ) [inline, protected]

Creates an invalid Box.

Only used when reading from a bam file.

Definition at line 75 of file collisionBox.I.

Referenced by CollisionBox(), and make_CollisionBox().


Member Function Documentation

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

void CollisionBox::calc_to_3d_mat ( LMatrix4f 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 272 of file collisionBox.I.

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

Referenced by setup_points().

bool CollisionBox::clip_polygon ( CollisionBox::Points &  new_points,
const Points &  source_points,
const Planef &  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 727 of file collisionBox.cxx.

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

Referenced by apply_clip_plane().

Vertexf CollisionBox::compute_point ( float  latitude,
float  longitude 
) const [protected]

Returns a point on the surface of the sphere.

latitude and longitude range from 0.0 to 1.0. This is used by fill_viz_geom() to create a visible representation of the sphere.

Definition at line 1005 of file collisionBox.cxx.

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

Referenced by apply_clip_plane(), and setup_points().

float CollisionBox::dist_to_polygon ( const LPoint2f 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 815 of file collisionBox.cxx.

void CollisionBox::fill_viz_geom ( ) [protected, virtual]

Fills the _viz_geom GeomNode up with Geoms suitable for rendering this solid.

Reimplemented from CollisionSolid.

Definition at line 638 of file collisionBox.cxx.

References GeomVertexWriter::add_data3f(), get_point(), and GeomVertexFormat::get_v3().

void CollisionBox::fillin ( DatagramIterator scan,
BamReader manager 
) [protected, virtual]

Function that reads out of the datagram (or asks manager to read) all of the data that is needed to re-create this object and stores it in the appropiate place.

Reimplemented from CollisionSolid.

Definition at line 1101 of file collisionBox.cxx.

References DatagramIterator::get_float32(), DatagramIterator::get_uint16(), LVecBase2f::read_datagram(), LMatrix4f::read_datagram(), and LVecBase3f::read_datagram().

Referenced by make_CollisionBox().

void CollisionBox::flush_level ( ) [inline, static]

Flushes the PStatCollectors used during traversal.

Definition at line 107 of file collisionBox.I.

LPoint3f 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 173 of file collisionBox.cxx.

int CollisionBox::get_num_planes ( ) const [inline]

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

Definition at line 197 of file collisionBox.I.

int CollisionBox::get_num_points ( ) const [inline]

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

Definition at line 160 of file collisionBox.I.

Planef CollisionBox::get_plane ( int  n) const [inline]

Returns the nth face of the rectangular solid.

Definition at line 207 of file collisionBox.I.

Referenced by calc_to_3d_mat(), and clip_polygon().

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

returns the points that form the nth plane

Definition at line 360 of file collisionBox.I.

LPoint3f CollisionBox::get_point ( int  n) const [inline]

Returns the nth vertex of the OBB.

Definition at line 170 of file collisionBox.I.

References LPoint3f::zero().

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

LPoint3f CollisionBox::get_point_aabb ( int  n) const [inline]

Returns the nth vertex of the Axis Aligned Bounding Box.

Definition at line 182 of file collisionBox.I.

References LPoint3f::zero().

Referenced by CollisionBox().

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

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

TypedWritable * CollisionBox::make_CollisionBox ( const FactoryParams params) [static, protected]

Factory method to generate a CollisionBox object.

Definition at line 1082 of file collisionBox.cxx.

References CollisionBox(), and fillin().

Referenced by register_with_read_factory().

bool CollisionBox::point_is_inside ( const LPoint2f p,
const Points &  points 
) const

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

Definition at line 978 of file collisionBox.cxx.

void CollisionBox::rederive_to_3d_mat ( LMatrix4f 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 301 of file collisionBox.I.

References LMatrix4f::invert_from().

void CollisionBox::register_with_read_factory ( ) [static]

Factory method to generate a CollisionBox object.

Definition at line 1038 of file collisionBox.cxx.

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

Planef CollisionBox::set_plane ( int  n) const [inline]

Creates the nth face of the rectangular solid.

Definition at line 218 of file collisionBox.I.

References get_point().

Referenced by CollisionBox(), and xform().

void CollisionBox::setup_box ( )

Compute parameters for each of the box's sides.

Definition at line 71 of file collisionBox.cxx.

References get_point(), and setup_points().

Referenced by CollisionBox(), and xform().

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

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

Definition at line 89 of file collisionBox.cxx.

References calc_to_3d_mat(), compute_vectors(), and LMatrix4f::invert_from().

Referenced by setup_box().

LPoint2f CollisionBox::to_2d ( const LVecBase3f 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 259 of file collisionBox.I.

Referenced by clip_polygon().

LPoint3f CollisionBox::to_3d ( const LVecBase2f point2d,
const LMatrix4f to_3d_mat 
) [inline, static]

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

Definition at line 312 of file collisionBox.I.

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

References Datagram::add_float32(), Datagram::add_uint16(), LMatrix4f::write_datagram(), and LVecBase3f::write_datagram().

void CollisionBox::xform ( const LMatrix4f mat) [virtual]

Transforms the solid by the indicated matrix.

Reimplemented from CollisionSolid.

Definition at line 149 of file collisionBox.cxx.

References CollisionSolid::mark_internal_bounds_stale(), CollisionSolid::mark_viz_stale(), set_plane(), and setup_box().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations