Panda3D
Public Types | Public Member Functions | Static Public Member Functions

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

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

List of all members.

Public Types

enum  BoundsType { BTDefault = 0, BTBest = 1, BTSphere = 2, BTBox = 3 }
enum  IntersectionFlags {
  IFNoIntersection = 0, IFPossible = 1, IFSome = 2, IFAll = 4,
  IFDontUnderstand = 8
}

Public Member Functions

int contains (BoundingVolume const vol)
 Returns the appropriate set of IntersectionFlags to indicate the amount of intersection with the indicated volume.
bool extendBy (BoundingVolume const vol)
 Increases the size of the volume to include the given volume.
int getRefCount ()
 Returns the current reference count.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool isEmpty ()
 Any kind of volume might be empty.
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isInfinite ()
 The other side of the empty coin is an infinite volume.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
BoundingVolume makeCopy ()
 output (ostream out)
 ref ()
 Explicitly increments the reference count.
 setInfinite ()
 Marks the volume as infinite, even if it is normally finite.
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
bool unref ()
 Explicitly decrements the reference count.
 write (ostream out)
 write (ostream out, int indent_level)

Static Public Member Functions

static TypeHandle getClassType ()

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.


Member Enumeration Documentation

enum BoundsType
Enumerator:
BTDefault 
BTBest 
BTSphere 
BTBox 
Enumerator:
IFNoIntersection 
IFPossible 
IFSome 
IFAll 
IFDontUnderstand 

Member Function Documentation

int contains ( BoundingVolume const  vol)

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

bool extendBy ( BoundingVolume const  vol)

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

static TypeHandle getClassType ( ) [static]
int getRefCount ( ) [inherited]

Returns the current reference count.

TypeHandle getType ( ) [inherited]

Reimplemented in AnimChannelBase.

int getTypeIndex ( ) [inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

This is equivalent to get_type().get_index().

bool isEmpty ( )

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.

bool isExactType ( TypeHandle  handle) [inherited]

Returns true if the current object is the indicated type exactly.

bool isInfinite ( )

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.

bool isOfType ( TypeHandle  handle) [inherited]

Returns true if the current object is or derives from the indicated type.

BoundingVolume makeCopy ( )
output ( ostream  out)
ref ( ) [inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

setInfinite ( )

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

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

bool testRefCountIntegrity ( ) [inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

bool testRefCountNonzero ( ) [inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

bool unref ( ) [inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.

write ( ostream  out,
int  indent_level 
)
write ( ostream  out)
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties