Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
BoundingVolume Class Reference

This is an abstract class for any volume in any sense which can be said to define the locality of reference of a node in a graph, along with all of its descendants. More...

#include "boundingVolume.h"

Inheritance diagram for BoundingVolume:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase GeometricBoundingVolume BoundingLine BoundingPlane FiniteBoundingVolume IntersectionBoundingVolume OmniBoundingVolume UnionBoundingVolume BoundingBox BoundingHexahedron BoundingSphere

List of all members.

Public Types

enum  BoundsType { BT_default, BT_best, BT_sphere, BT_box }
enum  IntersectionFlags {
  IF_no_intersection = 0, IF_possible = 0x01, IF_some = 0x02, IF_all = 0x04,
  IF_dont_understand = 0x08
}

Public Member Functions

bool around (const BoundingVolume **first, const BoundingVolume **last)
 Resets the volume to enclose only the volumes indicated.
virtual const BoundingBoxas_bounding_box () const
 Virtual downcast method.
virtual const BoundingHexahedronas_bounding_hexahedron () const
 Virtual downcast method.
virtual const BoundingLineas_bounding_line () const
 Virtual downcast method.
virtual const BoundingPlaneas_bounding_plane () const
 Virtual downcast method.
virtual const BoundingSphereas_bounding_sphere () const
 Virtual downcast method.
virtual const
FiniteBoundingVolume
as_finite_bounding_volume () const
 Virtual downcast method.
virtual const
GeometricBoundingVolume
as_geometric_bounding_volume () const
 Virtual downcast method.
int contains (const BoundingVolume *vol) const
 Returns the appropriate set of IntersectionFlags to indicate the amount of intersection with the indicated volume.
bool extend_by (const BoundingVolume *vol)
 Increases the size of the volume to include the given volume.
virtual TypeHandle force_init_type ()
virtual TypeHandle get_type () const
bool is_empty () const
 Any kind of volume might be empty.
bool is_infinite () const
 The other side of the empty coin is an infinite volume.
virtual BoundingVolumemake_copy () const =0
virtual void output (ostream &out) const =0
void set_infinite ()
 Marks the volume as infinite, even if it is normally finite.
virtual void write (ostream &out, int indent_level=0) const

Static Public Member Functions

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 BoundsType string_bounds_type (const string &str)
 Returns the BoundsType corresponding to the indicated string.

Protected Types

enum  Flags { F_empty = 0x01, F_infinite = 0x02 }

Protected Member Functions

virtual bool around_boxes (const BoundingVolume **first, const BoundingVolume **last)
 Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty box.
virtual bool around_finite (const BoundingVolume **first, const BoundingVolume **last)
 Generic handler for a FiniteBoundingVolume.
virtual bool around_geometric (const BoundingVolume **first, const BoundingVolume **last)
 Generic handler for a GeometricBoundingVolume.
virtual bool around_hexahedrons (const BoundingVolume **first, const BoundingVolume **last)
 Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty hexahedron.
virtual bool around_intersections (const BoundingVolume **first, const BoundingVolume **last)
 Double-dispatch support: called by around_other() when the type of the first element in the list is known to be an intersection object.
virtual bool around_lines (const BoundingVolume **first, const BoundingVolume **last)
 Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty line.
virtual bool around_other (BoundingVolume *other, const BoundingVolume **first, const BoundingVolume **last) const =0
virtual bool around_planes (const BoundingVolume **first, const BoundingVolume **last)
 Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty plane.
virtual bool around_spheres (const BoundingVolume **first, const BoundingVolume **last)
 Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty sphere.
virtual bool around_unions (const BoundingVolume **first, const BoundingVolume **last)
 Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a union object.
virtual int contains_box (const BoundingBox *box) const
 Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a box.
virtual int contains_finite (const FiniteBoundingVolume *volume) const
 Generic handler for a FiniteBoundingVolume.
virtual int contains_geometric (const GeometricBoundingVolume *volume) const
 Generic handler for a GeometricBoundingVolume.
virtual int contains_hexahedron (const BoundingHexahedron *hexahedron) const
 Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a hexahedron.
virtual int contains_intersection (const IntersectionBoundingVolume *intersection) const
 Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be an intersection object.
virtual int contains_line (const BoundingLine *line) const
 Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a line.
virtual int contains_other (const BoundingVolume *other) const =0
virtual int contains_plane (const BoundingPlane *plane) const
 Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a plane.
virtual int contains_sphere (const BoundingSphere *sphere) const
 Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a sphere.
virtual int contains_union (const UnionBoundingVolume *unionv) const
 Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a union object.
virtual bool extend_by_box (const BoundingBox *box)
 Double-dispatch support: called by extend_other() when the type we're extending by is known to be a box.
virtual bool extend_by_finite (const FiniteBoundingVolume *volume)
 Generic handler for a FiniteBoundingVolume.
virtual bool extend_by_geometric (const GeometricBoundingVolume *volume)
 Generic handler for a GeometricBoundingVolume.
virtual bool extend_by_hexahedron (const BoundingHexahedron *hexahedron)
 Double-dispatch support: called by extend_other() when the type we're extending by is known to be a hexahedron.
virtual bool extend_by_intersection (const IntersectionBoundingVolume *intersection)
 Double-dispatch support: called by extend_other() when the type we're extending by is known to be a intersection.
virtual bool extend_by_line (const BoundingLine *line)
 Double-dispatch support: called by extend_other() when the type we're extending by is known to be a line.
virtual bool extend_by_plane (const BoundingPlane *plane)
 Double-dispatch support: called by extend_other() when the type we're extending by is known to be a plane.
virtual bool extend_by_sphere (const BoundingSphere *sphere)
 Double-dispatch support: called by extend_other() when the type we're extending by is known to be a sphere.
virtual bool extend_by_union (const UnionBoundingVolume *unionv)
 Double-dispatch support: called by extend_other() when the type we're extending by is known to be a union.
virtual bool extend_other (BoundingVolume *other) const =0

Protected Attributes

int _flags

Friends

class BoundingBox
class BoundingHexahedron
class BoundingLine
class BoundingPlane
class BoundingSphere
class IntersectionBoundingVolume
class UnionBoundingVolume

Detailed Description

This is an abstract class for any volume in any sense which can be said to define the locality of reference of a node in a graph, along with all of its descendants.

It is not necessarily a geometric volume (although see GeometricBoundingVolume); this is simply an abstract interface for bounds of any sort.

Definition at line 45 of file boundingVolume.h.


Member Function Documentation

bool BoundingVolume::around ( const BoundingVolume **  first,
const BoundingVolume **  last 
)

Resets the volume to enclose only the volumes indicated.

Returns true if successful, false if the volume doesn't know how to do that or can't do that.

Definition at line 33 of file boundingVolume.cxx.

References is_empty().

Referenced by PGItem::compute_internal_bounds(), CollisionNode::compute_internal_bounds(), LODNode::compute_internal_bounds(), and GeomNode::compute_internal_bounds().

bool BoundingVolume::around_boxes ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty box.

Reimplemented in OmniBoundingVolume.

Definition at line 316 of file boundingVolume.cxx.

References around_finite().

bool BoundingVolume::around_finite ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Generic handler for a FiniteBoundingVolume.

Reimplemented in BoundingBox, and BoundingSphere.

Definition at line 386 of file boundingVolume.cxx.

References around_geometric().

Referenced by around_boxes(), around_hexahedrons(), and around_spheres().

bool BoundingVolume::around_geometric ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Generic handler for a GeometricBoundingVolume.

Reimplemented in UnionBoundingVolume.

Definition at line 396 of file boundingVolume.cxx.

Referenced by around_finite(), around_intersections(), around_lines(), around_planes(), and around_unions().

bool BoundingVolume::around_hexahedrons ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty hexahedron.

Reimplemented in OmniBoundingVolume.

Definition at line 328 of file boundingVolume.cxx.

References around_finite().

bool BoundingVolume::around_intersections ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Double-dispatch support: called by around_other() when the type of the first element in the list is known to be an intersection object.

Definition at line 376 of file boundingVolume.cxx.

References around_geometric().

bool BoundingVolume::around_lines ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty line.

Reimplemented in FiniteBoundingVolume.

Definition at line 340 of file boundingVolume.cxx.

References around_geometric().

bool BoundingVolume::around_planes ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty plane.

Reimplemented in FiniteBoundingVolume.

Definition at line 352 of file boundingVolume.cxx.

References around_geometric().

bool BoundingVolume::around_spheres ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a nonempty sphere.

Reimplemented in OmniBoundingVolume.

Definition at line 304 of file boundingVolume.cxx.

References around_finite().

bool BoundingVolume::around_unions ( const BoundingVolume **  first,
const BoundingVolume **  last 
) [protected, virtual]

Double-dispatch support: called by around_other() when the type of the first element in the list is known to be a union object.

Definition at line 364 of file boundingVolume.cxx.

References around_geometric().

const BoundingBox * BoundingVolume::as_bounding_box ( ) const [virtual]

Virtual downcast method.

Returns this object as a pointer of the indicated type, if it is in fact that type. Returns NULL if it is not that type.

Reimplemented in BoundingBox.

Definition at line 125 of file boundingVolume.cxx.

Virtual downcast method.

Returns this object as a pointer of the indicated type, if it is in fact that type. Returns NULL if it is not that type.

Reimplemented in BoundingHexahedron.

Definition at line 137 of file boundingVolume.cxx.

const BoundingLine * BoundingVolume::as_bounding_line ( ) const [virtual]

Virtual downcast method.

Returns this object as a pointer of the indicated type, if it is in fact that type. Returns NULL if it is not that type.

Reimplemented in BoundingLine.

Definition at line 149 of file boundingVolume.cxx.

const BoundingPlane * BoundingVolume::as_bounding_plane ( ) const [virtual]

Virtual downcast method.

Returns this object as a pointer of the indicated type, if it is in fact that type. Returns NULL if it is not that type.

Reimplemented in BoundingPlane.

Definition at line 161 of file boundingVolume.cxx.

Virtual downcast method.

Returns this object as a pointer of the indicated type, if it is in fact that type. Returns NULL if it is not that type.

Reimplemented in BoundingSphere.

Definition at line 113 of file boundingVolume.cxx.

Virtual downcast method.

Returns this object as a pointer of the indicated type, if it is in fact that type. Returns NULL if it is not that type.

Reimplemented in FiniteBoundingVolume.

Definition at line 101 of file boundingVolume.cxx.

Virtual downcast method.

Returns this object as a pointer of the indicated type, if it is in fact that type. Returns NULL if it is not that type.

Reimplemented in GeometricBoundingVolume.

Definition at line 89 of file boundingVolume.cxx.

int BoundingVolume::contains ( const BoundingVolume vol) const [inline]

Returns the appropriate set of IntersectionFlags to indicate the amount of intersection with the indicated volume.

Definition at line 101 of file boundingVolume.I.

References is_empty(), and is_infinite().

Referenced by UnionBoundingVolume::filter_intersection(), IntersectionBoundingVolume::other_contains_intersection(), and UnionBoundingVolume::other_contains_union().

int BoundingVolume::contains_box ( const BoundingBox box) const [protected, virtual]

Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a box.

Reimplemented in BoundingBox, BoundingHexahedron, BoundingSphere, UnionBoundingVolume, IntersectionBoundingVolume, BoundingLine, OmniBoundingVolume, and BoundingPlane.

Definition at line 423 of file boundingVolume.cxx.

References contains_finite().

int BoundingVolume::contains_finite ( const FiniteBoundingVolume volume) const [protected, virtual]

Generic handler for a FiniteBoundingVolume.

Reimplemented in BoundingBox, UnionBoundingVolume, and IntersectionBoundingVolume.

Definition at line 493 of file boundingVolume.cxx.

References contains_geometric().

Referenced by contains_box(), contains_hexahedron(), and contains_sphere().

int BoundingVolume::contains_geometric ( const GeometricBoundingVolume volume) const [protected, virtual]

Generic handler for a GeometricBoundingVolume.

Reimplemented in UnionBoundingVolume, and IntersectionBoundingVolume.

Definition at line 503 of file boundingVolume.cxx.

Referenced by contains_finite(), contains_line(), and contains_plane().

int BoundingVolume::contains_hexahedron ( const BoundingHexahedron hexahedron) const [protected, virtual]

Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a hexahedron.

Reimplemented in BoundingBox, BoundingHexahedron, BoundingSphere, UnionBoundingVolume, IntersectionBoundingVolume, BoundingPlane, and OmniBoundingVolume.

Definition at line 435 of file boundingVolume.cxx.

References contains_finite().

int BoundingVolume::contains_intersection ( const IntersectionBoundingVolume intersection) const [protected, virtual]

Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be an intersection object.

Reimplemented in UnionBoundingVolume, and IntersectionBoundingVolume.

Definition at line 483 of file boundingVolume.cxx.

References IntersectionBoundingVolume::other_contains_intersection().

int BoundingVolume::contains_line ( const BoundingLine line) const [protected, virtual]

Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a line.

Reimplemented in BoundingBox, BoundingSphere, UnionBoundingVolume, IntersectionBoundingVolume, and BoundingPlane.

Definition at line 447 of file boundingVolume.cxx.

References contains_geometric().

int BoundingVolume::contains_plane ( const BoundingPlane plane) const [protected, virtual]

Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a plane.

Reimplemented in BoundingBox, BoundingSphere, UnionBoundingVolume, IntersectionBoundingVolume, and BoundingPlane.

Definition at line 459 of file boundingVolume.cxx.

References contains_geometric().

int BoundingVolume::contains_sphere ( const BoundingSphere sphere) const [protected, virtual]

Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a sphere.

Reimplemented in BoundingHexahedron, BoundingSphere, UnionBoundingVolume, IntersectionBoundingVolume, BoundingLine, OmniBoundingVolume, and BoundingPlane.

Definition at line 411 of file boundingVolume.cxx.

References contains_finite().

Referenced by BoundingSphere::contains_box().

int BoundingVolume::contains_union ( const UnionBoundingVolume unionv) const [protected, virtual]

Double-dispatch support: called by contains_other() when the type we're testing for intersection is known to be a union object.

Reimplemented in UnionBoundingVolume, and IntersectionBoundingVolume.

Definition at line 471 of file boundingVolume.cxx.

References UnionBoundingVolume::other_contains_union().

bool BoundingVolume::extend_by ( const BoundingVolume vol) [inline]

Increases the size of the volume to include the given volume.

Definition at line 79 of file boundingVolume.I.

References is_empty(), is_infinite(), and set_infinite().

bool BoundingVolume::extend_by_box ( const BoundingBox box) [protected, virtual]

Double-dispatch support: called by extend_other() when the type we're extending by is known to be a box.

Reimplemented in BoundingBox, BoundingSphere, and OmniBoundingVolume.

Definition at line 209 of file boundingVolume.cxx.

References extend_by_finite().

bool BoundingVolume::extend_by_finite ( const FiniteBoundingVolume volume) [protected, virtual]

Generic handler for a FiniteBoundingVolume.

Reimplemented in BoundingBox, and BoundingSphere.

Definition at line 279 of file boundingVolume.cxx.

References extend_by_geometric().

Referenced by extend_by_box(), extend_by_hexahedron(), and extend_by_sphere().

bool BoundingVolume::extend_by_geometric ( const GeometricBoundingVolume volume) [protected, virtual]
bool BoundingVolume::extend_by_hexahedron ( const BoundingHexahedron hexahedron) [protected, virtual]

Double-dispatch support: called by extend_other() when the type we're extending by is known to be a hexahedron.

Reimplemented in BoundingSphere, and OmniBoundingVolume.

Definition at line 221 of file boundingVolume.cxx.

References extend_by_finite().

bool BoundingVolume::extend_by_intersection ( const IntersectionBoundingVolume intersection) [protected, virtual]

Double-dispatch support: called by extend_other() when the type we're extending by is known to be a intersection.

Definition at line 269 of file boundingVolume.cxx.

References extend_by_geometric().

bool BoundingVolume::extend_by_line ( const BoundingLine line) [protected, virtual]

Double-dispatch support: called by extend_other() when the type we're extending by is known to be a line.

Reimplemented in BoundingLine.

Definition at line 233 of file boundingVolume.cxx.

References extend_by_geometric().

bool BoundingVolume::extend_by_plane ( const BoundingPlane plane) [protected, virtual]

Double-dispatch support: called by extend_other() when the type we're extending by is known to be a plane.

Reimplemented in BoundingPlane.

Definition at line 245 of file boundingVolume.cxx.

References extend_by_geometric().

bool BoundingVolume::extend_by_sphere ( const BoundingSphere sphere) [protected, virtual]

Double-dispatch support: called by extend_other() when the type we're extending by is known to be a sphere.

Reimplemented in BoundingSphere, and OmniBoundingVolume.

Definition at line 197 of file boundingVolume.cxx.

References extend_by_finite().

bool BoundingVolume::extend_by_union ( const UnionBoundingVolume unionv) [protected, virtual]

Double-dispatch support: called by extend_other() when the type we're extending by is known to be a union.

Definition at line 257 of file boundingVolume.cxx.

References extend_by_geometric().

static void BoundingVolume::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedReferenceCount.

Reimplemented in BoundingHexahedron, BoundingBox, UnionBoundingVolume, BoundingSphere, IntersectionBoundingVolume, BoundingLine, BoundingPlane, GeometricBoundingVolume, OmniBoundingVolume, and FiniteBoundingVolume.

Definition at line 187 of file boundingVolume.h.

References TypedReferenceCount::init_type().

Referenced by GeometricBoundingVolume::init_type().

bool BoundingVolume::is_empty ( ) const [inline]

Any kind of volume might be empty.

This is a degenerate volume that contains no points; it's not the same as, for instance, a sphere with radius zero, since that contains one point (the center). It intersects with no other volumes.

Definition at line 35 of file boundingVolume.I.

Referenced by UnionBoundingVolume::add_component(), IntersectionBoundingVolume::add_component(), around(), GeometricBoundingVolume::contains(), contains(), BoundingPlane::contains_box(), BoundingLine::contains_box(), BoundingHexahedron::contains_box(), BoundingBox::contains_box(), BoundingBox::contains_finite(), BoundingPlane::contains_hexahedron(), BoundingHexahedron::contains_hexahedron(), BoundingSphere::contains_lineseg(), BoundingHexahedron::contains_lineseg(), BoundingBox::contains_lineseg(), BoundingSphere::contains_point(), BoundingHexahedron::contains_point(), BoundingBox::contains_point(), BoundingPlane::contains_sphere(), BoundingLine::contains_sphere(), BoundingSphere::contains_sphere(), BoundingHexahedron::contains_sphere(), extend_by(), BoundingSphere::extend_by_box(), BoundingBox::extend_by_box(), BoundingSphere::extend_by_finite(), BoundingBox::extend_by_finite(), BoundingSphere::extend_by_hexahedron(), BoundingLine::extend_by_line(), BoundingPlane::extend_by_plane(), BoundingSphere::extend_by_point(), BoundingBox::extend_by_point(), BoundingSphere::extend_by_sphere(), BoundingBox::get_maxq(), BoundingBox::get_minq(), BoundingLine::get_point_a(), BoundingLine::get_point_b(), and SceneGraphReducer::r_flatten().

bool BoundingVolume::is_infinite ( ) const [inline]

The other side of the empty coin is an infinite volume.

This is a degenerate state of a normally finite volume that contains all points. (Note that some kinds of infinite bounding volumes, like binary separating planes, do not contain all points and thus correctly return is_infinite() == false, even though they are technically infinite. This is a special case of the word 'infinite' meaning the volume covers all points in space.)

It completely intersects with all other volumes except empty volumes.

Definition at line 56 of file boundingVolume.I.

Referenced by UnionBoundingVolume::add_component(), IntersectionBoundingVolume::add_component(), contains(), BoundingPlane::contains_box(), BoundingLine::contains_box(), BoundingBox::contains_box(), BoundingBox::contains_finite(), BoundingPlane::contains_hexahedron(), BoundingSphere::contains_lineseg(), BoundingHexahedron::contains_lineseg(), BoundingBox::contains_lineseg(), BoundingSphere::contains_point(), BoundingHexahedron::contains_point(), BoundingBox::contains_point(), BoundingPlane::contains_sphere(), BoundingLine::contains_sphere(), BoundingSphere::contains_sphere(), extend_by(), BoundingBox::extend_by_box(), BoundingBox::extend_by_finite(), BoundingLine::extend_by_line(), BoundingPlane::extend_by_plane(), BoundingSphere::extend_by_point(), BoundingBox::extend_by_point(), BoundingSphere::extend_by_sphere(), BoundingBox::get_maxq(), BoundingBox::get_minq(), BoundingLine::get_point_a(), BoundingLine::get_point_b(), and SceneGraphReducer::r_flatten().

void BoundingVolume::set_infinite ( ) [inline]

Marks the volume as infinite, even if it is normally finite.

You can think of this as an infinite extend_by() operation.

Definition at line 68 of file boundingVolume.I.

Referenced by BoundingSphere::around_finite(), UnionBoundingVolume::around_geometric(), and extend_by().

BoundingVolume::BoundsType BoundingVolume::string_bounds_type ( const string &  str) [static]

Returns the BoundsType corresponding to the indicated string.

Definition at line 172 of file boundingVolume.cxx.


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