Panda3D
|
An instance of this class is written to the front of a Bam or Txo file to make the file a cached instance of some other loadable resource. More...
#include <pandadoc.hpp>
Public Member Functions | |
addDependentFile (const Filename pathname) | |
Adds the indicated file to the list of files that will be loaded to generate the data in this record. More... | |
addDependentFile (const VirtualFile file) | |
Variant of add_dependent_file that takes an already opened VirtualFile. More... | |
clearData () | |
Removes the in-memory data object associated with this record, if any. More... | |
clearDependentFiles () | |
Empties the list of files that contribute to the data in this record. More... | |
bool | dependentsUnchanged () |
Returns true if all of the dependent files are still the same as when the cache was recorded, false otherwise. More... | |
const Filename | getCacheFilename () |
Returns the name of the cache file as hashed from the source_pathname. More... | |
TypedWritable | getData () |
Returns a pointer to the data stored in the record, or NULL if there is no data. More... | |
const Filename | getDependentPathname (int n) |
Returns the full pathname of the nth source files that contributes to the cache. More... | |
int | getNumDependentFiles () |
Returns the number of source files that contribute to the cache. More... | |
time_t | getRecordedTime () |
Returns the time at which this particular record was recorded or updated. More... | |
const Filename | getSourcePathname () |
Returns the full pathname to the source file that originally generated this cache request. More... | |
time_t | getSourceTimestamp () |
Returns the file timestamp of the original source file that generated this cache record, if available. More... | |
bool | hasData () |
Returns true if this cache record has an in-memory data object associated– that is, the object stored in the cache. More... | |
BamCacheRecord | makeCopy () |
Returns a duplicate of the BamCacheRecord. More... | |
bool | operator== (const BamCacheRecord other) |
output (Ostream out) | |
setData (TypedWritable ptr) | |
This variant on set_data() is provided to easily pass objects deriving from TypedWritable. More... | |
setData (TypedWritable ptr, int dummy) | |
This variant on set_data() is provided just to allow Python code to pass a 0 as the second parameter. More... | |
setData (TypedWritable ptr, ReferenceCount ref_ptr) | |
Stores a new data object on the record. More... | |
setData (TypedWritableReferenceCount ptr) | |
This variant on set_data() is provided to easily pass objects deriving from TypedWritableReferenceCount. More... | |
write (Ostream out, int indent_level) | |
![]() | |
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. More... | |
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. More... | |
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. More... | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. More... | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More... | |
![]() | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
bool | isExactType (TypeHandle handle) |
Returns true if the current object is the indicated type exactly. More... | |
bool | isOfType (TypeHandle handle) |
Returns true if the current object is or derives from the indicated type. More... | |
![]() | |
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 () |
![]() | |
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. More... | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
Public Attributes | |
const Filename | cache_filename |
Returns the name of the cache file as hashed from the source_pathname. More... | |
TypedWritable | data |
Returns a pointer to the data stored in the record, or NULL if there is no data. More... | |
time_t | recorded_time |
Returns the time at which this particular record was recorded or updated. More... | |
const Filename | source_pathname |
Returns the full pathname to the source file that originally generated this cache request. More... | |
time_t | source_timestamp |
Returns the file timestamp of the original source file that generated this cache record, if available. More... | |
![]() | |
TypeHandle | type |
Returns the TypeHandle representing this object's type. More... | |
![]() | |
int | ref_count |
The current reference count. More... | |
An instance of this class is written to the front of a Bam or Txo file to make the file a cached instance of some other loadable resource.
This record contains information needed to test the validity of the cache.
addDependentFile | ( | const Filename | pathname | ) |
Adds the indicated file to the list of files that will be loaded to generate the data in this record.
This should be called once for the primary source file, and again for each secondary source file, if any.
addDependentFile | ( | const VirtualFile | file | ) |
Variant of add_dependent_file that takes an already opened VirtualFile.
clearData | ( | ) |
Removes the in-memory data object associated with this record, if any.
This does not affect the on-disk representation of the record.
clearDependentFiles | ( | ) |
Empties the list of files that contribute to the data in this record.
bool dependentsUnchanged | ( | ) |
Returns true if all of the dependent files are still the same as when the cache was recorded, false otherwise.
const Filename getCacheFilename | ( | ) |
Returns the name of the cache file as hashed from the source_pathname.
This will be relative to the root of the cache directory, and it will not include any suffixes that may be appended to resolve hash conflicts.
|
static |
TypedWritable getData | ( | ) |
Returns a pointer to the data stored in the record, or NULL if there is no data.
The pointer is not removed from the record.
const Filename getDependentPathname | ( | int | n | ) |
Returns the full pathname of the nth source files that contributes to the cache.
int getNumDependentFiles | ( | ) |
Returns the number of source files that contribute to the cache.
time_t getRecordedTime | ( | ) |
Returns the time at which this particular record was recorded or updated.
const Filename getSourcePathname | ( | ) |
Returns the full pathname to the source file that originally generated this cache request.
In some cases, for instance in the case of a of a multipage texture like "cube_#.png", this may not not a true filename on disk.
time_t getSourceTimestamp | ( | ) |
Returns the file timestamp of the original source file that generated this cache record, if available.
In some cases the original file timestamp is not available, and this will return 0.
bool hasData | ( | ) |
Returns true if this cache record has an in-memory data object associated– that is, the object stored in the cache.
BamCacheRecord makeCopy | ( | ) |
Returns a duplicate of the BamCacheRecord.
The duplicate will not have a data pointer set, even though one may have been assigned to the original via set_data().
bool operator== | ( | const BamCacheRecord | other | ) |
output | ( | Ostream | out | ) |
setData | ( | TypedWritable | ptr | ) |
This variant on set_data() is provided to easily pass objects deriving from TypedWritable.
setData | ( | TypedWritable | ptr, |
int | dummy | ||
) |
This variant on set_data() is provided just to allow Python code to pass a 0 as the second parameter.
setData | ( | TypedWritable | ptr, |
ReferenceCount | ref_ptr | ||
) |
Stores a new data object on the record.
You should pass the same pointer twice, to both parameters; this allows the C++ typecasting to automatically convert the pointer into both a TypedWritable and a ReferenceCount pointer, so that the BamCacheRecord object can reliably manage the reference counts.
You may pass 0 or NULL as the second parameter. If you do this, the BamCacheRecord will not manage the object's reference count; it will be up to you to ensure the object is not deleted during the lifetime of the BamCacheRecord object.
setData | ( | TypedWritableReferenceCount | ptr | ) |
This variant on set_data() is provided to easily pass objects deriving from TypedWritableReferenceCount.
write | ( | Ostream | out, |
int | indent_level | ||
) |
const Filename cache_filename |
Returns the name of the cache file as hashed from the source_pathname.
This will be relative to the root of the cache directory, and it will not include any suffixes that may be appended to resolve hash conflicts.
TypedWritable data |
Returns a pointer to the data stored in the record, or NULL if there is no data.
The pointer is not removed from the record.
time_t recorded_time |
Returns the time at which this particular record was recorded or updated.
const Filename source_pathname |
Returns the full pathname to the source file that originally generated this cache request.
In some cases, for instance in the case of a of a multipage texture like "cube_#.png", this may not not a true filename on disk.
time_t source_timestamp |
Returns the file timestamp of the original source file that generated this cache record, if available.
In some cases the original file timestamp is not available, and this will return 0.