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

BaseParticleEmitter Class Reference

Describes a physical region in space in which particles are randomly generated. More...

#include "baseParticleEmitter.h"

Inheritance diagram for BaseParticleEmitter:
ReferenceCount MemoryBase BoxEmitter DiscEmitter LineEmitter PointEmitter RectangleEmitter RingEmitter SphereSurfaceEmitter SphereVolumeEmitter TangentRingEmitter

List of all members.

Public Types

enum  emissionType { ET_EXPLICIT, ET_RADIATE, ET_CUSTOM }

Public Member Functions

virtual ~BaseParticleEmitter ()
 destructor
void generate (LPoint3f &pos, LVector3f &vel)
 parent generation function
float get_amplitude () const
 amplitude query
float get_amplitude_spread () const
 amplitude spread query
emissionType get_emission_type () const
 emission type query
LVector3f get_explicit_launch_vector () const
 query for explicit emission launch vector
LVector3f get_offset_force () const
 user-defined force
LPoint3f get_radiate_origin () const
 query for explicit emission launch vector
int get_ref_count () const
 Returns the current reference count.
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.
virtual BaseParticleEmittermake_copy ()=0
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
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 ref () const
 Explicitly increments the reference count.
void set_amplitude (float a)
 amplitude assignment
void set_amplitude_spread (float as)
 amplitude spread assignment
void set_emission_type (emissionType et)
 emission type assignment
void set_explicit_launch_vector (const LVector3f &elv)
 assignment of explicit emission launch vector
void set_offset_force (const LVector3f &of)
 user-defined force
void set_radiate_origin (const LPoint3f &ro)
 assignment of radiate emission origin point
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

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

Protected Attributes

float _amplitude
float _amplitude_spread
emissionType _emission_type
LVector3f _explicit_launch_vector
LPoint3f _radiate_origin

Detailed Description

Describes a physical region in space in which particles are randomly generated.

Definition at line 31 of file baseParticleEmitter.h.


Constructor & Destructor Documentation

BaseParticleEmitter::~BaseParticleEmitter ( ) [virtual]

destructor

Definition at line 55 of file baseParticleEmitter.cxx.

BaseParticleEmitter::BaseParticleEmitter ( ) [protected]

constructor

Definition at line 25 of file baseParticleEmitter.cxx.

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

copy constructor

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

void BaseParticleEmitter::generate ( LPoint3f pos,
LVector3f vel 
)

parent generation function

Definition at line 64 of file baseParticleEmitter.cxx.

References LVecBase3f::normalize().

float BaseParticleEmitter::get_amplitude ( ) const [inline]

amplitude query

Definition at line 91 of file baseParticleEmitter.I.

float BaseParticleEmitter::get_amplitude_spread ( ) const [inline]

amplitude spread query

Definition at line 111 of file baseParticleEmitter.I.

BaseParticleEmitter::emissionType BaseParticleEmitter::get_emission_type ( ) const [inline]

emission type query

Definition at line 31 of file baseParticleEmitter.I.

LVector3f BaseParticleEmitter::get_explicit_launch_vector ( ) const [inline]

query for explicit emission launch vector

Definition at line 51 of file baseParticleEmitter.I.

LVector3f BaseParticleEmitter::get_offset_force ( ) const [inline]

user-defined force

Definition at line 131 of file baseParticleEmitter.I.

LPoint3f BaseParticleEmitter::get_radiate_origin ( ) const [inline]

query for explicit emission launch vector

Definition at line 71 of file baseParticleEmitter.I.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
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 BaseParticleEmitter::output ( ostream &  out) const [virtual]

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

Reimplemented in ArcEmitter, BoxEmitter, DiscEmitter, LineEmitter, PointEmitter, RectangleEmitter, RingEmitter, SphereSurfaceEmitter, SphereVolumeEmitter, and TangentRingEmitter.

Definition at line 94 of file baseParticleEmitter.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 BaseParticleEmitter::set_amplitude ( float  a) [inline]

amplitude assignment

Definition at line 81 of file baseParticleEmitter.I.

void BaseParticleEmitter::set_amplitude_spread ( float  as) [inline]

amplitude spread assignment

Definition at line 101 of file baseParticleEmitter.I.

void BaseParticleEmitter::set_emission_type ( emissionType  et) [inline]

emission type assignment

Definition at line 21 of file baseParticleEmitter.I.

void BaseParticleEmitter::set_explicit_launch_vector ( const LVector3f elv) [inline]

assignment of explicit emission launch vector

Definition at line 41 of file baseParticleEmitter.I.

void BaseParticleEmitter::set_offset_force ( const LVector3f of) [inline]

user-defined force

Definition at line 121 of file baseParticleEmitter.I.

void BaseParticleEmitter::set_radiate_origin ( const LPoint3f ro) [inline]

assignment of radiate emission origin point

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

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

Reimplemented in ArcEmitter, BoxEmitter, DiscEmitter, LineEmitter, PointEmitter, RectangleEmitter, RingEmitter, SphereSurfaceEmitter, SphereVolumeEmitter, and TangentRingEmitter.

Definition at line 107 of file baseParticleEmitter.cxx.


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