wavelength 1.0.0
Loading...
Searching...
No Matches
RndParticleSysAnim Class Reference

Animation of the start colour range, the end colour range, and the emission rate of a particle system. More...

#include <rndparticlesysanim.h>

Inheritance diagram for RndParticleSysAnim:
Collaboration diagram for RndParticleSysAnim:

Public Member Functions

 RndParticleSysAnim (const char *pszName)
 Construct an animation of nothing without keys.
 ~RndParticleSysAnim () override
 Drop the references on the particle system and the frames owner.
float EndFrame () override
 Report the frame of the last key of any channel of the frames owner.
void ListAnimObjects (std::list< RndObject * > &objects) override
 Add the particle system to a list, then the objects of the children.
int SetFrameSelf (float fFrame) override
 Apply a frame to the particle system.
void DumpText (PrnStream &stream) override
 Write a description of the animation and its base.
void Save (BinStream &stream) override
 Write the animation and its base.
void Replace (RndObject *pFrom, RndObject *pTo) override
 Replace the particle system or the frames owner with another object.
const char * ClassName () const override
 Report the class name.
void Copy (const RndObject *pSource, int nFlags) override
 Copy another animation and its base.
void Load (BinStream &stream) override
 Read what Save() wrote, or an earlier version of it.
Public Member Functions inherited from RndAnimatable
 RndAnimatable ()
 Construct an animatable at frame 0 without children or filters.
 ~RndAnimatable () override
 Drop the references on the children and delete the filters.
RndAnimatable * Parent ()
 Find the animatable whose children include this one.
void SetFrame (float fFrame)
 Filter a frame, apply it, and pass the result on to the children.
float FilterFrame (float fValue)
 Run a frame through the filters.
float UnfilterFrame (float fValue)
 Run a filtered frame back through the filters, last first.
float ChildrenEndFrame ()
 Report the latest end frame of the children, unfiltered through this animatable.
bool AddAnim (RndAnimatable *pAnim)
 Append a child.
void RemoveAnim (RndAnimatable *pAnim)
 Remove a child.
void RemoveAllAnims ()
 Remove every child.
const std::list< Filter * > & GetFilters () const
float GetFrame () const
float GetFilteredFrame () const
const std::list< RndAnimatable * > & GetAnims () const
std::list< Filter * > & GetFilters ()
Public Member Functions inherited from RndObject
 RndObject (const char *pszName)
 Construct an object and register it under a name.
virtual ~RndObject ()
 Notify every referrer, then erase the registration.
void SetName (const char *pszName)
 Register the object under a different name.
void AddRef (RndObject *pReferrer)
 Register an object as a store of a pointer to this one.
void RemoveRef (RndObject *pReferrer)
 Drop the first registration AddRef() made for a referrer.
const char * GetName () const
const std::list< RndObject * > & GetRefs () const
int GetInternal () const
void SetInternal (int nInternal)

Static Public Member Functions

static RndObject * New (const char *pszName)
 Create an animation.
Static Public Member Functions inherited from RndAnimatable
static Filter * NewFilter (int nType)
 Create a filter stage of a type, with its parameters unset.
static void CollectChildren (std::list< RndObject * > &objects, RndAnimatable *pAnimatable)
 Append every animation descendant of an animatable, depth first, each before its descendants.

Static Public Attributes

static constexpr int kCopyShareKeys = 0x80
 The bit of the Copy() flags that shares the source's keys rather than copying them.
static const char * sClassName
 The class name a .rnd file writes, ParticleSysAnim.
static int sRev
 The format version Save() writes and Load() accepts.
Static Public Attributes inherited from RndAnimatable
static int sRev
 The format version Save() writes and Load() accepts.
Static Public Attributes inherited from RndObject
static constexpr int kCopyChildLists = 0x200
 The bit of the Copy() flags that copies the child lists of the mix-ins.

Protected Member Functions

void ReleaseRefs ()
 Drop the references on the particle system and the frames owner.
void AcquireRefs ()
 Take references on the particle system and the frames owner.
Protected Member Functions inherited from RndAnimatable
void ReleaseObjects ()
 Drop the references on the children without emptying the list, and delete the filters.
void AcquireAnimRefs ()
 Take a reference on every child.

Additional Inherited Members

Public Types inherited from RndAnimatable
enum  FilterType {
  kFilterScaleOffset = 0 , kFilterMinMaxLoop = 1 , kFilterZeroOrder = 2 , kFilterFirstOrder = 3 ,
  kFilterSecondOrder = 4
}
 The type tags of the filters, as Save() writes them. More...
Protected Attributes inherited from RndAnimatable
std::list< RndAnimatable * > mAnims
std::list< Filter * > mFilters
float mFrame
float mFilteredFrame
Protected Attributes inherited from RndObject
std::list< RndObject * > mRefs
String mName

Detailed Description

Animation of the start colour range, the end colour range, and the emission rate of a particle system.

The RTTI includes the class name and records RndAnimatable as the one base. The keys may belong to another animation, the frames owner. Several animations then share one set. A colour key moves a range by its low end and retains its width. An emission rate key sets the low end of the rate, and the high end follows at the ratio the two ends had.

Constructor & Destructor Documentation

◆ RndParticleSysAnim()

RndParticleSysAnim::RndParticleSysAnim ( const char * pszName)
explicit

Construct an animation of nothing without keys.

The animation is its own frames owner. The binary expands the constructor inline in New().

Parameters
pszNameThe registry key.

◆ ~RndParticleSysAnim()

RndParticleSysAnim::~RndParticleSysAnim ( )
override

Drop the references on the particle system and the frames owner.

Ghidra address:
NTSC-U/C: 0x003909b0
Ghidra address:
PAL: 0x003ff0b8

Member Function Documentation

◆ EndFrame()

float RndParticleSysAnim::EndFrame ( )
overridevirtual

Report the frame of the last key of any channel of the frames owner.

Returns
The frame, or 0 without keys.
Ghidra address:
NTSC-U/C: 0x00240498
Ghidra address:
PAL: 0x00248fc8

Reimplemented from RndAnimatable.

◆ ListAnimObjects()

void RndParticleSysAnim::ListAnimObjects ( std::list< RndObject * > & objects)
overridevirtual

Add the particle system to a list, then the objects of the children.

Parameters
objectsThe list to add to.
Ghidra address:
NTSC-U/C: 0x002403d8
Ghidra address:
PAL: 0x00248f08

Reimplemented from RndAnimatable.

◆ SetFrameSelf()

int RndParticleSysAnim::SetFrameSelf ( float fFrame)
overridevirtual

Apply a frame to the particle system.

Each channel with keys sets its part of the system.

Parameters
fFrameThe frame.
Returns
1, to pass the frame on to the children.
Ghidra address:
NTSC-U/C: 0x00240550
Ghidra address:
PAL: 0x00249080

Reimplemented from RndAnimatable.

◆ DumpText()

void RndParticleSysAnim::DumpText ( PrnStream & stream)
overridevirtual

Write a description of the animation and its base.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x0023fde8
Ghidra address:
PAL: 0x00248918

Reimplemented from RndAnimatable.

◆ Save()

void RndParticleSysAnim::Save ( BinStream & stream)
overridevirtual

Write the animation and its base.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x0023ff40
Ghidra address:
PAL: 0x00248a70

Reimplemented from RndAnimatable.

◆ Replace()

void RndParticleSysAnim::Replace ( RndObject * pFrom,
RndObject * pTo )
overridevirtual

Replace the particle system or the frames owner with another object.

A replacement of another class, or null, clears the particle system. A frames owner replaced by null becomes the animation itself.

Parameters
pFromThe object being replaced.
pToThe replacement, or null.
Ghidra address:
NTSC-U/C: 0x0023fc68
Ghidra address:
PAL: 0x00248798

Reimplemented from RndAnimatable.

◆ ClassName()

const char * RndParticleSysAnim::ClassName ( ) const
inlineoverridevirtual

Report the class name.

Returns
sClassName.
Ghidra address:
NTSC-U/C: 0x00390d08
Ghidra address:
PAL: 0x003ff410

Implements RndObject.

◆ Copy()

void RndParticleSysAnim::Copy ( const RndObject * pSource,
int nFlags )
overridevirtual

Copy another animation and its base.

The keys are copied when the source has its own and the flags do not include kCopyShareKeys. Otherwise the source's frames owner becomes this one's.

Parameters
pSourceThe animation to copy from.
nFlagsThe set of fields to copy.
Ghidra address:
NTSC-U/C: 0x002402e8
Ghidra address:
PAL: 0x00248e18

Reimplemented from RndAnimatable.

◆ Load()

void RndParticleSysAnim::Load ( BinStream & stream)
overridevirtual

Read what Save() wrote, or an earlier version of it.

Version 1 adds the emission rate ratio.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x002400e0
Ghidra address:
PAL: 0x00248c10

Reimplemented from RndAnimatable.

◆ New()

RndObject * RndParticleSysAnim::New ( const char * pszName)
inlinestatic

Create an animation.

Parameters
pszNameThe registry key.
Returns
The animation.
Ghidra address:
NTSC-U/C: 0x00390d18
Ghidra address:
PAL: 0x003ff420

◆ ReleaseRefs()

void RndParticleSysAnim::ReleaseRefs ( )
protected

Drop the references on the particle system and the frames owner.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x00240040
Ghidra address:
PAL: 0x00248b70

◆ AcquireRefs()

void RndParticleSysAnim::AcquireRefs ( )
protected

Take references on the particle system and the frames owner.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x00240090
Ghidra address:
PAL: 0x00248bc0

Member Data Documentation

◆ kCopyShareKeys

int RndParticleSysAnim::kCopyShareKeys = 0x80
staticconstexpr

The bit of the Copy() flags that shares the source's keys rather than copying them.

◆ sClassName

const char* RndParticleSysAnim::sClassName
static

The class name a .rnd file writes, ParticleSysAnim.

Ghidra address:
NTSC-U/C: 0x003b0a40
Ghidra address:
PAL: 0x0042f8d8

◆ sRev

int RndParticleSysAnim::sRev
static

The format version Save() writes and Load() accepts.

Ghidra address:
NTSC-U/C: 0x003b0a44
Ghidra address:
PAL: 0x0042f8dc

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