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

BaseParticleRenderer Class Reference

Pure virtual particle renderer base class. More...

#include <baseParticleRenderer.h>

Inheritance diagram for BaseParticleRenderer:

ReferenceCount GeomParticleRenderer LineParticleRenderer PointParticleRenderer SparkleParticleRenderer SpriteParticleRenderer List of all members.

Public Types

enum  ParticleRendererAlphaMode {
  PR_ALPHA_NONE, PR_ALPHA_OUT, PR_ALPHA_IN, PR_ALPHA_USER,
  PR_NOT_INITIALIZED_YET
}
enum  ParticleRendererBlendMethod { PP_NO_BLEND, PP_BLEND_LINEAR, PP_BLEND_CUBIC }

Public Member Functions

virtual ~BaseParticleRenderer (void)
 Destructor.

GeomNode * get_render_node (void) const
 Query the geomnode pointer.

void set_alpha_mode (ParticleRendererAlphaMode am)
ParticleRendererAlphaMode get_alpha_mode (void) const
void set_user_alpha (float ua)
 sets alpha for "user" alpha mode

float get_user_alpha (void) const
 gets alpha for "user" alpha mode

virtual BaseParticleRenderer * make_copy (void)=0
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 init_type ()

Protected Member Functions

 BaseParticleRenderer (ParticleRendererAlphaMode alpha_decay=PR_ALPHA_NONE)
 Default Constructor.

 BaseParticleRenderer (const BaseParticleRenderer &copy)
 Copy Constructor.

void update_alpha_mode (ParticleRendererAlphaMode am)
 handles the base class part of alpha updating.

void enable_alpha (void)
 Builds an intermediate node and transition that enables alpha channeling.

void disable_alpha (void)
 kills the intermediate alpha node/arc

float get_cur_alpha (BaseParticle *bp)
 gets current alpha for a particle

virtual void resize_pool (int new_size)=0
 CPT (RenderState) _render_state

Protected Attributes

ParticleRendererAlphaMode _alpha_mode

Private Member Functions

 PT (GeomNode) _render_node
virtual void birth_particle (int index)=0
virtual void kill_particle (int index)=0
virtual void init_geoms (void)=0
virtual void render (pvector< PT(PhysicsObject) > &po_vector, int ttl_particles)=0

Private Attributes

float _user_alpha

Friends

class ParticleSystem

Detailed Description

Pure virtual particle renderer base class.

Definition at line 43 of file baseParticleRenderer.h.

Member Enumeration Documentation

enum BaseParticleRenderer::ParticleRendererAlphaMode
 

Enumeration values:
PR_ALPHA_NONE 
PR_ALPHA_OUT 
PR_ALPHA_IN 
PR_ALPHA_USER 
PR_NOT_INITIALIZED_YET 

Definition at line 65 of file baseParticleRenderer.h.

Referenced by set_alpha_mode().

enum BaseParticleRenderer::ParticleRendererBlendMethod
 

Enumeration values:
PP_NO_BLEND 
PP_BLEND_LINEAR 
PP_BLEND_CUBIC 

Definition at line 73 of file baseParticleRenderer.h.

Referenced by SpriteParticleRenderer::get_y_scale_flag().

Constructor & Destructor Documentation

BaseParticleRenderer::~BaseParticleRenderer (  void   )  [virtual]
 

Destructor.

Definition at line 72 of file baseParticleRenderer.cxx.

BaseParticleRenderer::BaseParticleRenderer (  ParticleRendererAlphaMode  alpha_decay = PR_ALPHA_NONE  )  [protected]
 

Default Constructor.

Definition at line 36 of file baseParticleRenderer.cxx.

BaseParticleRenderer::BaseParticleRenderer (  const BaseParticleRenderer &  copy  )  [protected]
 

Copy Constructor.

Definition at line 54 of file baseParticleRenderer.cxx.

Member Function Documentation

virtual void BaseParticleRenderer::birth_particle (  int  index  )  [private, pure virtual]
 

Implemented in GeomParticleRenderer, LineParticleRenderer, PointParticleRenderer, SparkleParticleRenderer, and SpriteParticleRenderer.

BaseParticleRenderer::CPT (  RenderState   )  [protected]
 

void BaseParticleRenderer::disable_alpha (  void   )  [protected]
 

kills the intermediate alpha node/arc

Definition at line 99 of file baseParticleRenderer.cxx.

References _alpha_mode.

Referenced by enable_alpha().

void BaseParticleRenderer::enable_alpha (  void   )  [protected]
 

Builds an intermediate node and transition that enables alpha channeling.

Definition at line 86 of file baseParticleRenderer.cxx.

References _alpha_mode, disable_alpha(), and PR_ALPHA_NONE.

BaseParticleRenderer::ParticleRendererAlphaMode BaseParticleRenderer::get_alpha_mode (  void   )  const [inline]
 

Definition at line 54 of file baseParticleRenderer.I.

References _user_alpha.

TypeHandle ReferenceCount::get_class_type (  void   )  [inline, static, inherited]
 

Reimplemented in AnimBundle, AnimBundleNode, AnimChannel< SwitchType >, AnimChannelBase, AnimChannelFixed< SwitchType >, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimControl, AnimGroup, MovingPart< SwitchType >, MovingPartBase, MovingPartMatrix, MovingPartScalar, PartBundle, PartBundleNode, PartGroup, Character, CharacterJoint, CharacterJointBundle, CharacterSlider, ComputedVertices, CollisionEntry, CollisionHandler, CollisionHandlerEvent, CollisionHandlerFloor, CollisionHandlerPhysical, CollisionHandlerPusher, CollisionHandlerQueue, CollisionNode, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, CRGraphicsStateGuardian, CRSavedFrameBuffer, AnalogNode, ButtonNode, ClientAnalogDevice, ClientBase, ClientButtonDevice, ClientDevice, ClientDialDevice, ClientTrackerDevice, DialNode, MouseAndKeyboard, TrackerNode, VirtualMouse, DataNode, GraphicsChannel, GraphicsLayer, GraphicsPipe, GraphicsStateGuardian, GraphicsWindow, HardwareChannel, SavedFrameBuffer, CylindricalLens, FisheyeLens, ProjectionScreen, PSphereLens, DXGraphicsStateGuardian7, DXSavedFrameBuffer7, wdxGraphicsPipe7, wdxGraphicsWindow7, DXGraphicsStateGuardian8, DXSavedFrameBuffer8, wdxGraphicsPipe8, wdxGraphicsWindow8, EggAnimData, EggBin, EggBinMaker, EggComment, EggCoordinateSystem, EggCurve, EggData, EggExternalReference, EggFilenameNode, EggGroup, EggGroupNode, EggGroupUniquifier, EggMaterial, EggNamedObject, EggNameUniquifier, EggNode, EggNurbsCurve, EggNurbsSurface, EggObject, EggPoint, EggPolygon, EggPoolUniquifier, EggPrimitive, EggSAnimData, EggSurface, EggSwitchCondition, EggSwitchConditionDistance, EggTable, EggTexture, EggVertex, EggVertexPool, EggXfmAnimData, EggXfmSAnim, Event, EventStoreValueBase, EventStoreValue< Type >, RefCountProxy< Base >, RefCountObj< Base >, ThatThingie, ThisThingie, WhatAThingie, Thread, TypedReferenceCount, VirtualFile, VirtualFileComposite, VirtualFileSimple, WindowFramework, GLGraphicsStateGuardian, GLSavedFrameBuffer, glxGraphicsPipe, glxGraphicsStateGuardian, glxGraphicsWindow, dDrawable, Geom, GeomLine, GeomLinestrip, GeomPoint, GeomPolygon, GeomQuad, GeomSphere, GeomSprite, GeomTri, GeomTrifan, GeomTristrip, ImageBuffer, Lens, Material, MatrixLens, OrthographicLens, PerspectiveLens, PixelBuffer, Texture, GraphicsStateGuardianBase, Lerp, AutonomousLerp, LerpBlendType, EaseInBlendType, EaseOutBlendType, EaseInOutBlendType, NoBlendType, LerpFunctor, SimpleLerpFunctor< value >, SimpleQueryLerpFunctor< value >, MultiLerpFunctor, BoundingHexahedron, BoundingLine, BoundingSphere, BoundingVolume, FiniteBoundingVolume, GeometricBoundingVolume, OmniBoundingVolume, ClassicNurbsCurve, CubicCurveseg, HermiteCurve, NurbsPPCurve, ParametricCurve, PiecewiseCurve, RopeNode, AlphaTestAttrib, AmbientLight, BillboardEffect, Camera, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBin, CullBinAttrib, CullBinBackToFront, CullBinFixed, CullBinFrontToBack, CullBinUnsorted, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, DirectionalLight, Fog, FogAttrib, GeomNode, LensNode, Light, LightAttrib, LightLensNode, LightNode, LODNode, MaterialAttrib, ModelNode, ModelRoot, NodePathComponent, PosLerpFunctor, HprLerpFunctor, ScaleLerpFunctor, ColorLerpFunctor, PosHprLerpFunctor, HprScaleLerpFunctor, PosHprScaleLerpFunctor, ColorScaleLerpFunctor, PandaNode, PlaneNode, PointLight, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, SelectiveChildNode, SequenceNode, ShowBoundsEffect, Spotlight, SwitchNode, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, EventStoreTransform, TransparencyAttrib, PGButton, PGEntry, PGItem, PGMouseWatcherBackground, PGMouseWatcherGroup, PGMouseWatcherParameter, PGMouseWatcherRegion, PGTop, PGWaitBar, ActorNode, AngularForce, AngularVectorForce, BaseForce, ForceNode, LinearCylinderVortexForce, LinearDistanceForce, LinearForce, LinearFrictionForce, LinearJitterForce, LinearNoiseForce, LinearRandomForce, LinearSinkForce, LinearSourceForce, LinearUserDefinedForce, LinearVectorForce, Physical, PhysicalNode, PhysicsObject, BamReaderParam, ButtonEventList, FactoryParam, Person, Parent, Child, TypedWritableReferenceCount, WritableParam, RIBGraphicsWindow, RIBGraphicsStateGuardian, CasterShader, OutlineShader, PlanarReflector, ProjtexShader, ProjtexShadower, Shader, FrustumShader, SpheretexHighlighter, SpheretexReflector, SpheretexShader, SpotlightShader, TextFont, TextNode, ButtonThrower, DriveInterface, MouseWatcher, MouseWatcherGroup, MouseWatcherRegion, Trackball, Transform2SG, VrpnAnalogDevice, VrpnButtonDevice, VrpnClient, VrpnDialDevice, VrpnTrackerDevice, wcrGraphicsWindow, wglGraphicsPipe, wglGraphicsStateGuardian, wglGraphicsWindow, WinGraphicsPipe, WinGraphicsWindow, AnimChannel< ACScalarSwitchType >, AnimChannel< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, MovingPart< ACMatrixSwitchType >, SimpleLerpFunctor< LPoint3f >, SimpleLerpFunctor< LVecBase3f >, and SimpleLerpFunctor< LVecBase4f >.

Definition at line 66 of file referenceCount.h.

float BaseParticleRenderer::get_cur_alpha (  BaseParticle *  bp  )  [inline, protected]
 

gets current alpha for a particle

Definition at line 93 of file baseParticleRenderer.I.

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

GeomNode * BaseParticleRenderer::get_render_node (  void   )  const [inline]
 

Query the geomnode pointer.

Definition at line 31 of file baseParticleRenderer.I.

References init_geoms(), INLINE, and update_alpha_mode().

Referenced by SparkleParticleRenderer::kill_particle(), LineParticleRenderer::kill_particle(), and PointParticleRenderer::resize_pool().

float BaseParticleRenderer::get_user_alpha (  void   )  const [inline]
 

gets alpha for "user" alpha mode

Definition at line 80 of file baseParticleRenderer.I.

References _user_alpha, and PR_ALPHA_USER.

Referenced by GeomParticleRenderer::kill_particle().

virtual void BaseParticleRenderer::init_geoms (  void   )  [private, pure virtual]
 

Implemented in GeomParticleRenderer, LineParticleRenderer, PointParticleRenderer, SparkleParticleRenderer, and SpriteParticleRenderer.

Referenced by get_render_node().

void ReferenceCount::init_type (  void   )  [inline, static, inherited]
 

Reimplemented in AnimBundle, AnimBundleNode, AnimChannel< SwitchType >, AnimChannelBase, AnimChannelFixed< SwitchType >, AnimChannelMatrixXfmTable, AnimChannelScalarTable, AnimControl, AnimGroup, MovingPart< SwitchType >, MovingPartBase, MovingPartMatrix, MovingPartScalar, PartBundle, PartBundleNode, PartGroup, Character, CharacterJoint, CharacterJointBundle, CharacterSlider, ComputedVertices, CollisionEntry, CollisionHandler, CollisionHandlerEvent, CollisionHandlerFloor, CollisionHandlerPhysical, CollisionHandlerPusher, CollisionHandlerQueue, CollisionNode, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSolid, CollisionSphere, CRGraphicsStateGuardian, CRSavedFrameBuffer, AnalogNode, ButtonNode, ClientAnalogDevice, ClientBase, ClientButtonDevice, ClientDevice, ClientDialDevice, ClientTrackerDevice, DialNode, MouseAndKeyboard, TrackerNode, VirtualMouse, DataNode, GraphicsChannel, GraphicsLayer, GraphicsPipe, GraphicsStateGuardian, GraphicsWindow, HardwareChannel, SavedFrameBuffer, CylindricalLens, FisheyeLens, ProjectionScreen, PSphereLens, DXGraphicsStateGuardian7, DXSavedFrameBuffer7, wdxGraphicsPipe7, wdxGraphicsWindow7, DXGraphicsStateGuardian8, DXSavedFrameBuffer8, wdxGraphicsPipe8, wdxGraphicsWindow8, EggAnimData, EggBin, EggBinMaker, EggComment, EggCoordinateSystem, EggCurve, EggData, EggExternalReference, EggFilenameNode, EggGroup, EggGroupNode, EggGroupUniquifier, EggMaterial, EggNamedObject, EggNameUniquifier, EggNode, EggNurbsCurve, EggNurbsSurface, EggObject, EggPoint, EggPolygon, EggPoolUniquifier, EggPrimitive, EggSAnimData, EggSurface, EggSwitchCondition, EggSwitchConditionDistance, EggTable, EggTexture, EggVertex, EggVertexPool, EggXfmAnimData, EggXfmSAnim, Event, EventStoreValueBase, RefCountProxy< Base >, RefCountObj< Base >, ThatThingie, ThisThingie, WhatAThingie, Thread, TypedReferenceCount, VirtualFile, VirtualFileComposite, VirtualFileSimple, WindowFramework, GLGraphicsStateGuardian, GLSavedFrameBuffer, glxGraphicsPipe, glxGraphicsStateGuardian, glxGraphicsWindow, dDrawable, Geom, GeomLine, GeomLinestrip, GeomPoint, GeomPolygon, GeomQuad, GeomSphere, GeomSprite, GeomTri, GeomTrifan, GeomTristrip, ImageBuffer, Lens, Material, MatrixLens, OrthographicLens, PerspectiveLens, PixelBuffer, Texture, GraphicsStateGuardianBase, Lerp, AutonomousLerp, LerpBlendType, EaseInBlendType, EaseOutBlendType, EaseInOutBlendType, NoBlendType, LerpFunctor, SimpleLerpFunctor< value >, SimpleQueryLerpFunctor< value >, MultiLerpFunctor, BoundingHexahedron, BoundingLine, BoundingSphere, BoundingVolume, FiniteBoundingVolume, GeometricBoundingVolume, OmniBoundingVolume, ClassicNurbsCurve, CubicCurveseg, HermiteCurve, NurbsPPCurve, ParametricCurve, PiecewiseCurve, RopeNode, AlphaTestAttrib, AmbientLight, BillboardEffect, Camera, ClipPlaneAttrib, ColorAttrib, ColorBlendAttrib, ColorScaleAttrib, ColorWriteAttrib, CompassEffect, CullBin, CullBinAttrib, CullBinBackToFront, CullBinFixed, CullBinFrontToBack, CullBinUnsorted, CullFaceAttrib, DecalEffect, DepthOffsetAttrib, DepthTestAttrib, DepthWriteAttrib, DirectionalLight, Fog, FogAttrib, GeomNode, LensNode, Light, LightAttrib, LightLensNode, LightNode, LODNode, MaterialAttrib, ModelNode, ModelRoot, NodePathComponent, PosLerpFunctor, HprLerpFunctor, ScaleLerpFunctor, ColorLerpFunctor, PosHprLerpFunctor, HprScaleLerpFunctor, PosHprScaleLerpFunctor, ColorScaleLerpFunctor, PandaNode, PlaneNode, PointLight, RenderAttrib, RenderEffect, RenderEffects, RenderModeAttrib, RenderState, SelectiveChildNode, SequenceNode, ShowBoundsEffect, Spotlight, SwitchNode, TexMatrixAttrib, TextureApplyAttrib, TextureAttrib, TransformState, EventStoreTransform, TransparencyAttrib, PGButton, PGEntry, PGItem, PGMouseWatcherBackground, PGMouseWatcherGroup, PGMouseWatcherParameter, PGMouseWatcherRegion, PGTop, PGWaitBar, ActorNode, AngularForce, AngularVectorForce, BaseForce, ForceNode, LinearCylinderVortexForce, LinearDistanceForce, LinearForce, LinearFrictionForce, LinearJitterForce, LinearNoiseForce, LinearRandomForce, LinearSinkForce, LinearSourceForce, LinearUserDefinedForce, LinearVectorForce, Physical, PhysicalNode, PhysicsObject, BamReaderParam, ButtonEventList, FactoryParam, Person, Parent, Child, TypedWritableReferenceCount, WritableParam, RIBGraphicsWindow, RIBGraphicsStateGuardian, CasterShader, OutlineShader, PlanarReflector, ProjtexShader, ProjtexShadower, Shader, FrustumShader, SpheretexHighlighter, SpheretexReflector, SpheretexShader, SpotlightShader, TextFont, TextNode, ButtonThrower, DriveInterface, MouseWatcher, MouseWatcherGroup, MouseWatcherRegion, Trackball, Transform2SG, VrpnAnalogDevice, VrpnButtonDevice, VrpnClient, VrpnDialDevice, VrpnTrackerDevice, wcrGraphicsWindow, wglGraphicsPipe, wglGraphicsStateGuardian, wglGraphicsWindow, WinGraphicsPipe, WinGraphicsWindow, AnimChannel< ACScalarSwitchType >, AnimChannel< ACMatrixSwitchType >, MovingPart< ACScalarSwitchType >, MovingPart< ACMatrixSwitchType >, SimpleLerpFunctor< LPoint3f >, SimpleLerpFunctor< LVecBase3f >, and SimpleLerpFunctor< LVecBase4f >.

Definition at line 69 of file referenceCount.h.

References INLINE.

Referenced by ConfigureFn(), and ThatThingie::get_class_type().

virtual void BaseParticleRenderer::kill_particle (  int  index  )  [private, pure virtual]
 

Implemented in GeomParticleRenderer, LineParticleRenderer, PointParticleRenderer, SparkleParticleRenderer, and SpriteParticleRenderer.

virtual BaseParticleRenderer* BaseParticleRenderer::make_copy (  void   )  [pure virtual]
 

Implemented in GeomParticleRenderer, LineParticleRenderer, PointParticleRenderer, SparkleParticleRenderer, and SpriteParticleRenderer.

BaseParticleRenderer::PT (  GeomNode   )  [private]
 

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

virtual void BaseParticleRenderer::render (  pvector< PT(PhysicsObject) > &  po_vector,
int  ttl_particles
)  [private, pure virtual]
 

virtual void BaseParticleRenderer::resize_pool (  int  new_size  )  [protected, pure virtual]
 

Implemented in GeomParticleRenderer, LineParticleRenderer, PointParticleRenderer, SparkleParticleRenderer, and SpriteParticleRenderer.

void BaseParticleRenderer::set_alpha_mode (  BaseParticleRenderer::ParticleRendererAlphaMode  am  )  [inline]
 

Definition at line 42 of file baseParticleRenderer.I.

References _alpha_mode, INLINE, and ParticleRendererAlphaMode.

void BaseParticleRenderer::set_user_alpha (  float  ua  )  [inline]
 

sets alpha for "user" alpha mode

Definition at line 67 of file baseParticleRenderer.I.

References BaseParticle::get_parameterized_age(), INLINE, PR_ALPHA_IN, and PR_ALPHA_OUT.

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

void BaseParticleRenderer::update_alpha_mode (  ParticleRendererAlphaMode  am  )  [protected]
 

handles the base class part of alpha updating.

Definition at line 112 of file baseParticleRenderer.cxx.

Referenced by get_render_node().

Friends And Related Function Documentation

friend class ParticleSystem [friend]
 

Definition at line 109 of file baseParticleRenderer.h.

Member Data Documentation

ParticleRendererAlphaMode BaseParticleRenderer::_alpha_mode [protected]
 

Definition at line 90 of file baseParticleRenderer.h.

Referenced by disable_alpha(), enable_alpha(), GeomParticleRenderer::kill_particle(), SparkleParticleRenderer::render(), LineParticleRenderer::render(), and set_alpha_mode().

float BaseParticleRenderer::_user_alpha [private]
 

Definition at line 47 of file baseParticleRenderer.h.

Referenced by get_alpha_mode(), and get_user_alpha().

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