Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

FactoryParam Class Reference

The base class of any number of specific pieces of parameter information that might be passed to a Factory's CreateFunc to control what kind of instance is created. More...

#include <factoryParam.h>

Inheritance diagram for FactoryParam:

TypedReferenceCount TypedObject ReferenceCount BamReaderParam WritableParam List of all members.

Public Member Functions

 FactoryParam ()
 FactoryParam (const FactoryParam &other)
void operator= (const FactoryParam &other)
 ~FactoryParam ()
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 ()

Static Private Attributes

TypeHandle _type_handle

Detailed Description

The base class of any number of specific pieces of parameter information that might be passed to a Factory's CreateFunc to control what kind of instance is created.

This class is empty and contains no data, but different kinds of factories may expect parameters of various types that derive from FactoryParam (and do contain data).

Definition at line 50 of file factoryParam.h.


Constructor & Destructor Documentation

FactoryParam::FactoryParam  )  [inline]
 

Definition at line 30 of file factoryParam.I.

References INLINE.

FactoryParam::FactoryParam const FactoryParam &  other  )  [inline]
 

Definition at line 41 of file factoryParam.I.

References INLINE.

FactoryParam::~FactoryParam  )  [inline]
 

Definition at line 63 of file factoryParam.I.


Member Function Documentation

virtual TypeHandle FactoryParam::force_init_type void   )  [inline, virtual]
 

Reimplemented from TypedReferenceCount.

Reimplemented in BamReaderParam, and WritableParam.

Definition at line 61 of file factoryParam.h.

TypeHandle FactoryParam::get_class_type void   )  [inline, static]
 

Reimplemented from TypedReferenceCount.

Reimplemented in BamReaderParam, and WritableParam.

Definition at line 62 of file factoryParam.h.

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().

virtual TypeHandle FactoryParam::get_type void   )  const [inline, virtual]
 

Reimplemented from TypedReferenceCount.

Reimplemented in BamReaderParam, and WritableParam.

Definition at line 58 of file factoryParam.h.

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.

void FactoryParam::init_type void   )  [inline, static]
 

Reimplemented from TypedReferenceCount.

Reimplemented in BamReaderParam, and WritableParam.

Definition at line 65 of file factoryParam.h.

Referenced by BamReaderParam::get_type().

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().

void FactoryParam::operator= const FactoryParam &  other  )  [inline]
 

Definition at line 52 of file factoryParam.I.

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().

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

TypeHandle FactoryParam::_type_handle [static, private]
 

Reimplemented from TypedReferenceCount.

Reimplemented in BamReaderParam, and WritableParam.

Definition at line 24 of file factoryParam.cxx.


The documentation for this class was generated from the following files:
Generated on Fri May 2 00:50:36 2003 for Panda by doxygen1.3