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

LinearSinkForce Class Reference

Attractor force. More...

#include <linearSinkForce.h>

Inheritance diagram for LinearSinkForce:

LinearDistanceForce LinearForce BaseForce TypedReferenceCount TypedObject ReferenceCount List of all members.

Public Types

enum  FalloffType { FT_ONE_OVER_R, FT_ONE_OVER_R_SQUARED, FT_ONE_OVER_R_CUBED }

Public Member Functions

 LinearSinkForce (const LPoint3f &p, FalloffType f, float r, float a=1.0f, bool m=true)
 Simple constructor.

 LinearSinkForce (void)
 Simple constructor.

 LinearSinkForce (const LinearSinkForce &copy)
 copy constructor

virtual ~LinearSinkForce (void)
 Simple destructor.

virtual TypeHandle get_type (void) const
virtual TypeHandle force_init_type ()
void set_radius (float r)
 set the radius

void set_falloff_type (FalloffType ft)
 falloff_type encapsulating wrap

void set_force_center (const LPoint3f &p)
 set the force center

float get_radius (void) const
 radius query

FalloffType get_falloff_type (void) const
 falloff_type query

LPoint3f get_force_center (void) const
 force_center query

float get_scalar_term (void) const
 calculate the term based on falloff

void set_amplitude (const float a)
void set_mass_dependent (bool m)
float get_amplitude (void) const
bool get_mass_dependent (void) const
void set_vector_masks (bool x, bool y, bool z)
virtual LVector3f get_vector (const PhysicsObject *po)
virtual bool is_linear (void) const
bool get_active (void) const
void set_active (bool active)
ForceNodeget_force_node (void) const
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)

Private Member Functions

virtual LVector3f get_child_vector (const PhysicsObject *po)
 virtual force query

virtual LinearForcemake_copy (void)
 copier


Static Private Attributes

TypeHandle _type_handle

Detailed Description

Attractor force.

Think black hole.

Definition at line 34 of file linearSinkForce.h.


Member Enumeration Documentation

enum LinearDistanceForce::FalloffType [inherited]
 

Enumeration values:
FT_ONE_OVER_R 
FT_ONE_OVER_R_SQUARED 
FT_ONE_OVER_R_CUBED 

Definition at line 38 of file linearDistanceForce.h.


Constructor & Destructor Documentation

LinearSinkForce::LinearSinkForce const LPoint3f &  p,
FalloffType  f,
float  r,
float  a = 1.0f,
bool  m = true
 

Simple constructor.

Definition at line 35 of file linearSinkForce.cxx.

LinearSinkForce::LinearSinkForce void   ) 
 

Simple constructor.

Definition at line 49 of file linearSinkForce.cxx.

Referenced by LinearSinkForce().

LinearSinkForce::LinearSinkForce const LinearSinkForce &  copy  ) 
 

copy constructor

Definition at line 63 of file linearSinkForce.cxx.

References LinearSinkForce().

LinearSinkForce::~LinearSinkForce void   )  [virtual]
 

Simple destructor.

Definition at line 76 of file linearSinkForce.cxx.

References LinearDistanceForce::get_force_center(), PhysicsObject::get_position(), and LinearDistanceForce::get_scalar_term().


Member Function Documentation

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

Reimplemented from LinearDistanceForce.

Definition at line 58 of file linearSinkForce.h.

bool BaseForce::get_active void   )  const [inline, inherited]
 

Definition at line 51 of file baseForce.I.

float LinearForce::get_amplitude void   )  const [inline, inherited]
 

Definition at line 40 of file linearForce.I.

References LinearForce::_mass_dependent, and INLINE.

LVector3f LinearSinkForce::get_child_vector const PhysicsObject po  )  [private, virtual]
 

virtual force query

Implements LinearDistanceForce.

Definition at line 101 of file linearSinkForce.cxx.

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

Reimplemented from LinearDistanceForce.

Definition at line 47 of file linearSinkForce.h.

LinearDistanceForce::FalloffType LinearDistanceForce::get_falloff_type void   )  const [inline, inherited]
 

falloff_type query

Definition at line 70 of file linearDistanceForce.I.

References LinearDistanceForce::_force_center, and INLINE.

LPoint3f LinearDistanceForce::get_force_center void   )  const [inline, inherited]
 

force_center query

Definition at line 96 of file linearDistanceForce.I.

Referenced by ~LinearSinkForce(), and LinearSourceForce::~LinearSourceForce().

ForceNode * BaseForce::get_force_node void   )  const [inline, inherited]
 

Definition at line 29 of file baseForce.I.

References BaseForce::_active, and INLINE.

bool LinearForce::get_mass_dependent void   )  const [inline, inherited]
 

Definition at line 51 of file linearForce.I.

References LinearForce::_mass_dependent.

float LinearDistanceForce::get_radius void   )  const [inline, inherited]
 

radius query

Definition at line 83 of file linearDistanceForce.I.

References LinearDistanceForce::_falloff, LinearDistanceForce::_radius, LinearDistanceForce::FT_ONE_OVER_R_CUBED, LinearDistanceForce::FT_ONE_OVER_R_SQUARED, 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().

float LinearDistanceForce::get_scalar_term void   )  const [inline, inherited]
 

calculate the term based on falloff

Definition at line 109 of file linearDistanceForce.I.

Referenced by ~LinearSinkForce(), and LinearSourceForce::~LinearSourceForce().

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

Reimplemented from LinearDistanceForce.

Definition at line 55 of file linearSinkForce.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.

LVector3f LinearForce::get_vector const PhysicsObject po  )  [virtual, inherited]
 

Implements BaseForce.

Definition at line 83 of file linearForce.cxx.

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

Reimplemented from LinearDistanceForce.

Definition at line 50 of file linearSinkForce.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 LinearForce::is_linear void   )  const [virtual, inherited]
 

Implements BaseForce.

Definition at line 105 of file linearForce.cxx.

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

LinearForce * LinearSinkForce::make_copy void   )  [private, virtual]
 

copier

Implements LinearDistanceForce.

Definition at line 88 of file linearSinkForce.cxx.

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, inherited]
 

Definition at line 40 of file baseForce.I.

References BaseForce::_active, and INLINE.

void LinearForce::set_amplitude const float  a  )  [inline, inherited]
 

Definition at line 29 of file linearForce.I.

References LinearForce::_amplitude, and INLINE.

void LinearDistanceForce::set_falloff_type FalloffType  ft  )  [inline, inherited]
 

falloff_type encapsulating wrap

Definition at line 31 of file linearDistanceForce.I.

References LinearDistanceForce::_radius, and INLINE.

void LinearDistanceForce::set_force_center const LPoint3f &  p  )  [inline, inherited]
 

set the force center

Definition at line 57 of file linearDistanceForce.I.

void LinearForce::set_mass_dependent bool  m  )  [inline, inherited]
 

Definition at line 62 of file linearForce.I.

References LinearForce::_y_mask, LinearForce::_z_mask, and y.

void LinearDistanceForce::set_radius float  r  )  [inline, inherited]
 

set the radius

Definition at line 44 of file linearDistanceForce.I.

References LinearDistanceForce::_force_center, and INLINE.

void LinearForce::set_vector_masks bool  x,
bool  y,
bool  z
[inline, inherited]
 

Definition at line 73 of file linearForce.I.

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 LinearSinkForce::_type_handle [static, private]
 

Reimplemented from LinearDistanceForce.

Definition at line 24 of file linearSinkForce.cxx.


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