A cuboid collision volume or object. More...

#include "collisionBox.h"

Inheritance diagram for CollisionBox:

Classes
class	PointDef
Public Types
typedef pvector< PointDef >	Points
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.
	CollisionBox (const LPoint3 &min, const LPoint3 &max)
	Create the Box by Specifying the Diagonal Points.
	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.
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 ()
virtual LPoint3	get_approx_center () const
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.
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.
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.
PN_stdfloat	get_radius () const
virtual PStatCollector &	get_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 PStatCollector &	get_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 CollisionSolid *	make_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.
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)
	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 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.
Protected Member Functions
	CollisionBox ()
	Creates an invalid Box.
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 TypedWritable *	make_CollisionBox (const FactoryParams &params)
	Factory method to generate a CollisionBox object.

Detailed Description

A cuboid collision volume or object.

Definition at line 30 of file collisionBox.h.

Constructor & Destructor Documentation

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

Referenced by 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 678 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	(	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(), and LMatrix4f::set_row().

Referenced by setup_points().

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

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

Referenced by apply_clip_plane().

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

Referenced by apply_clip_plane(), and setup_points().

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

References GeomVertexWriter::add_data3(), 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 1082 of file collisionBox.cxx.

References DatagramIterator::get_stdfloat(), 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 96 of file collisionBox.I.

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

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.

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.

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

Returns the nth face of the rectangular solid.

Definition at line 196 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 349 of file collisionBox.I.

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

Returns the nth vertex of the OBB.

Definition at line 159 of file collisionBox.I.

References LPoint3f::zero().

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

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

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

Factory method to generate a CollisionBox object.

Definition at line 1063 of file collisionBox.cxx.

References CollisionBox(), and fillin().

Referenced by register_with_read_factory().

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

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

void CollisionBox::register_with_read_factory ( ) [static]

Factory method to generate a CollisionBox object.

Definition at line 1019 of file collisionBox.cxx.

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

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

Referenced by CollisionBox(), and xform().

void CollisionBox::setup_box ( )