makVrv::DtFxParticleDesc Class Reference

a subclass of bdiParticleDesc, currently reimplements all of configuration file reading and writing.

Inheritance diagram for makVrv::DtFxParticleDesc:

Public Member Functions
	DtFxParticleDesc ()
virtual	~DtFxParticleDesc ()
	DtFxParticleDesc (const DtFxParticleDesc &rhs)
DtFxParticleDesc &	operator= (const DtFxParticleDesc &orig)
virtual void	reset ()
virtual int	read_cfg_entries (bdiCfgEntry *cfg_entry)
virtual int	write_cfg_entries (bdiCfgReader *cfg_reader)
virtual bdiCfgEntry *	create_cfg_entry ()
virtual void	set_texture_name (const char *chTexFile)
virtual void	set_normal_texture_name (const char *chTexFile)
virtual void	setFileSouce (const char *file_source)
virtual void	setEdited (bool edited)
virtual bool	edited ()
virtual void	setDiffuseTexture (osg::Texture2D *osg_diffuse_texture)
virtual void	setNormalTexture (osg::Texture2D *osg_normal_texture)
float	emissivityFactor ()
float	materialSpecularity ()
float	meterialMetallicness ()
float	hdrGain ()
float	translucency ()
float	softness ()
bool	useLighting ()
osg::Texture2D *	diffuseTexture ()
osg::Texture2D *	normalTexture ()
const bdiString &	fileSouce ()
const DtFxChildSystemArray &	childSystems ()

Static Public Member Functions
static float	smooth_interpolate_keys (FloatKeyFrameArray &array, char *prev_keyframe, float time)
static bdiVec4f	smooth_interpolate_keys (ColorKeyFrameArray &array, char *prev_keyframe, float time)
static float	smooth_interpolate_keys (FloatKeyFrameArray &array, float speed)
static bdiVec4f	smooth_interpolate_keys (ColorKeyFrameArray &array, float speed)

Public Attributes
bool	m_looked_up_normal_texture
bdiString	m_normal_map_file_name

Protected Attributes
bdiVec3f	m_position_offset
bdiVec3fPtrArray	m_additional_offsets
float	m_hdr_gain
float	m_emissivity_factor
float	m_material_specularity
float	m_material_metallicness
bool	m_use_lighting
float	m_translucency
float	m_softness
float	m_particle_mass
float	m_air_resistance_factor
float	m_rotation_variation
float	m_initial_rotation_variation
float	m_initial_velocity_scale
bool	m_normalized_animation_time
bool	m_color_by_age
bool	m_size_by_age
float	m_color_speed_scale
float	m_size_speed_scale
int	m_num_to_release_var
float	m_release_frequency_var
bool	m_normalize_light_time
float	m_light_in_fade_time
bool	m_emit_from_parent_particles
bool	m_emit_from_random_particle_index
bdiString	myFileSouce
bool	m_edited
osg::ref_ptr< osg::Texture2D >	myOsgDiffuseTexture
osg::ref_ptr< osg::Texture2D >	myOsgNormalTexture
DtFxCollisionObjectArray	m_collision_objects
DtFxChildSystemArray	m_child_system_descs
DtFxForceArray	m_additional_forces
int	myArtPartOverride
bdiVec3f	myArtPartOverrideOffset
bdiString	mySizeScript
bdiString	myLifeTimeScript
bdiString	myReleaseRateScript
bdiString	myStreakScript
bdiString	myColorScript
bdiString	myRotationSpeedScript
bdiString	myVelocityScript

Friends
class	DtFxParticleSystem
class	bdiQWidgetParticleSystem

Constructor & Destructor Documentation

makVrv::DtFxParticleDesc::DtFxParticleDesc

(

)

default ctor

virtual makVrv::DtFxParticleDesc::~DtFxParticleDesc ( )

virtual

default dtor

makVrv::DtFxParticleDesc::DtFxParticleDesc

(

const DtFxParticleDesc &

rhs

)

copy constructor

Member Function Documentation

DtFxParticleDesc& makVrv::DtFxParticleDesc::operator=

(

const DtFxParticleDesc &

orig

)

assignment operator

virtual void makVrv::DtFxParticleDesc::reset ( )

virtual

resets values

virtual int makVrv::DtFxParticleDesc::read_cfg_entries ( bdiCfgEntry *  cfg_entry )

virtual

reads the description from a config entry

virtual int makVrv::DtFxParticleDesc::write_cfg_entries ( bdiCfgReader *  cfg_reader )

virtual

writes the description into reader (unused)

virtual bdiCfgEntry* makVrv::DtFxParticleDesc::create_cfg_entry ( )

virtual

creates a config entry from the description

virtual void makVrv::DtFxParticleDesc::set_texture_name ( const char *  chTexFile )

virtual

sets the texture name

virtual void makVrv::DtFxParticleDesc::set_normal_texture_name ( const char *  chTexFile )

virtual

sets the normal texture name

virtual void makVrv::DtFxParticleDesc::setFileSouce ( const char *  file_source )

virtual

sets the file source

virtual void makVrv::DtFxParticleDesc::setEdited ( bool  edited )

virtual

gets if the desc has been edited

virtual bool makVrv::DtFxParticleDesc::edited ( )

virtual

gets if the desc has been edited

virtual void makVrv::DtFxParticleDesc::setDiffuseTexture ( osg::Texture2D *  osg_diffuse_texture )

virtual

set the diffuse texture

virtual void makVrv::DtFxParticleDesc::setNormalTexture ( osg::Texture2D *  osg_normal_texture )

virtual

set the normal texture

float makVrv::DtFxParticleDesc::emissivityFactor ( )

inline

these are lightweight accessor called multiple times a frame, meant to avoid friends but also avoiding perf hitshow much will system radiate in the dark

float makVrv::DtFxParticleDesc::materialSpecularity ( )

inline

how much specularity will the material have

float makVrv::DtFxParticleDesc::meterialMetallicness ( )

inline

how metallics is the system

float makVrv::DtFxParticleDesc::hdrGain ( )

inline

brightness multiplier on colors

float makVrv::DtFxParticleDesc::translucency ( )

inline

modifies the amount of light that passes through the particles

float makVrv::DtFxParticleDesc::softness ( )

inline

modifies the amount of light that passes through the particles

bool makVrv::DtFxParticleDesc::useLighting ( )

inline

should lighting be enabled on this system

osg::Texture2D* makVrv::DtFxParticleDesc::diffuseTexture ( )

inline

particle system's diffuse texture

osg::Texture2D* makVrv::DtFxParticleDesc::normalTexture ( )

inline

these are lightweight accessor called multiple times a frame, meant to avoid friends but also avoiding perf hitshow much will system radiate in the dark

const bdiString& makVrv::DtFxParticleDesc::fileSouce ( )

inline

which file the system was from

const DtFxChildSystemArray& makVrv::DtFxParticleDesc::childSystems ( )

inline

list of child systems to create

static float makVrv::DtFxParticleDesc::smooth_interpolate_keys ( FloatKeyFrameArray &  array, char *  prev_keyframe, float  time  )

static

helper functions that can move into base class

static bdiVec4f makVrv::DtFxParticleDesc::smooth_interpolate_keys ( ColorKeyFrameArray &  array, char *  prev_keyframe, float  time  )

static

helper functions that could move into base class

static float makVrv::DtFxParticleDesc::smooth_interpolate_keys ( FloatKeyFrameArray &  array, float  speed  )

static

helper functions that can move into base class

static bdiVec4f makVrv::DtFxParticleDesc::smooth_interpolate_keys ( ColorKeyFrameArray &  array, float  speed  )

static

helper functions that could move into base class

Friends And Related Function Documentation

friend class DtFxParticleSystem

friend

friend class bdiQWidgetParticleSystem

friend

Member Data Documentation

bool makVrv::DtFxParticleDesc::m_looked_up_normal_texture

bdiString makVrv::DtFxParticleDesc::m_normal_map_file_name

bdiVec3f makVrv::DtFxParticleDesc::m_position_offset

protected

additional data added by vantage position offset of psystem

bdiVec3fPtrArray makVrv::DtFxParticleDesc::m_additional_offsets

protected

float makVrv::DtFxParticleDesc::m_hdr_gain

protected

multiplier for hdr

float makVrv::DtFxParticleDesc::m_emissivity_factor

protected

multiplier for emissivity

float makVrv::DtFxParticleDesc::m_material_specularity

protected

how much specularity will the material have

float makVrv::DtFxParticleDesc::m_material_metallicness

protected

how metallic is the system

bool makVrv::DtFxParticleDesc::m_use_lighting

protected

skip lighting calculations

float makVrv::DtFxParticleDesc::m_translucency

protected

modifies the amount of light that passes through the particles

float makVrv::DtFxParticleDesc::m_softness

protected

depth buffer softness smoothing

float makVrv::DtFxParticleDesc::m_particle_mass

protected

impacts how wind impacts particle.

float makVrv::DtFxParticleDesc::m_air_resistance_factor

protected

float makVrv::DtFxParticleDesc::m_rotation_variation

protected

noise rotation variation added to current rot speed

float makVrv::DtFxParticleDesc::m_initial_rotation_variation

protected

noise rotation at start

float makVrv::DtFxParticleDesc::m_initial_velocity_scale

protected

how the velocity of the emitter should get

bool makVrv::DtFxParticleDesc::m_normalized_animation_time

protected

should the the particle animation play out over the lifetime.

bool makVrv::DtFxParticleDesc::m_color_by_age

protected

bool makVrv::DtFxParticleDesc::m_size_by_age

protected

float makVrv::DtFxParticleDesc::m_color_speed_scale

protected

float makVrv::DtFxParticleDesc::m_size_speed_scale

protected

int makVrv::DtFxParticleDesc::m_num_to_release_var

protected

variable release rate

float makVrv::DtFxParticleDesc::m_release_frequency_var

protected

variable release rate

bool makVrv::DtFxParticleDesc::m_normalize_light_time

protected

should light time get normalized

float makVrv::DtFxParticleDesc::m_light_in_fade_time

protected

bool makVrv::DtFxParticleDesc::m_emit_from_parent_particles

protected

should this use parent system as emitter locations

bool makVrv::DtFxParticleDesc::m_emit_from_random_particle_index

protected

should this emit from a random particle or in order

bdiString makVrv::DtFxParticleDesc::myFileSouce

protected

which file is this from

bool makVrv::DtFxParticleDesc::m_edited

protected

has this description been edited

osg::ref_ptr<osg::Texture2D> makVrv::DtFxParticleDesc::myOsgDiffuseTexture

protected

osg lookup of texture

osg::ref_ptr<osg::Texture2D> makVrv::DtFxParticleDesc::myOsgNormalTexture

protected

DtFxCollisionObjectArray makVrv::DtFxParticleDesc::m_collision_objects

protected

DtFxChildSystemArray makVrv::DtFxParticleDesc::m_child_system_descs

protected

references to the other child systems

DtFxForceArray makVrv::DtFxParticleDesc::m_additional_forces

protected

list of additional forces

int makVrv::DtFxParticleDesc::myArtPartOverride

protected

bdiVec3f makVrv::DtFxParticleDesc::myArtPartOverrideOffset

protected

bdiString makVrv::DtFxParticleDesc::mySizeScript

protected

scripts

bdiString makVrv::DtFxParticleDesc::myLifeTimeScript

protected

bdiString makVrv::DtFxParticleDesc::myReleaseRateScript

protected

bdiString makVrv::DtFxParticleDesc::myStreakScript

protected

bdiString makVrv::DtFxParticleDesc::myColorScript

protected

bdiString makVrv::DtFxParticleDesc::myRotationSpeedScript

protected

bdiString makVrv::DtFxParticleDesc::myVelocityScript

protected

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvFx/DtFxParticleSystem.h