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

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. More...

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

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. More...

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. More...

LPoint3	legacy_to_3d (const LVecBase2 &point2d, int axis) const

virtual CollisionSolid *	make_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. 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 LVector3 &	get_effective_normal () const
	Returns the normal that was set by set_effective_normal(). More...

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. More...

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. More...

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. More...

void	cache_ref_only () const
	Decrements the cache reference count without affecting the normal reference count. More...

bool	cache_unref () const
	Explicitly decrements the cache reference count and the normal reference count simultaneously. More...

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. More...

Public Member Functions inherited from TypedWritableReferenceCount
	TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)

virtual ReferenceCount *	as_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...

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. More...

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. 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)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_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...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_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	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. 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...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

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

Public Attributes
	get_center

	get_dimensions

	get_max

	get_min

Public Attributes inherited from CollisionSolid
virtual const CullTraverserData bool bounds_only	const

virtual const CullTraverserData &	data

	get_bounds

	get_collision_origin

	get_respect_effective_normal
	See set_respect_effective_normal(). More...

	is_tangible
	Returns whether the solid is considered 'tangible' or not. More...

	set_bounds

	set_respect_effective_normal
	This is only meaningful for CollisionSolids that will be added to a traverser as colliders. More...

	set_tangible
	Sets the current state of the 'tangible' flag. More...

Public Attributes inherited from CachedTypedWritableReferenceCount
	get_cache_ref_count
	Returns the current reference count. More...

Public Attributes inherited from TypedWritableReferenceCount
static BamReader *	reader = nullptr)

Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count. More...

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.

Constructor & Destructor Documentation

◆ CollisionBox() [1/2]

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

◆ CollisionBox() [2/2]

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

inlineexplicit

Create the Box by Specifying the Diagonal Points.

Definition at line 36 of file collisionBox.I.

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

References ClipPlaneAttrib::get_num_on_planes.

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

References get_plane().

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

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

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

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

◆ flush_level()

void CollisionBox::flush_level ( )

inlinestatic

Flushes the PStatCollectors used during traversal.

Definition at line 83 of file collisionBox.I.

◆ 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 173 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 142 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 181 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 303 of file collisionBox.I.

◆ get_point()

LPoint3 CollisionBox::get_point ( int n ) const

inline

Returns the nth vertex of the OBB.

Definition at line 150 of file collisionBox.I.

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

Referenced by 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_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.

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

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

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

Referenced by init_libcollide().

◆ set_plane()

LPlane CollisionBox::set_plane ( int n ) const

inline

Creates the nth face of the rectangular solid.

Definition at line 190 of file collisionBox.I.

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

◆ 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.

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 223 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 265 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 1340 of file collisionBox.cxx.

References CollisionSolid::write_datagram().

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

panda/src/collide/collisionBox.h
panda/src/collide/collisionBox.cxx
panda/src/collide/collisionBox.I

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CollisionBox() [1/2]

◆ CollisionBox() [2/2]

Member Function Documentation

◆ apply_clip_plane()

◆ calc_to_3d_mat()

◆ clip_polygon()

◆ compute_vectors()

◆ dist_to_polygon()

◆ flush_level()

◆ get_collision_origin()

◆ get_num_planes()

◆ get_num_points()

◆ get_plane()

◆ get_plane_points()

◆ get_point()

◆ get_point_aabb()

◆ get_test_pcollector()

◆ get_volume_pcollector()

◆ point_is_inside()

◆ rederive_to_3d_mat()

◆ register_with_read_factory()

◆ set_plane()

◆ setup_box()

◆ setup_points()

◆ to_2d()

◆ to_3d()

◆ write_datagram()