Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ReferenceCount Class Reference

A base class for all things that want to be reference-counted. More...

Inheritance diagram for ReferenceCount:
RPLight ShadowManager AICharacter Buffer ClockObject Connection CullResult GeomVertexArrayDataHandle GraphicsEngine HTTPClient ModelReference ModelRoot::ModelReference MouseWatcherGroup Multifile NodeReferenceCount NurbsCurveEvaluator NurbsCurveResult NurbsSurfaceEvaluator NurbsSurfaceResult ParametricCurveCollection PartBundleHandle PNMBrush PreparedGraphicsObjects PStatCollectorForwardBase SocketStreamRecorder TexturePeeker TypedReferenceCount TypedWritableReferenceCount VertexDataBlock VirtualFileList BaseIntegrator BaseParticleEmitter BaseParticleFactory BaseParticleRenderer ColorInterpolationManager ColorInterpolationSegment SpriteAnim

Public Member Functions

int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 

Public Attributes

int ref_count
 The current reference count. More...
 

Detailed Description

A base class for all things that want to be reference-counted.

ReferenceCount works in conjunction with PointerTo to automatically delete objects when the last pointer to them goes away.

Member Function Documentation

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getRefCount()

int getRefCount ( )

Returns the current reference count.

◆ ref()

ref ( )

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.

◆ testRefCountIntegrity()

bool testRefCountIntegrity ( )

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

Returns true if ok, false otherwise.

◆ testRefCountNonzero()

bool testRefCountNonzero ( )

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

Returns true if ok, false otherwise.

◆ unref()

bool unref ( )

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.

Member Data Documentation

◆ ref_count

int ref_count

The current reference count.