Panda3D
|
This class further specializes CachedTypedWritableReferenceCount to also add a node_ref_count, for the purposes of counting the number of times the object is referenced by a "node", presumably a PandaNode. More...
#include <pandadoc.hpp>
Public Types | |
enum | Referenced { R_node = 1 , R_cache = 2 } |
Public Member Functions | |
int | getNodeRefCount () |
Returns the current reference count. | |
int | getReferencedBits () |
Returns the union of the values defined in the Referenced enum that represents the various things that appear to be holding a pointer to this object. | |
nodeRef () | |
Explicitly increments the reference count. | |
bool | nodeUnref () |
Explicitly decrements the node reference count and the normal reference count simultaneously. | |
bool | testRefCountIntegrity () |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
![]() | |
cacheRef () | |
Explicitly increments the cache reference count and the normal reference count simultaneously. | |
bool | cacheUnref () |
Explicitly decrements the cache reference count and the normal reference count simultaneously. | |
int | getCacheRefCount () |
Returns the current reference count. | |
bool | testRefCountIntegrity () |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
![]() | |
object | __reduce__ () |
object | __reduce_persist__ (object pickler) |
VectorUchar | encodeToBamStream () |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. | |
bool | encodeToBamStream (VectorUchar data, BamWriter writer) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
fillin (DatagramIterator scan, BamReader manager) | |
This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. | |
![]() | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
bool | isExactType (TypeHandle handle) |
Returns true if the current object is the indicated type exactly. | |
bool | isOfType (TypeHandle handle) |
Returns true if the current object is or derives from the indicated type. | |
![]() | |
int | getRefCount () |
Returns the current reference count. | |
ref () | |
Explicitly increments the reference count. | |
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. | |
Static Public Member Functions | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypedWritableReferenceCount | decodeFromBamStream (VectorUchar data, BamReader reader) |
Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
Additional Inherited Members | |
![]() | |
int | cache_ref_count |
Returns the current reference count. | |
![]() | |
TypeHandle | type |
Returns the TypeHandle representing this object's type. | |
![]() | |
int | ref_count |
The current reference count. | |
This class further specializes CachedTypedWritableReferenceCount to also add a node_ref_count, for the purposes of counting the number of times the object is referenced by a "node", presumably a PandaNode.
This essentially combines the functionality of NodeReferenceCount and CachedTypedWritableReferenceCount, so that a derivative of this object actually has three counters: the standard reference count, the "cache" reference count, and the "node" reference count. Rather than multiply inheriting from the two reference count classes, we inherit only from CachedTypedWritableReferenceCount and simply duplicate the functionality of NodeReferenceCount, to avoid all of the problems associated with multiple inheritance.
The intended design is to use this as a base class for RenderState and TransformState, both of which are held by PandaNodes, and also have caches which are independently maintained. By keeping track of how many nodes hold a pointer to a particular object, we can classify each object into node-referenced, cache-referenced, or other, which is primarily useful for PStats reporting.
As with CachedTypedWritableReferenceCount's cache_ref() and cache_unref(), the new methods node_ref() and node_unref() automatically increment and decrement the primary reference count as well. In this case, however, there does exist a NodePointerTo<> class to maintain the node_ref counters automatically.
enum Referenced |
|
static |
int getNodeRefCount | ( | ) |
Returns the current reference count.
int getReferencedBits | ( | ) |
Returns the union of the values defined in the Referenced enum that represents the various things that appear to be holding a pointer to this object.
If R_node is included, at least one node is holding a pointer; if R_cache is included, at least one cache element is.
nodeRef | ( | ) |
Explicitly increments the reference count.
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.
bool nodeUnref | ( | ) |
Explicitly decrements the node reference count and the normal reference count simultaneously.
The return value is true if the new reference count is nonzero, false if it is zero.
bool testRefCountIntegrity | ( | ) |
Does some easy checks to make sure that the reference count isn't completely bogus.