---

BaseForce Class Reference

pure virtual base class for all forces that could POSSIBLY exist. More...

#include <baseForce.h>

Inheritance diagram for BaseForce:

List of all members.

Public Member Functions
virtual	~BaseForce (void)
	destructor
bool	get_active (void) const
void	set_active (bool active)
virtual bool	is_linear (void) const=0
ForceNode *	get_force_node (void) const
virtual LVector3f	get_vector (const PhysicsObject *po)=0
virtual TypeHandle	get_type (void) 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)
void	init_type (void)
Protected Member Functions
	BaseForce (bool active=true)
	constructor
	BaseForce (const BaseForce &copy)
	copy constructor
Private Member Functions
virtual LVector3f	get_child_vector (const PhysicsObject *po)=0
Private Attributes
ForceNode *	_force_node
bool	_active
Static Private Attributes
TypeHandle	_type_handle
Friends
class	ForceNode

---

Detailed Description

pure virtual base class for all forces that could POSSIBLY exist.

Definition at line 42 of file baseForce.h.

---

Constructor & Destructor Documentation

BaseForce::BaseForce (  bool  active = true  )  [protected]

constructor Definition at line 35 of file baseForce.cxx. References _active, _force_node, and NULL.

BaseForce::BaseForce (  const BaseForce &  copy  )  [protected]

copy constructor Definition at line 48 of file baseForce.cxx.

BaseForce::~BaseForce (  void   )  [virtual]

destructor Definition at line 63 of file baseForce.cxx.

---

Member Function Documentation

virtual TypeHandle BaseForce::force_init_type (  void   )  [inline, virtual]

Reimplemented from TypedReferenceCount. Reimplemented in AngularForce, AngularVectorForce, LinearCylinderVortexForce, LinearDistanceForce, LinearForce, LinearFrictionForce, LinearJitterForce, LinearNoiseForce, LinearRandomForce, LinearSinkForce, LinearSourceForce, LinearUserDefinedForce, and LinearVectorForce. Definition at line 76 of file baseForce.h.

bool BaseForce::get_active (  void   )  const [inline]

Definition at line 51 of file baseForce.I.

virtual LVector3f BaseForce::get_child_vector (  const PhysicsObject *  po  )  [private, pure virtual]

Implemented in AngularForce, AngularVectorForce, LinearCylinderVortexForce, LinearDistanceForce, LinearForce, LinearFrictionForce, LinearJitterForce, LinearNoiseForce, LinearRandomForce, LinearSinkForce, LinearSourceForce, LinearUserDefinedForce, and LinearVectorForce.

TypeHandle BaseForce::get_class_type (  void   )  [inline, static]

Reimplemented from TypedReferenceCount. Reimplemented in AngularForce, AngularVectorForce, LinearCylinderVortexForce, LinearDistanceForce, LinearForce, LinearFrictionForce, LinearJitterForce, LinearNoiseForce, LinearRandomForce, LinearSinkForce, LinearSourceForce, LinearUserDefinedForce, and LinearVectorForce. Definition at line 65 of file baseForce.h.

ForceNode * BaseForce::get_force_node (  void   )  const [inline]

Definition at line 29 of file baseForce.I. References _active, and INLINE.

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 BaseForce::get_type (  void   )  const [inline, virtual]

Reimplemented from TypedReferenceCount. Reimplemented in AngularForce, AngularVectorForce, LinearCylinderVortexForce, LinearDistanceForce, LinearForce, LinearFrictionForce, LinearJitterForce, LinearNoiseForce, LinearRandomForce, LinearSinkForce, LinearSourceForce, LinearUserDefinedForce, and LinearVectorForce. Definition at line 73 of file baseForce.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.

virtual LVector3f BaseForce::get_vector (  const PhysicsObject *  po  )  [pure virtual]

Implemented in AngularForce, and LinearForce.

void BaseForce::init_type (  void   )  [inline, static]

Reimplemented from TypedReferenceCount. Reimplemented in AngularForce, AngularVectorForce, LinearCylinderVortexForce, LinearDistanceForce, LinearForce, LinearFrictionForce, LinearJitterForce, LinearNoiseForce, LinearRandomForce, LinearSinkForce, LinearSourceForce, LinearUserDefinedForce, and LinearVectorForce. Definition at line 68 of file baseForce.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().

virtual bool BaseForce::is_linear (  void   )  const [pure virtual]

Implemented in AngularForce, and LinearForce.

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

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 BaseForce::set_active (  bool  active  )  [inline]

Definition at line 40 of file baseForce.I. References _active, and INLINE.

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

---

Friends And Related Function Documentation

friend class ForceNode [friend]

Definition at line 81 of file baseForce.h.

---

Member Data Documentation

bool BaseForce::_active [private]

Definition at line 45 of file baseForce.h. Referenced by BaseForce(), get_force_node(), and set_active().

ForceNode* BaseForce::_force_node [private]

Definition at line 44 of file baseForce.h. Referenced by BaseForce(), and ForceNode::get_num_forces().

TypeHandle BaseForce::_type_handle [static, private]

Reimplemented from TypedReferenceCount. Reimplemented in AngularForce, AngularVectorForce, LinearCylinderVortexForce, LinearDistanceForce, LinearForce, LinearFrictionForce, LinearJitterForce, LinearNoiseForce, LinearRandomForce, LinearSinkForce, LinearSourceForce, LinearUserDefinedForce, and LinearVectorForce. Definition at line 24 of file baseForce.cxx.

---

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

• panda/src/physics/baseForce.h
• panda/src/physics/baseForce.cxx
• panda/src/physics/baseForce.I

---