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

TypedWritableReferenceCount Class Reference

A base class for things which need to inherit from both TypedWritable and from ReferenceCount. More...

#include <typedWritableReferenceCount.h>

Inheritance diagram for TypedWritableReferenceCount:

TypedWritable ReferenceCount TypedObject AnimGroup CollisionSolid ComputedVertices Material PartGroup Person RenderAttrib RenderEffect RenderEffects RenderState TransformState List of all members.

Public Member Functions

 TypedWritableReferenceCount ()
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
void operator= (const TypedWritableReferenceCount &copy)
virtual void write_datagram (BamWriter *, Datagram &)=0
 Writes the contents of this object to the datagram for shipping out to a Bam file.

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
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().

virtual void finalize ()
 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.

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 Public Attributes

TypedWritable *const Null = (TypedWritable*)0L

Protected Member Functions

void fillin (DatagramIterator &scan, BamReader *manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object.


Static Private Attributes

TypeHandle _type_handle

Detailed Description

A base class for things which need to inherit from both TypedWritable and from ReferenceCount.

It's convenient to define this intermediate base class instead of multiply inheriting from the two classes each time they are needed, so that we can sensibly pass around pointers to things which are both TypedWritables and ReferenceCounters.

Definition at line 49 of file typedWritableReferenceCount.h.


Constructor & Destructor Documentation

TypedWritableReferenceCount::TypedWritableReferenceCount  )  [inline]
 

Definition at line 31 of file typedWritableReferenceCount.I.

References INLINE.

TypedWritableReferenceCount::TypedWritableReferenceCount const TypedWritableReferenceCount &  copy  )  [inline]
 

Definition at line 45 of file typedWritableReferenceCount.I.

References INLINE, ReferenceCount::operator=(), and TypedWritable::operator=().


Member Function Documentation

int TypedWritable::complete_pointers TypedWritable **  p_list,
BamReader manager
[virtual, inherited]
 

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

This is the callback function that is made by the BamReader at some later point, after all of the required pointers have been filled in. It is necessary because there might be forward references in a bam file; when we call read_pointer() in fillin(), the object may not have been read from the file yet, so we do not have a pointer available at that time. Thus, instead of returning a pointer, read_pointer() simply reserves a later callback. This function provides that callback. The calling object is responsible for keeping track of the number of times it called read_pointer() and extracting the same number of pointers out of the supplied vector, and storing them appropriately within the object.

Reimplemented in AnimBundleNode, AnimGroup, PartBundleNode, PartGroup, Character, CharacterJoint, CollisionNode, GeomSprite, PiecewiseCurve, ClipPlaneAttrib, FogAttrib, LensNode, LightAttrib, MaterialAttrib, RenderEffects, RenderState, TextureAttrib, Person, and Child.

Definition at line 94 of file typedWritable.cxx.

Referenced by RenderState::do_invert_compose().

void TypedWritable::fillin DatagramIterator scan,
BamReader manager
[protected, inherited]
 

This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object.

It is defined at the TypedWritable level so that derived classes may call up the inheritance chain from their own fillin() method.

Reimplemented in AnimBundle, AnimBundleNode, AnimChannelBase, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimGroup, MovingPart< SwitchType >, PartBundleNode, PartGroup, Character, CharacterJoint, ComputedVertices, DynamicVertices, CollisionNode, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, dDrawable, Geom, GeomLine, GeomLinestrip, GeomPoint, GeomSprite, ImageBuffer, Material, Texture, ClassicNurbsCurve, CubicCurveseg, HermiteCurve, ParametricCurve, PiecewiseCurve, RopeNode, AlphaTestAttrib, AmbientLight, BillboardEffect, Camera, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBinAttrib, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, DirectionalLight, Fog, FogAttrib, GeomNode, LensNode, LightAttrib, LightLensNode, LightNode, LODNode, MaterialAttrib, ModelNode, ModelRoot, PandaNode, PlaneNode, PointLight, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, SequenceNode, ShowBoundsEffect, Spotlight, SwitchNode, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, TransparencyAttrib, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 139 of file typedWritable.cxx.

Referenced by PandaNode::reparent().

void TypedWritable::finalize void   )  [virtual, inherited]
 

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.

Reimplemented in PartBundle, RenderAttrib, RenderEffect, RenderEffects, RenderState, and TransformState.

Definition at line 112 of file typedWritable.cxx.

Referenced by BamReader::skip_pointer().

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

Reimplemented from TypedWritable.

Reimplemented in AnimBundle, AnimChannel< SwitchType >, AnimChannelBase, AnimChannelFixed< SwitchType >, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimGroup, MovingPart< SwitchType >, MovingPartBase, MovingPartMatrix, MovingPartScalar, PartBundle, PartGroup, CharacterJoint, CharacterJointBundle, CharacterSlider, ComputedVertices, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, Material, AlphaTestAttrib, BillboardEffect, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBinAttrib, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, FogAttrib, LightAttrib, MaterialAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, ShowBoundsEffect, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, TransparencyAttrib, Person, Parent, Child, AnimChannel< ACScalarSwitchType >, AnimChannel< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 62 of file typedWritableReferenceCount.h.

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

Reimplemented from ReferenceCount.

Reimplemented in AnimBundle, AnimChannel< SwitchType >, AnimChannelBase, AnimChannelFixed< SwitchType >, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimGroup, MovingPart< SwitchType >, MovingPartBase, MovingPartMatrix, MovingPartScalar, PartBundle, PartGroup, CharacterJoint, CharacterJointBundle, CharacterSlider, ComputedVertices, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, Material, AlphaTestAttrib, BillboardEffect, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBinAttrib, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, FogAttrib, LightAttrib, MaterialAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, ShowBoundsEffect, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, TransparencyAttrib, Person, Parent, Child, AnimChannel< ACScalarSwitchType >, AnimChannel< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 65 of file typedWritableReferenceCount.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 TypedWritableReferenceCount::get_type void   )  const [inline, virtual]
 

Reimplemented from TypedWritable.

Reimplemented in AnimBundle, AnimChannel< SwitchType >, AnimChannelBase, AnimChannelFixed< SwitchType >, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimGroup, MovingPart< SwitchType >, MovingPartBase, MovingPartMatrix, MovingPartScalar, PartBundle, PartGroup, CharacterJoint, CharacterJointBundle, CharacterSlider, ComputedVertices, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, Material, AlphaTestAttrib, BillboardEffect, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBinAttrib, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, FogAttrib, LightAttrib, MaterialAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, ShowBoundsEffect, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, TransparencyAttrib, Person, Parent, Child, AnimChannel< ACScalarSwitchType >, AnimChannel< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 59 of file typedWritableReferenceCount.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 TypedWritableReferenceCount::init_type void   )  [inline, static]
 

Reimplemented from ReferenceCount.

Reimplemented in AnimBundle, AnimChannel< SwitchType >, AnimChannelBase, AnimChannelFixed< SwitchType >, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimGroup, MovingPart< SwitchType >, MovingPartBase, MovingPartMatrix, MovingPartScalar, PartBundle, PartGroup, CharacterJoint, CharacterJointBundle, CharacterSlider, ComputedVertices, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, Material, AlphaTestAttrib, BillboardEffect, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBinAttrib, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, FogAttrib, LightAttrib, MaterialAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, ShowBoundsEffect, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, TransparencyAttrib, Person, Parent, Child, AnimChannel< ACScalarSwitchType >, AnimChannel< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 70 of file typedWritableReferenceCount.h.

Referenced by Person::get_class_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 TypedWritableReferenceCount::operator= const TypedWritableReferenceCount &  copy  )  [inline]
 

Definition at line 61 of file typedWritableReferenceCount.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().

virtual void TypedWritableReferenceCount::write_datagram BamWriter ,
Datagram
[pure virtual]
 

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

Reimplemented from TypedWritable.

Implemented in AnimBundle, AnimChannelBase, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimGroup, MovingPart< SwitchType >, PartGroup, CharacterJoint, ComputedVertices, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, Material, AlphaTestAttrib, BillboardEffect, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBinAttrib, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, FogAttrib, LightAttrib, MaterialAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, ShowBoundsEffect, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, TransparencyAttrib, Person, Parent, Child, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.


Member Data Documentation

TypeHandle TypedWritableReferenceCount::_type_handle [static, private]
 

Reimplemented from ReferenceCount.

Reimplemented in AnimBundle, AnimChannel< SwitchType >, AnimChannelBase, AnimChannelFixed< SwitchType >, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimGroup, MovingPart< SwitchType >, MovingPartBase, MovingPartMatrix, MovingPartScalar, PartBundle, PartGroup, CharacterJoint, CharacterJointBundle, CharacterSlider, ComputedVertices, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, Material, AlphaTestAttrib, BillboardEffect, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBinAttrib, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, FogAttrib, LightAttrib, MaterialAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, ShowBoundsEffect, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, TransparencyAttrib, Person, Parent, Child, AnimChannel< ACScalarSwitchType >, AnimChannel< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, and MovingPart< ACMatrixSwitchType >.

Definition at line 24 of file typedWritableReferenceCount.cxx.

TypedWritable *const TypedWritable::Null = (TypedWritable*)0L [static, inherited]
 

Definition at line 25 of file typedWritable.cxx.

Referenced by Child::complete_pointers(), Parent::complete_pointers(), Person::complete_pointers(), LoaderFileTypeBam::get_extension(), PartGroup::pick_channel_index(), BamReader::read_pointer(), and AnimGroup::write_datagram().


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