Panda3D
|
Pure virtual particle renderer base class. More...
#include "baseParticleRenderer.h"
Public Types | |
enum | ParticleRendererAlphaMode { PR_ALPHA_NONE, PR_ALPHA_OUT, PR_ALPHA_IN, PR_ALPHA_IN_OUT, PR_ALPHA_USER, PR_NOT_INITIALIZED_YET } |
enum | ParticleRendererBlendMethod { PP_NO_BLEND, PP_BLEND_LINEAR, PP_BLEND_CUBIC } |
Public Member Functions | |
virtual | ~BaseParticleRenderer () |
Destructor. | |
ParticleRendererAlphaMode | get_alpha_mode () const |
bool | get_ignore_scale () const |
Returns the "ignore scale" flag. | |
int | get_ref_count () const |
Returns the current reference count. | |
GeomNode * | get_render_node () const |
Query the geomnode pointer. | |
NodePath | get_render_node_path () const |
Query the geomnode pointer. | |
float | get_user_alpha () const |
gets alpha for "user" alpha mode | |
WeakReferenceList * | get_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 BaseParticleRenderer * | make_copy ()=0 |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *, void *) |
void | operator delete[] (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) |
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_alpha_mode (ParticleRendererAlphaMode am) |
void | set_color_blend_mode (ColorBlendAttrib::Mode bm, ColorBlendAttrib::Operand oa=ColorBlendAttrib::O_zero, ColorBlendAttrib::Operand ob=ColorBlendAttrib::O_zero) |
sets the ColorBlendAttrib on the _render_node | |
void | set_ignore_scale (bool ignore_scale) |
Sets the "ignore scale" flag. | |
void | set_user_alpha (float ua) |
sets alpha for "user" alpha mode | |
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 | |
BaseParticleRenderer (ParticleRendererAlphaMode alpha_decay=PR_ALPHA_NONE) | |
Default Constructor. | |
BaseParticleRenderer (const BaseParticleRenderer ©) | |
Copy Constructor. | |
CPT (RenderState) _render_state | |
void | disable_alpha () |
kills the intermediate alpha node/arc | |
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. | |
void | enable_alpha () |
Builds an intermediate node and transition that enables alpha channeling. | |
float | get_cur_alpha (BaseParticle *bp) |
gets current alpha for a particle | |
virtual void | resize_pool (int new_size)=0 |
void | update_alpha_mode (ParticleRendererAlphaMode am) |
handles the base class part of alpha updating. | |
Protected Attributes | |
ParticleRendererAlphaMode | _alpha_mode |
Friends | |
class | ParticleSystem |
Pure virtual particle renderer base class.
Definition at line 34 of file baseParticleRenderer.h.
BaseParticleRenderer::~BaseParticleRenderer | ( | ) | [virtual] |
Destructor.
Definition at line 62 of file baseParticleRenderer.cxx.
BaseParticleRenderer::BaseParticleRenderer | ( | ParticleRendererAlphaMode | alpha_decay = PR_ALPHA_NONE | ) | [protected] |
Default Constructor.
Definition at line 28 of file baseParticleRenderer.cxx.
References update_alpha_mode().
BaseParticleRenderer::BaseParticleRenderer | ( | const BaseParticleRenderer & | copy | ) | [protected] |
Copy Constructor.
Definition at line 45 of file baseParticleRenderer.cxx.
References set_ignore_scale(), and update_alpha_mode().
void BaseParticleRenderer::disable_alpha | ( | ) | [protected] |
kills the intermediate alpha node/arc
Definition at line 154 of file baseParticleRenderer.cxx.
Referenced by update_alpha_mode().
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 BaseParticleRenderer::enable_alpha | ( | ) | [protected] |
Builds an intermediate node and transition that enables alpha channeling.
Definition at line 143 of file baseParticleRenderer.cxx.
Referenced by update_alpha_mode().
float BaseParticleRenderer::get_cur_alpha | ( | BaseParticle * | bp | ) | [inline, protected] |
gets current alpha for a particle
Definition at line 109 of file baseParticleRenderer.I.
bool BaseParticleRenderer::get_ignore_scale | ( | ) | const [inline] |
Returns the "ignore scale" flag.
See set_ignore_scale().
Definition at line 99 of file baseParticleRenderer.I.
int ReferenceCount::get_ref_count | ( | ) | const [inline, inherited] |
Returns the current reference count.
Definition at line 155 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by TransformState::clear_cache(), RenderState::clear_cache(), RenderState::finalize(), RenderEffects::finalize(), RenderEffect::finalize(), RenderAttrib::finalize(), InternalName::finalize(), TransformState::get_num_unused_states(), RenderState::get_num_unused_states(), TransformState::list_cycles(), RenderState::list_cycles(), GeomVertexFormat::remove_column(), TransformState::unref(), RenderState::unref(), RenderState::~RenderState(), and TransformState::~TransformState().
GeomNode * BaseParticleRenderer::get_render_node | ( | ) | const [inline] |
Query the geomnode pointer.
Definition at line 21 of file baseParticleRenderer.I.
Referenced by SpriteParticleRenderer::~SpriteParticleRenderer().
NodePath BaseParticleRenderer::get_render_node_path | ( | ) | const [inline] |
Query the geomnode pointer.
Definition at line 31 of file baseParticleRenderer.I.
float BaseParticleRenderer::get_user_alpha | ( | ) | const [inline] |
gets alpha for "user" alpha mode
Definition at line 70 of file baseParticleRenderer.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 BaseParticleRenderer::output | ( | ostream & | out | ) | const [virtual] |
Write a string representation of this instance to <out>.
Reimplemented in GeomParticleRenderer, LineParticleRenderer, PointParticleRenderer, SparkleParticleRenderer, and SpriteParticleRenderer.
Definition at line 96 of file baseParticleRenderer.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 BaseParticleRenderer::set_color_blend_mode | ( | ColorBlendAttrib::Mode | bm, |
ColorBlendAttrib::Operand | oa = ColorBlendAttrib::O_zero , |
||
ColorBlendAttrib::Operand | ob = ColorBlendAttrib::O_zero |
||
) | [inline] |
sets the ColorBlendAttrib on the _render_node
Definition at line 80 of file baseParticleRenderer.I.
void BaseParticleRenderer::set_ignore_scale | ( | bool | ignore_scale | ) |
Sets the "ignore scale" flag.
When this is true, particles will be drawn as if they had no scale, regardless of whatever scale might be inherited from above the render node in the scene graph.
This flag is mainly useful to support legacy code that was written for a very early version of Panda, whose sprite particle renderer had a bug that incorrectly ignored the inherited scale.
Definition at line 79 of file baseParticleRenderer.cxx.
Referenced by BaseParticleRenderer().
void BaseParticleRenderer::set_user_alpha | ( | float | ua | ) | [inline] |
sets alpha for "user" alpha mode
Definition at line 60 of file baseParticleRenderer.I.
bool ReferenceCount::test_ref_count_integrity | ( | ) | const [inline, 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 236 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by EggGroupNode::add_child(), InternalName::find_ancestor(), InternalName::get_ancestor(), ReferenceCount::get_ref_count(), InternalName::get_top(), ReferenceCount::ref(), EggVertex::test_gref_integrity(), EggVertex::test_pref_integrity(), EggNode::test_under_integrity(), EggPrimitive::test_vref_integrity(), EggGroup::test_vref_integrity(), MouseWatcher::throw_event_pattern(), ReferenceCount::unref(), and EggNode::update_under().
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 BaseParticleRenderer::update_alpha_mode | ( | ParticleRendererAlphaMode | am | ) | [protected] |
handles the base class part of alpha updating.
Definition at line 124 of file baseParticleRenderer.cxx.
References disable_alpha(), and enable_alpha().
Referenced by BaseParticleRenderer().
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 BaseParticleRenderer::write | ( | ostream & | out, |
int | indent = 0 |
||
) | const [virtual] |
Write a string representation of this instance to <out>.
Reimplemented in GeomParticleRenderer, LineParticleRenderer, PointParticleRenderer, SparkleParticleRenderer, and SpriteParticleRenderer.
Definition at line 109 of file baseParticleRenderer.cxx.