Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ParamValue< Type > Class Template Reference

A handy class object for storing simple values (like integers or strings) passed along with an Event or to be used as a shader input. More...

#include "paramValue.h"

Inheritance diagram for ParamValue< Type >:
ParamValueBase TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Public Member Functions

 ParamValue (const Type &value)
 
virtual TypeHandle force_init_type ()
 
virtual TypeHandle get_type () const
 
const Type & get_value () const
 
virtual TypeHandle get_value_type () const
 Retrieves the type of the value stored in the parameter. More...
 
virtual void output (std::ostream &out) const
 
void set_value (const Type &value)
 
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
vector_uchar encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type (const std::string &type_name="UndefinedParamValue")
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type ParamValue. More...
 
- Static Public Member Functions inherited from ParamValueBase
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_value
 Retrieves the value stored in the parameter. More...
 
 set_value
 Changes the value stored in the parameter. More...
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

template<class Type>
class ParamValue< Type >

A handy class object for storing simple values (like integers or strings) passed along with an Event or to be used as a shader input.

This is essentially just a wrapper around whatever data type you like, to make it a TypedWritableReferenceCount object which can be passed along inside an EventParameter or ShaderInput.

Definition at line 103 of file paramValue.h.

Member Function Documentation

◆ get_value_type()

template<class Type >
TypeHandle ParamValue< Type >::get_value_type ( ) const
inlinevirtual

Retrieves the type of the value stored in the parameter.

Reimplemented from ParamValueBase.

Definition at line 91 of file paramValue.I.

◆ register_with_read_factory()

template<class Type >
void ParamValue< Type >::register_with_read_factory ( )
inlinestatic

Tells the BamReader how to create objects of type ParamValue.

Definition at line 128 of file paramValue.I.

References BamReader::get_factory(), and Factory< Type >::register_factory().

Referenced by init_libputil().

◆ write_datagram()

template<class Type >
void ParamValue< Type >::write_datagram ( BamWriter manager,
Datagram dg 
)
inlinevirtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from TypedWritable.

Definition at line 138 of file paramValue.I.

References TypedWritable::write_datagram().

Member Data Documentation

◆ get_value

template<class Type>
const Type & ParamValue< Type >::get_value
inline

Retrieves the value stored in the parameter.

Definition at line 115 of file paramValue.h.

◆ set_value

template<class Type>
void ParamValue< Type >::set_value
inline

Changes the value stored in the parameter.

Definition at line 115 of file paramValue.h.


The documentation for this class was generated from the following files: