Base class for objects that can be written to and read from Bam files. More...

Inheritance diagram for TypedWritable:
TypedObject MemoryBase PNMFileType TypedWritableReferenceCount WritableConfigurable AnimGroup BamCacheRecord CachedTypedWritableReferenceCount CollisionEntry GeomVertexArrayFormat GeomVertexFormat GraphicsOutputBase GraphicsStateGuardianBase InternalName Lens Material MouseWatcherRegion MovieAudio MovieAudioCursor MovieVideo MovieVideoCursor PandaNode ParamValueBase PartGroup PGMouseWatcherParameter RenderAttrib RenderEffect RenderEffects Shader ShaderInput SliderTable Texture TextureStage TransformTable VertexSlider VertexTransform

Public Member Functions

object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
str encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. Returns empty string on failure. More...
 
bool encodeToBamStream (String data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. Returns true on success, false on failure. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 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(). 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...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 

Detailed Description

Base class for objects that can be written to and read from Bam files.

See also TypedObject for detailed instructions.

Member Function Documentation

object __reduce__ ( )
object __reduce_persist__ ( object  pickler)
str encodeToBamStream ( )

Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. Returns empty string on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( String  data,
BamWriter  writer 
)

Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. Returns true on success, false on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

UpdateSeq getBamModified ( )

Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified.

static TypeHandle getClassType ( )
static
markBamModified ( )

Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients.