Panda3D
Public Member Functions | Static Public Member Functions

SliderTable Class Reference

Stores the total set of VertexSliders that the vertices in a particular GeomVertexData object might depend on. More...

Inheritance diagram for SliderTable:
TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

List of all members.

Public Member Functions

 SliderTable ()
 SliderTable (SliderTable const copy)
int addSlider (VertexSlider const slider, SparseArray const rows)
 Adds a new slider to the table, and returns the index number of the new slider.
string encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
bool encodeToBamStream (basic_stringchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
bool encodeToBamStream (basic_stringchar data)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
SparseArray const findSliders (InternalName const name)
 Returns a list of slider indices that represent the list of sliders with the indicated name, or an empty SparseArray if no slider in the table has that name.
UpdateSeq getBamModified ()
 Returns the current bam_modified counter.
UpdateSeq getModified (Thread current_thread)
 Returns a sequence number that's guaranteed to change at least when any VertexSliders in the table change.
int getNumSliders ()
 Returns the number of sliders in the table.
int getRefCount ()
 Returns the current reference count.
VertexSlider const getSlider (int n)
 Returns the nth slider in the table.
SparseArray const getSliderRows (int n)
 Returns the set of rows (vertices) governed by the nth slider in the table.
list getSliders ()
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool hasSlider (InternalName const name)
 Returns true if the table has at least one slider by the indicated name, false otherwise.
bool isEmpty ()
 Returns true if the table has no sliders, false if it has at least one.
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.
bool isRegistered ()
 Returns true if this table has been registered.
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
SliderTable operator= (SliderTable const copy)
PyObject reduce (PyObject self)
 This special Python method is implement to provide support for the pickle module.
PyObject reducePersist (PyObject self, PyObject pickler)
 This special Python method is implement to provide support for the pickle module.
 ref ()
 Explicitly increments the reference count.
 removeSlider (int n)
 Removes the nth slider.
 setSlider (int n, VertexSlider const slider)
 Replaces the nth slider.
 setSliderRows (int n, SparseArray const rows)
 Replaces the rows affected by the nth slider.
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)

Static Public Member Functions

static TypedWritableReferenceCount decodeFromBamStream (string data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
static TypedWritableReferenceCount decodeFromBamStream (string data)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
static TypeHandle getClassType ()
static SliderTable const registerTable (SliderTable const table)
 Registers a SliderTable for use.

Detailed Description

Stores the total set of VertexSliders that the vertices in a particular GeomVertexData object might depend on.

This is similar to a TransformTable, but it stores VertexSliders instead of VertexTransforms, and it stores them by name instead of by index number. Also, it is only used when animating vertices on the CPU, since GPU's don't support morphs at this point in time.


Constructor & Destructor Documentation

SliderTable ( SliderTable const  copy)

Member Function Documentation

int addSlider ( VertexSlider const  slider,
SparseArray const  rows 
)

Adds a new slider to the table, and returns the index number of the new slider.

Only valid for unregistered tables.

static TypedWritableReferenceCount decodeFromBamStream ( string  data,
BamReader  reader 
) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.

Returns NULL on error.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

static TypedWritableReferenceCount decodeFromBamStream ( string  data) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.

Returns NULL on error.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

string encodeToBamStream ( ) [inherited]

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 ( basic_stringchar  data,
BamWriter  writer 
) [inherited]

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.

bool encodeToBamStream ( basic_stringchar  data) [inherited]

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.

SparseArray const findSliders ( InternalName const  name)

Returns a list of slider indices that represent the list of sliders with the indicated name, or an empty SparseArray if no slider in the table has that name.

UpdateSeq getBamModified ( ) [inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

static TypeHandle getClassType ( ) [static]

Reimplemented from TypedWritableReferenceCount.

UpdateSeq getModified ( Thread  current_thread)

Returns a sequence number that's guaranteed to change at least when any VertexSliders in the table change.

(However, this is only true for a registered table. An unregistered table may or may not reflect an update here when a VertexSlider changes.)

int getNumSliders ( )

Returns the number of sliders in the table.

int getRefCount ( ) [inherited]

Returns the current reference count.

VertexSlider const getSlider ( int  n)

Returns the nth slider in the table.

SparseArray const getSliderRows ( int  n)

Returns the set of rows (vertices) governed by the nth slider in the table.

list getSliders ( )
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 hasSlider ( InternalName const  name)

Returns true if the table has at least one slider by the indicated name, false otherwise.

bool isEmpty ( )

Returns true if the table has no sliders, false if it has at least one.

bool isExactType ( TypeHandle  handle) [inherited]

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

bool isOfType ( TypeHandle  handle) [inherited]

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

bool isRegistered ( )

Returns true if this table has been registered.

Once it has been registered, the set of sliders in a SliderTable may not be further modified; but it must be registered before it can be assigned to a Geom.

markBamModified ( ) [inherited]

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.

SliderTable operator= ( SliderTable const  copy)
PyObject reduce ( PyObject  self) [inherited]

This special Python method is implement to provide support for the pickle module.

This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.

PyObject reducePersist ( PyObject  self,
PyObject  pickler 
) [inherited]

This special Python method is implement to provide support for the pickle module.

This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.

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.

static SliderTable const registerTable ( SliderTable const  table) [static]

Registers a SliderTable for use.

This is similar to GeomVertexFormat.register_format(). Once registered, a SliderTable may no longer be modified (although the individual VertexSlider objects may modify their reported sliders).

This must be called before a table may be used in a Geom. After this call, you should discard the original pointer you passed in (which may or may not now be invalid) and let its reference count decrement normally; you should use only the returned value from this point on.

removeSlider ( int  n)

Removes the nth slider.

Only valid for unregistered tables.

setSlider ( int  n,
VertexSlider const  slider 
)

Replaces the nth slider.

Only valid for unregistered tables.

setSliderRows ( int  n,
SparseArray const  rows 
)

Replaces the rows affected by the nth slider.

Only valid for unregistered tables.

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)
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties