Panda3D
Public Member Functions
SpriteParticleRenderer Class Reference

Renders a particle system with high-speed nasty trick sprites. More...

#include "spriteParticleRenderer.h"

Inheritance diagram for SpriteParticleRenderer:
BaseParticleRenderer ReferenceCount MemoryBase

List of all members.

Public Member Functions

 SpriteParticleRenderer (Texture *tex=(Texture *) NULL)
 constructor
 SpriteParticleRenderer (const SpriteParticleRenderer &copy)
 copy constructor
virtual ~SpriteParticleRenderer ()
 destructor
void add_from_node (const NodePath &node_path, bool size_from_texels=false, bool resize=false)
 This will allow the renderer to randomly choose from more than one texture or sequence at particle birth.
void add_from_node (const NodePath &node_path, const string &model, const string &node, bool size_from_texels=false, bool resize=false)
 This will allow the renderer to randomly choose from more than one texture or sequence at particle birth.
void add_texture (Texture *tex, PN_stdfloat texels_per_unit=1.0f, bool resize=false)
 Adds texture to image pool, effectively creating a single frame animation that can be selected at particle birth.
ParticleRendererBlendMethod get_alpha_blend_method () const
bool get_alpha_disable () const
SpriteAnimget_anim (const int n) const
bool get_anim_angle_flag () const
bool get_animate_frames_enable () const
int get_animate_frames_index () const
PN_stdfloat get_animate_frames_rate () const
LColor get_color () const
ColorInterpolationManagerget_color_interpolation_manager () const
PN_stdfloat get_final_x_scale () const
PN_stdfloat get_final_y_scale () const
PN_stdfloat get_height () const
 Returns the height of each particle in world units.
PN_stdfloat get_initial_x_scale () const
PN_stdfloat get_initial_y_scale () const
SpriteAnimget_last_anim () const
LTexCoord get_ll_uv () const
 Returns the UV coordinate of the lower-left corner; see set_ll_uv().
LTexCoord get_ll_uv (const int anim, const int frame) const
 Returns the UV coordinate of the lower-left corner; see set_ll_uv().
PN_stdfloat get_nonanimated_theta () const
int get_num_anims () const
Textureget_texture () const
Textureget_texture (const int anim, const int frame) const
LTexCoord get_ur_uv () const
 Returns the UV coordinate of the lower-left corner; see set_ur_uv().
LTexCoord get_ur_uv (const int anim, const int frame) const
 Returns the UV coordinate of the upper-right corner; see set_ur_uv().
PN_stdfloat get_width () const
 Returns the width of each particle in world units.
bool get_x_scale_flag () const
bool get_y_scale_flag () const
virtual BaseParticleRenderermake_copy ()
 child dynamic copy
 MAKE_SEQ (get_anims, get_num_anims, get_anim)
virtual void output (ostream &out) const
 Write a string representation of this instance to <out>.
void remove_animation (const int n)
 Removes an animation texture set from the renderer.
void set_alpha_blend_method (ParticleRendererBlendMethod bm)
void set_alpha_disable (bool ad)
void set_anim_angle_flag (bool animate_theta)
void set_animate_frames_enable (bool an)
void set_animate_frames_index (int i)
void set_animate_frames_rate (PN_stdfloat r)
void set_color (const LColor &color)
void set_final_x_scale (PN_stdfloat final_x_scale)
void set_final_y_scale (PN_stdfloat final_y_scale)
void set_from_node (const NodePath &node_path, bool size_from_texels=false)
 Sets the properties on this renderer from the geometry referenced by the indicated NodePath.
void set_from_node (const NodePath &node_path, const string &model, const string &node, bool size_from_texels=false)
 If the source type is important, use this one.
void set_initial_x_scale (PN_stdfloat initial_x_scale)
void set_initial_y_scale (PN_stdfloat initial_y_scale)
void set_ll_uv (const LTexCoord &ll_uv)
 Sets the UV coordinate of the lower-left corner of all the sprites generated by this renderer.
void set_ll_uv (const LTexCoord &ll_uv, const int anim, const int frame)
 Sets the UV coordinate of the lower-left corner of all the sprites generated by this renderer.
void set_nonanimated_theta (PN_stdfloat theta)
void set_size (PN_stdfloat width, PN_stdfloat height)
 Sets the size of each particle in world units.
void set_texture (Texture *tex, PN_stdfloat texels_per_unit=1.0f)
 Sets the renderer up to render the entire texture image.
void set_ur_uv (const LTexCoord &ur_uv)
 Sets the UV coordinate of the upper-right corner of all the sprites generated by this renderer.
void set_ur_uv (const LTexCoord &ur_uv, const int anim, const int frame)
 Sets the UV coordinate of the upper-right corner of all the sprites generated by this renderer.
void set_x_scale_flag (bool animate_x_ratio)
void set_y_scale_flag (bool animate_y_ratio)
virtual void write (ostream &out, int indent_level=0) const
 Write a string representation of this instance to <out>.

Detailed Description

Renders a particle system with high-speed nasty trick sprites.

Definition at line 161 of file spriteParticleRenderer.h.


Constructor & Destructor Documentation

constructor

Definition at line 42 of file spriteParticleRenderer.cxx.

References set_texture().

Referenced by make_copy().

copy constructor

Definition at line 75 of file spriteParticleRenderer.cxx.


Member Function Documentation

void SpriteParticleRenderer::add_from_node ( const NodePath node_path,
bool  size_from_texels = false,
bool  resize = false 
)

This will allow the renderer to randomly choose from more than one texture or sequence at particle birth.

If resize is true, or if there are no textures currently on the renderer, it will force the renderer to use the size information from this node from now on. (Default is false)

Definition at line 289 of file spriteParticleRenderer.cxx.

References GeomNode::get_num_geoms(), Geom::get_num_primitives(), GeomPrimitive::get_num_vertices(), GeomPrimitive::get_vertex(), NodePath::is_empty(), and set_size().

Referenced by add_from_node(), and set_from_node().

void SpriteParticleRenderer::add_from_node ( const NodePath node_path,
const string &  model,
const string &  node,
bool  size_from_texels = false,
bool  resize = false 
)

This will allow the renderer to randomly choose from more than one texture or sequence at particle birth.

If the source type is important, use this one.

model and node should lead to node_path like this: node_path = loader.loadModel(model).find(node)

If resize is true, or if there are no textures currently on the renderer, it will force the renderer to use the size information from this node from now on. (Default is false)

Definition at line 266 of file spriteParticleRenderer.cxx.

References add_from_node().

void SpriteParticleRenderer::add_texture ( Texture tex,
PN_stdfloat  texels_per_unit = 1.0f,
bool  resize = false 
) [inline]

Adds texture to image pool, effectively creating a single frame animation that can be selected at particle birth.

This should only be called after a previous call to set_texture().

Definition at line 53 of file spriteParticleRenderer.I.

References Texture::get_filename(), Texture::get_x_size(), Texture::get_y_size(), set_size(), and set_texture().

PN_stdfloat SpriteParticleRenderer::get_height ( ) const [inline]

Returns the height of each particle in world units.

Definition at line 404 of file spriteParticleRenderer.I.

Returns the UV coordinate of the lower-left corner; see set_ll_uv().

Definition at line 347 of file spriteParticleRenderer.I.

LTexCoord SpriteParticleRenderer::get_ll_uv ( const int  anim,
const int  frame 
) const [inline]

Returns the UV coordinate of the lower-left corner; see set_ll_uv().

Definition at line 358 of file spriteParticleRenderer.I.

Returns the UV coordinate of the lower-left corner; see set_ur_uv().

Definition at line 371 of file spriteParticleRenderer.I.

LTexCoord SpriteParticleRenderer::get_ur_uv ( const int  anim,
const int  frame 
) const [inline]

Returns the UV coordinate of the upper-right corner; see set_ur_uv().

Definition at line 382 of file spriteParticleRenderer.I.

PN_stdfloat SpriteParticleRenderer::get_width ( ) const [inline]

Returns the width of each particle in world units.

Definition at line 394 of file spriteParticleRenderer.I.

child dynamic copy

Implements BaseParticleRenderer.

Definition at line 119 of file spriteParticleRenderer.cxx.

References SpriteParticleRenderer().

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

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

Reimplemented from BaseParticleRenderer.

Definition at line 783 of file spriteParticleRenderer.cxx.

void SpriteParticleRenderer::remove_animation ( const int  n) [inline]

Removes an animation texture set from the renderer.

Definition at line 78 of file spriteParticleRenderer.I.

void SpriteParticleRenderer::set_from_node ( const NodePath node_path,
bool  size_from_texels = false 
)

Sets the properties on this renderer from the geometry referenced by the indicated NodePath.

This should be a reference to a GeomNode or a SequenceNode; it extracts out the texture and UV range from the node.

This will remove all previously added textures and animations. It will also resize the renderer to match this new geometry.

If node_path refers to a GeomNode(or has one beneath it) the texture, its size, and UV data will be extracted from that.

If node_path references a SequenceNode(or has one beneath it) with multiple GeomNodes beneath it, the size data will correspond only to the first GeomNode found with a valid texture, while the texture and UV information will be stored for each individual node.

If size_from_texels is true, the particle size is based on the number of texels in the source image; otherwise, it is based on the size of the first polygon found in the node.

model and node are the two items used to construct node_path. If the source type is important, use set_from_node(NodePath,string,string,bool) instead.

Definition at line 241 of file spriteParticleRenderer.cxx.

References add_from_node(), and NodePath::is_empty().

void SpriteParticleRenderer::set_from_node ( const NodePath node_path,
const string &  model,
const string &  node,
bool  size_from_texels = false 
)

If the source type is important, use this one.

model and node should lead to node_path like this: node_path = loader.loadModel(model).find(node)

This will remove all previously add textures and resize the renderer to match the new geometry.

Definition at line 202 of file spriteParticleRenderer.cxx.

References add_from_node().

void SpriteParticleRenderer::set_ll_uv ( const LTexCoord ll_uv) [inline]

Sets the UV coordinate of the lower-left corner of all the sprites generated by this renderer.

Normally this is (0, 0), but it might be set to something else to use only a portion of the texture.

Definition at line 102 of file spriteParticleRenderer.I.

void SpriteParticleRenderer::set_ll_uv ( const LTexCoord ll_uv,
const int  anim,
const int  frame 
) [inline]

Sets the UV coordinate of the lower-left corner of all the sprites generated by this renderer.

Normally this is (0, 0), but it might be set to something else to use only a portion of the texture.

Definition at line 115 of file spriteParticleRenderer.I.

void SpriteParticleRenderer::set_size ( PN_stdfloat  width,
PN_stdfloat  height 
) [inline]

Sets the size of each particle in world units.

Definition at line 155 of file spriteParticleRenderer.I.

Referenced by add_from_node(), add_texture(), and set_texture().

void SpriteParticleRenderer::set_texture ( Texture tex,
PN_stdfloat  texels_per_unit = 1.0f 
) [inline]

Sets the renderer up to render the entire texture image.

The scale of each particle is based on the size of the texture in each dimension, modified by texels_per_unit.

Used to set the size of the particles. Will clear all previously loaded textures and animations.

Definition at line 28 of file spriteParticleRenderer.I.

References Texture::get_filename(), Texture::get_x_size(), Texture::get_y_size(), and set_size().

Referenced by add_texture(), and SpriteParticleRenderer().

void SpriteParticleRenderer::set_ur_uv ( const LTexCoord ur_uv) [inline]

Sets the UV coordinate of the upper-right corner of all the sprites generated by this renderer.

Normally this is (1, 1), but it might be set to something else to use only a portion of the texture.

Definition at line 130 of file spriteParticleRenderer.I.

void SpriteParticleRenderer::set_ur_uv ( const LTexCoord ur_uv,
const int  anim,
const int  frame 
) [inline]

Sets the UV coordinate of the upper-right corner of all the sprites generated by this renderer.

Normally this is (1, 1), but it might be set to something else to use only a portion of the texture.

Definition at line 143 of file spriteParticleRenderer.I.

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

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

Reimplemented from BaseParticleRenderer.

Definition at line 796 of file spriteParticleRenderer.cxx.


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