Panda3D
Public Member Functions | Static Public Member Functions | Protected Member Functions

BaseParticleFactory Class Reference

Pure Virtual base class for creating particles. More...

#include "baseParticleFactory.h"

Inheritance diagram for BaseParticleFactory:
ReferenceCount MemoryBase OrientedParticleFactory PointParticleFactory ZSpinParticleFactory

List of all members.

Public Member Functions

virtual ~BaseParticleFactory ()
 destructor
virtual BaseParticlealloc_particle () const =0
float get_lifespan_base () const
 public
float get_lifespan_spread () const
 public
float get_mass_base () const
 public
float get_mass_spread () const
 public
int get_ref_count () const
 Returns the current reference count.
float get_terminal_velocity_base () const
 public
float get_terminal_velocity_spread () const
 public
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 local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
virtual void output (ostream &out) const
 Write a string representation of this instance to <out>.
void populate_particle (BaseParticle *bp)
 public
void ref () const
 Explicitly increments the reference count.
void set_lifespan_base (float lb)
 public
void set_lifespan_spread (float ls)
 public
void set_mass_base (float mb)
 public
void set_mass_spread (float ms)
 public
void set_terminal_velocity_base (float tvb)
 public
void set_terminal_velocity_spread (float tvs)
 public
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 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>.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()

Protected Member Functions

 BaseParticleFactory ()
 constructor
 BaseParticleFactory (const BaseParticleFactory &copy)
 copy constructor
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.

Detailed Description

Pure Virtual base class for creating particles.

Definition at line 30 of file baseParticleFactory.h.


Constructor & Destructor Documentation

BaseParticleFactory::~BaseParticleFactory ( ) [virtual]

destructor

Definition at line 55 of file baseParticleFactory.cxx.

BaseParticleFactory::BaseParticleFactory ( ) [protected]

constructor

Definition at line 23 of file baseParticleFactory.cxx.

BaseParticleFactory::BaseParticleFactory ( const BaseParticleFactory copy) [protected]

copy constructor

Definition at line 39 of file baseParticleFactory.cxx.


Member Function Documentation

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

float BaseParticleFactory::get_lifespan_base ( ) const [inline]

public

Definition at line 76 of file baseParticleFactory.I.

float BaseParticleFactory::get_lifespan_spread ( ) const [inline]

public

Definition at line 85 of file baseParticleFactory.I.

float BaseParticleFactory::get_mass_base ( ) const [inline]

public

Definition at line 94 of file baseParticleFactory.I.

float BaseParticleFactory::get_mass_spread ( ) const [inline]

public

Definition at line 103 of file baseParticleFactory.I.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
float BaseParticleFactory::get_terminal_velocity_base ( ) const [inline]

public

Definition at line 112 of file baseParticleFactory.I.

float BaseParticleFactory::get_terminal_velocity_spread ( ) const [inline]

public

Definition at line 121 of file baseParticleFactory.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 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 BaseParticleFactory::output ( ostream &  out) const [virtual]

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

Reimplemented in OrientedParticleFactory, PointParticleFactory, and ZSpinParticleFactory.

Definition at line 83 of file baseParticleFactory.cxx.

void BaseParticleFactory::populate_particle ( BaseParticle bp)
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 BaseParticleFactory::set_lifespan_base ( float  lb) [inline]

public

Definition at line 20 of file baseParticleFactory.I.

void BaseParticleFactory::set_lifespan_spread ( float  ls) [inline]

public

Definition at line 29 of file baseParticleFactory.I.

void BaseParticleFactory::set_mass_base ( float  mb) [inline]

public

Definition at line 38 of file baseParticleFactory.I.

void BaseParticleFactory::set_mass_spread ( float  ms) [inline]

public

Definition at line 48 of file baseParticleFactory.I.

void BaseParticleFactory::set_terminal_velocity_base ( float  tvb) [inline]

public

Definition at line 58 of file baseParticleFactory.I.

void BaseParticleFactory::set_terminal_velocity_spread ( float  tvs) [inline]

public

Definition at line 67 of file baseParticleFactory.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 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 BaseParticleFactory::write ( ostream &  out,
int  indent = 0 
) const [virtual]

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

Reimplemented in PointParticleFactory, and ZSpinParticleFactory.

Definition at line 96 of file baseParticleFactory.cxx.


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