Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends

ParticleSystem Class Reference

Contains and manages a particle system. More...

#include "particleSystem.h"

Inheritance diagram for ParticleSystem:
Physical TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

List of all members.

Public Types

typedef pvector< PT(AngularForce)> AngularForceVector
typedef pvector< PT(LinearForce)> LinearForceVector

Public Member Functions

 ParticleSystem (int pool_size=0)
 Default Constructor.
 ParticleSystem (const ParticleSystem &copy)
 Copy Constructor.
 ~ParticleSystem ()
 You get the ankles and I'll get the wrists.
void add_angular_force (AngularForce *f)
 Adds an angular force to the force list.
void add_linear_force (LinearForce *f)
 Adds a linear force to the force list.
void add_physics_object (PhysicsObject *po)
 Adds an object to the physics object vector.
void add_spawn_template (ParticleSystem *ps)
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
void clear_angular_forces ()
 Erases the angular force list.
void clear_floor_z ()
void clear_linear_forces ()
 Erases the linear force list.
void clear_physics_objects ()
 Erases the object list.
void clear_spawn_templates ()
void clear_to_initial ()
 Resets the system to its start state by resizing to 0, then resizing back to current size.
virtual TypeHandle force_init_type ()
bool get_active_system_flag () const
const AngularForceVector & get_angular_forces () const
int get_best_parent_from_Set (const std::set< int > &) const
float get_birth_rate () const
BaseParticleEmitterget_emitter () const
BaseParticleFactoryget_factory () const
float get_floor_z () const
bool get_i_was_spawned_flag () const
const LinearForceVector & get_linear_forces () const
int get_litter_size () const
int get_litter_spread () const
int get_living_particles () const
bool get_local_velocity_flag () const
int get_num_angular_forces () const
int get_num_linear_forces () const
const PhysicsObject::Vector & get_object_vector () const
const PhysicsObjectCollection get_objects () const
PhysicsObjectget_phys_body () const
PhysicalNodeget_physical_node () const
NodePath get_physical_node_path () const
PhysicsManagerget_physics_manager () const
int get_pool_size () const
int get_ref_count () const
 Returns the current reference count.
NodePath get_render_parent () const
BaseParticleRendererget_renderer () const
float get_soft_birth_rate () const
bool get_spawn_on_death_flag () const
PandaNodeget_spawn_render_node () const
NodePath get_spawn_render_node_path () const
float get_system_age () const
bool get_system_grows_older_flag () const
float get_system_lifespan () const
virtual TypeHandle get_type () const
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
float get_viscosity () const
 Get the local viscosity.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
void induce_labor ()
 Forces the birth of a particle litter this frame by resetting _tics_since_birth.
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
 MAKE_SEQ (get_linear_forces, get_num_linear_forces, get_linear_force)
 MAKE_SEQ (get_angular_forces, get_num_angular_forces, get_angular_force)
void operator delete (void *ptr)
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete (void *ptr, void *)
void operator delete[] (void *ptr)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *, void *)
void * operator new (size_t size)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
virtual void output (ostream &out) const
 Write a string representation of this instance to <out>.
 PT (LinearForce) get_linear_force(int index) const
 PT (AngularForce) get_angular_force(int index) const
void ref () const
 Explicitly increments the reference count.
void remove_angular_force (AngularForce *f)
 removes an angular force from the force list
void remove_linear_force (LinearForce *f)
 removes a linear force from the force list
void render ()
 Populates an attached GeomNode structure with the particle geometry for rendering.
void set_active_system_flag (bool a)
void set_birth_rate (float new_br)
void set_emitter (BaseParticleEmitter *e)
void set_factory (BaseParticleFactory *f)
void set_floor_z (float z)
void set_litter_size (int new_ls)
void set_litter_spread (int new_ls)
void set_local_velocity_flag (bool lv)
void set_pool_size (int size)
void set_render_parent (const NodePath &node)
void set_render_parent (PandaNode *node)
void set_renderer (BaseParticleRenderer *r)
void set_soft_birth_rate (float new_br)
void set_spawn_on_death_flag (bool sod)
void set_spawn_render_node (PandaNode *node)
void set_spawn_render_node_path (const NodePath &node)
void set_system_age (float age)
void set_system_grows_older_flag (bool sgo)
void set_system_lifespan (float sl)
void set_template_system_flag (bool tsf)
void set_viscosity (float viscosity)
 Set the local viscosity.
void soft_start (float br=0.0)
 Causes system to use birth rate set by set_birth_rate()
void soft_stop (float br=0.0)
 Causes system to use birth rate set by set_soft_birth_rate()
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool unref () const
 Explicitly decrements the reference count.
void update (float dt)
 Updates the particle system.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.
virtual void write (ostream &out, int indent=0) const
 Write a string representation of this instance to <out>.
virtual void write (ostream &out=cout, unsigned int indent=0) const
 Write a string representation of this instance to <out>.
virtual void write_angular_forces (ostream &out=cout, unsigned int indent=0) const
 Write a string representation of this instance to <out>.
virtual void write_free_particle_fifo (ostream &out, int indent=0) const
 Write a string representation of this instance to <out>.
virtual void write_linear_forces (ostream &out=cout, unsigned int indent=0) const
 Write a string representation of this instance to <out>.
virtual void write_physics_objects (ostream &out=cout, unsigned int indent=0) const
 Write a string representation of this instance to <out>.
virtual void write_spawn_templates (ostream &out, int indent=0) const
 Write a string representation of this instance to <out>.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Protected Member Functions

bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.

Protected Attributes

AngularForceVector _angular_forces
LinearForceVector _linear_forces
PhysicsObject_phys_body
PhysicsObject::Vector _physics_objects
float _viscosity

Friends

class ParticleSystemManager
class PhysicalNode
class PhysicsManager

Detailed Description

Contains and manages a particle system.

Definition at line 42 of file particleSystem.h.


Constructor & Destructor Documentation

ParticleSystem::ParticleSystem ( int  pool_size = 0)

Default Constructor.

Definition at line 44 of file particleSystem.cxx.

References Physical::clear_physics_objects().

ParticleSystem::ParticleSystem ( const ParticleSystem copy)

Copy Constructor.

Definition at line 89 of file particleSystem.cxx.

References NodePath::reparent_to().

ParticleSystem::~ParticleSystem ( )

You get the ankles and I'll get the wrists.

Definition at line 124 of file particleSystem.cxx.

References NodePath::remove_node().


Member Function Documentation

void Physical::add_angular_force ( AngularForce f) [inline, inherited]

Adds an angular force to the force list.

Definition at line 66 of file physical.I.

void Physical::add_linear_force ( LinearForce f) [inline, inherited]

Adds a linear force to the force list.

Definition at line 56 of file physical.I.

void Physical::add_physics_object ( PhysicsObject po) [inline, inherited]

Adds an object to the physics object vector.

Definition at line 114 of file physical.I.

Referenced by Physical::Physical().

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 110 of file typedObject.I.

void Physical::clear_angular_forces ( ) [inline, inherited]

Erases the angular force list.

Definition at line 34 of file physical.I.

void Physical::clear_linear_forces ( ) [inline, inherited]

Erases the linear force list.

Definition at line 23 of file physical.I.

void Physical::clear_physics_objects ( ) [inline, inherited]

Erases the object list.

Definition at line 45 of file physical.I.

Referenced by ParticleSystem().

void ParticleSystem::clear_to_initial ( ) [inline]

Resets the system to its start state by resizing to 0, then resizing back to current size.

Definition at line 48 of file particleSystem.I.

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
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 52 of file typedObject.I.

References TypeHandle::get_index().

float Physical::get_viscosity ( ) const [inline, inherited]

Get the local viscosity.

Definition at line 235 of file physical.I.

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

void ParticleSystem::induce_labor ( ) [inline]

Forces the birth of a particle litter this frame by resetting _tics_since_birth.

Definition at line 36 of file particleSystem.I.

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

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from Physical.

Definition at line 170 of file particleSystem.h.

References Physical::init_type().

bool TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
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 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

void ParticleSystem::output ( ostream &  out) const [virtual]

Write a string representation of this instance to <out>.

Reimplemented from Physical.

Definition at line 702 of file particleSystem.cxx.

void 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.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

void Physical::remove_angular_force ( AngularForce f) [inline, inherited]

removes an angular force from the force list

Definition at line 96 of file physical.I.

void Physical::remove_linear_force ( LinearForce f) [inline, inherited]

removes a linear force from the force list

Definition at line 76 of file physical.I.

void ParticleSystem::render ( ) [inline]

Populates an attached GeomNode structure with the particle geometry for rendering.

This is a wrapper for accessability.

Definition at line 24 of file particleSystem.I.

Referenced by ParticleSystemManager::do_particles().

void Physical::set_viscosity ( float  viscosity) [inline, inherited]

Set the local viscosity.

Definition at line 225 of file physical.I.

void ParticleSystem::soft_start ( float  br = 0.0) [inline]

Causes system to use birth rate set by set_birth_rate()

Definition at line 68 of file particleSystem.I.

void ParticleSystem::soft_stop ( float  br = 0.0) [inline]

Causes system to use birth rate set by set_soft_birth_rate()

Definition at line 83 of file particleSystem.I.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool ReferenceCount::unref ( ) const [inline, virtual, 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.) 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 true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void ParticleSystem::update ( float  dt)

Updates the particle system.

Call once per frame.

Definition at line 468 of file particleSystem.cxx.

References PhysicsObject::get_position().

Referenced by ParticleSystemManager::do_particles().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().

void ParticleSystem::write ( ostream &  out,
int  indent = 0 
) const [virtual]

Write a string representation of this instance to <out>.

Definition at line 753 of file particleSystem.cxx.

References write_free_particle_fifo(), and write_spawn_templates().

void Physical::write ( ostream &  out = cout,
unsigned int  indent = 0 
) const [virtual, inherited]

Write a string representation of this instance to <out>.

Definition at line 213 of file physical.cxx.

References PhysicsObject::write(), Physical::write_angular_forces(), Physical::write_linear_forces(), and Physical::write_physics_objects().

void Physical::write_angular_forces ( ostream &  out = cout,
unsigned int  indent = 0 
) const [virtual, inherited]

Write a string representation of this instance to <out>.

Definition at line 194 of file physical.cxx.

Referenced by Physical::write().

void ParticleSystem::write_free_particle_fifo ( ostream &  out,
int  indent = 0 
) const [virtual]

Write a string representation of this instance to <out>.

Definition at line 715 of file particleSystem.cxx.

Referenced by write().

void Physical::write_linear_forces ( ostream &  out = cout,
unsigned int  indent = 0 
) const [virtual, inherited]

Write a string representation of this instance to <out>.

Definition at line 175 of file physical.cxx.

Referenced by Physical::write().

void Physical::write_physics_objects ( ostream &  out = cout,
unsigned int  indent = 0 
) const [virtual, inherited]

Write a string representation of this instance to <out>.

Definition at line 156 of file physical.cxx.

Referenced by Physical::write().

void ParticleSystem::write_spawn_templates ( ostream &  out,
int  indent = 0 
) const [virtual]

Write a string representation of this instance to <out>.

Definition at line 734 of file particleSystem.cxx.

Referenced by write().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations