---

EventStoreValue< Type > Class Template Reference

A handy class object for storing simple values (like integers or strings) passed along with an Event. More...

#include <eventParameter.h>

Inheritance diagram for EventStoreValue< Type >:

List of all members.

Public Member Functions
	EventStoreValue (const Type &value)
void	set_value (const Type &value)
	Changes the value stored in the parameter.
const Type &	get_value () const
	Retrieves the value stored in the parameter.
virtual void	output (ostream &out) const
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
int	get_ref_count () const
	Returns the current reference count.
int	ref () const
	Explicitly increments the reference count.
int	unref () const
	Explicitly decrements the reference count.
void	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type (const string &type_name="UndefinedEventStoreValue")
void	init_type ()
Public Attributes
Type	_value
Static Private Attributes
TypeHandle	_type_handle

---

Detailed Description

template<class Type>
class EventStoreValue< Type >

A handy class object for storing simple values (like integers or strings) passed along with an Event.

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

Definition at line 136 of file eventParameter.h.

---

Constructor & Destructor Documentation

template<class Type> EventStoreValue< Type >::EventStoreValue (  const Type &  value  )  [inline]

Definition at line 138 of file eventParameter.h. Referenced by EventStoreValueBase::init_type().

---

Member Function Documentation

template<class Type> virtual TypeHandle EventStoreValue< Type >::force_init_type (  void   )  [inline, virtual]

Reimplemented from EventStoreValueBase. Definition at line 159 of file eventParameter.h. Referenced by EventStoreValueBase::init_type().

template<class Type> TypeHandle EventStoreValue< Type >::get_class_type (  void   )  [inline, static]

Reimplemented from EventStoreValueBase. Definition at line 148 of file eventParameter.h. Referenced by EventStoreValueBase::init_type().

int ReferenceCount::get_ref_count (   )  const [inline, inherited]

Returns the current reference count. Definition at line 183 of file referenceCount.I. Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

template<class Type> virtual TypeHandle EventStoreValue< Type >::get_type (  void   )  const [inline, virtual]

Reimplemented from EventStoreValueBase. Definition at line 156 of file eventParameter.h. Referenced by EventStoreValueBase::init_type().

int TypedObject::get_type_index (   )  const [inline, 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(). Definition at line 71 of file typedObject.I. References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

template<class Type> const Type & EventStoreValue< Type >::get_value (   )  const [inline]

Retrieves the value stored in the parameter. Definition at line 316 of file eventParameter.I. Referenced by Trackball::apply(), MouseWatcher::global_keyboard_press(), and EventStoreValueBase::init_type().

void EventStoreValueBase::init_type (  void   )  [inline, static, inherited]

Reimplemented from TypedReferenceCount. Reimplemented in EventStoreTransform, and ButtonEventList. Definition at line 108 of file eventParameter.h. References EventStoreValue< Type >::_type_handle, EventStoreValue< Type >::_value, EventStoreValue< Type >::EventStoreValue(), EventStoreValue< Type >::force_init_type(), EventStoreValueBase::get_class_type(), EventStoreValue< Type >::get_class_type(), EventStoreValue< Type >::get_type(), EventStoreValue< Type >::get_value(), INLINE, EventStoreValue< Type >::output(), register_dynamic_type(), and EventStoreValue< Type >::set_value().

template<class Type> void EventStoreValue< Type >::init_type (  const string &  type_name = "UndefinedEventStoreValue< Type >"  )  [inline, static]

Definition at line 151 of file eventParameter.h.

bool TypedObject::is_exact_type (  TypeHandle  handle  )  const [inline, inherited]

Returns true if the current object is the indicated type exactly. Definition at line 101 of file typedObject.I. Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type (  TypeHandle  handle  )  const [inline, inherited]

Returns true if the current object is or derives from the indicated type. Definition at line 86 of file typedObject.I. Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

template<class Type> void EventStoreValue< Type >::output (  ostream &  out  )  const [virtual]

Implements EventStoreValueBase. Definition at line 330 of file eventParameter.I. Referenced by EventStoreValueBase::init_type().

int ReferenceCount::ref (   )  const [inline, 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. The return value is the new reference count. Definition at line 225 of file referenceCount.I. Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

template<class Type> void EventStoreValue< Type >::set_value (  const Type &  value  )  [inline]

Changes the value stored in the parameter. It is dangerous to do this for a parameter already added to an event, since the parameters may be shared. Definition at line 301 of file eventParameter.I. Referenced by EventStoreValueBase::init_type().

void ReferenceCount::test_ref_count_integrity (   )  const [inline, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus. Definition at line 328 of file referenceCount.I. References INLINE. Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref (   )  const [inline, 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; plus, we don't have a virtual destructor anyway.) 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 the new reference count. Definition at line 293 of file referenceCount.I. References INLINE. Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

---

Member Data Documentation

template<class Type> TypeHandle EventStoreValue< Type >::_type_handle [static, private]

Reimplemented from EventStoreValueBase. Definition at line 25 of file eventParameter.I. Referenced by EventStoreValueBase::init_type().

template<class Type> Type EventStoreValue< Type >::_value

Definition at line 145 of file eventParameter.h. Referenced by EventStoreValueBase::init_type().

---

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

• panda/src/event/eventParameter.h
• panda/src/event/eventParameter.I

---