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

Particle system, PlayStation 2. More...

#include <psparticlesys.h>

Inheritance diagram for PsParticleSys:
Collaboration diagram for PsParticleSys:

Public Member Functions

 PsParticleSys (const char *pszName)
 Construct a system.
 ~PsParticleSys () override
int DrawShowing () override
 Draw the live particles of a sprite system in each pass of the material, without writing depth.
void DrawParticles ()
 Send the live particles to VU1 in batches of up to 162, each batch followed by a frame flush.
Public Member Functions inherited from RndParticleSys
 RndParticleSys (const char *pszName)
 Construct a system with a pool of 10 particles.
 ~RndParticleSys () override
 Free the particles and the pool.
void * operator new (size_t nSize)
 Allocate a system, billed to the class name.
void operator delete (void *pBlock)
 Release a system.
int SetFrameSelf (float fFrame) override
 Move the particles on to a frame, then emit for the elapsed frames unless SetEmitFrame() clocks the emission.
void ListDrawObjects (std::list< RndObject * > &objects) override
 Add the system, the material, and the textures of the material's stages, last first, to a list.
void ListDrawables (std::list< RndDrawable * > &drawables) override
 Add the system, when a live particle is inside the view volume of the current camera, then the children, to a list.
void DumpText (PrnStream &stream) override
 Write a description of the system and its bases.
void Save (BinStream &stream) override
 Write the system and its bases.
void Replace (RndObject *pFrom, RndObject *pTo) override
 Replace a referenced object with another in the bases, the material, and the pool owner.
const char * ClassName () const override
 Report the class name.
void Copy (const RndObject *pSource, int nFlags) override
 Copy another system and its bases.
void Load (BinStream &stream) override
 Read what Save() wrote, or an earlier version of it.
void SetNumParticles (int nCount)
 Set the pool size, then reallocate the pool of the owner.
void SetParticlesOwner (RndParticleSys *pOwner)
 Set the system whose pool this one draws from.
void SetMat (RndMat *pMat)
 Set the material the particles are drawn with.
int NumLiveParticles () const
 Report the number of live particles.
Particle * AllocParticle ()
 Move a particle from the free list of the owner to the head of the live list.
Particle * FreeParticle (Particle *pParticle)
 Move a live particle to the free list of the owner.
void FreeAllParticles ()
 Free every live particle.
void SetEmitFrame (float fFrame)
 Emit for the frames since the previous call, and clock the emission from then on in place of SetFrameSelf().
void ResetEmitFrame ()
 Return the emission clock to SetFrameSelf().
void SpawnParticles (float fDelta)
 Emit the particles the emission rate owes for a number of frames.
void RandomizeColorAndSize (Particle *pParticle)
 Give a particle a colour and a size from the start ranges.
void UpdateParticles (float fDelta)
 Free the particles outside their lives, and move and fade the others over a number of frames.
Particle * GetParticles () const
int GetBubble () const
void SetBubble (int nBubble)
const Vector2 & GetBubblePeriod () const
void SetBubblePeriod (const Vector2 &range)
const Vector2 & GetBubbleSize () const
Vector2 & GetBubbleSize ()
void SetBubbleSize (const Vector2 &range)
int GetCollide () const
void SetCollide (int nCollide)
const Plane & GetCollidePlane () const
void SetCollidePlane (const Plane &plane)
const Vector2 & GetEmitRate () const
Vector2 & GetEmitRate ()
const Color & GetEndColorHigh () const
Color & GetEndColorHigh ()
void SetEndColorHigh (const Color &color)
const Color & GetEndColorLow () const
Color & GetEndColorLow ()
void SetEndColorLow (const Color &color)
const Vector3 & GetForce () const
Vector3 & GetForce ()
void SetForce (const Vector3 &force)
const Vector2 & GetLife () const
Vector2 & GetLife ()
void SetLife (const Vector2 &range)
Particle * GetLiveParticles () const
Mode GetMode () const
void SetMode (Mode pMode)
int GetNumParticles () const
RndParticleSys * GetParticlesOwner () const
const Vector2 & GetPitch () const
void SetPitch (const Vector2 &range)
const Vector3 & GetPosHigh () const
Vector3 & GetPosHigh ()
void SetPosHigh (const Vector3 &pos)
const Vector3 & GetPosLow () const
Vector3 & GetPosLow ()
void SetPosLow (const Vector3 &pos)
int GetReadZ () const
void SetReadZ (int nReadZ)
const Vector2 & GetSize () const
Vector2 & GetSize ()
const Vector2 & GetSpeed () const
Vector2 & GetSpeed ()
void SetSpeed (const Vector2 &range)
const Color & GetStartColorHigh () const
Color & GetStartColorHigh ()
void SetStartColorHigh (const Color &color)
const Color & GetStartColorLow () const
Color & GetStartColorLow ()
void SetStartColorLow (const Color &color)
const Vector2 & GetYaw () const
void SetYaw (const Vector2 &range)
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.
virtual float EndFrame ()
 Report the frame at which the animation ends.
virtual void ListAnimObjects (std::list< RndObject * > &objects)
 Add the objects the animation uses to a list.
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)
Public Member Functions inherited from RndTransformable
 RndTransformable ()
 Construct a transformable with identity transforms, no origin offset, and no billboard.
 ~RndTransformable () override
 Drop the references on the children.
virtual void SetBillboard (int nBillboard)
 Set the billboard mode.
virtual int UpdateWorldXfm (RndTransformable *pParent, int bForce)
 Recompute the world transform when it, or the parent's, changed, and then the children's.
void DumpText (PrnStream &stream) override
 Write a description of the transformable.
void Save (BinStream &stream) override
 Write the transforms, the names of the children, the billboard mode, and the origin.
void Replace (RndObject *pFrom, RndObject *pTo) override
 Replace a child with another object.
void Copy (const RndObject *pSource, int nFlags) override
 Copy the transforms, the billboard mode, the origin, and the children when the flags request them.
void Load (BinStream &stream) override
 Read what Save() wrote, or an earlier version of it.
void SetOrigin (const Vector3 &origin)
 Set the point the world transform subtracts first when there is no billboard.
RndTransformable * Parent ()
 Find the transformable whose children include this object.
bool AddTrans (RndTransformable *pTrans)
 Append a child and mark its world transform dirty.
void RemoveTrans (RndTransformable *pTrans)
 Remove a child.
void ClearTrans ()
 Remove every child.
const Transform & BillboardXfm ()
 Report the world transform turned to face the current camera.
const Transform & GetLocalXfm () const
Transform & GetLocalXfm ()
void SetLocalXfm (const Transform &xfm)
const Transform & GetWorldXfm () const
Transform & GetWorldXfm ()
int GetDirty () const
void SetDirty (int nDirty)
const std::list< RndTransformable * > & GetTransList () const
Public Member Functions inherited from RndDrawable
 RndDrawable ()
 Construct a showing drawable without a highlight or children.
 ~RndDrawable () override
 Drop the references on the children.
virtual void SetShowing (int nShowing)
 Set whether the drawable draws at all.
virtual void SetHighlight (int nHighlight)
 Set whether the drawable draws with its highlight treatment.
RndDrawable * Parent ()
 Find the drawable whose children include this one.
void Draw ()
 Draw the drawable and then its children, when it is showing.
bool AddDraw (RndDrawable *pDraw, RndDrawable *pBefore)
 Add a child before another.
void RemoveDraw (RndDrawable *pDraw)
 Remove a child.
void ClearDraws ()
 Remove every child.
int GetShowing () const
const std::list< RndDrawable * > & GetDraws () const

Static Public Member Functions

static RndObject * New (const char *pszName)
 Create a system.
Static Public Member Functions inherited from RndParticleSys
static RndObject * New (const char *pszName)
 Create a system.
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 Member Functions inherited from RndTransformable
static void CollectChildren (std::list< RndObject * > &objects, RndTransformable *pTransformable)
 Append every transform descendant of a transformable, depth first, each before its descendants.
Static Public Member Functions inherited from RndDrawable
static void CollectChildren (std::list< RndObject * > &objects, RndDrawable *pDrawable)
 Append every draw descendant of a drawable, depth first, each before its descendants.

Additional Inherited Members

Public Types inherited from RndParticleSys
enum  Mode { kModePoint = 0 , kModeLine = 1 , kModeSprite = 2 }
 The primitive each particle is drawn as. More...
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...
Public Types inherited from RndTransformable
enum  Billboard {
  kBillboardNone = 0 , kBillboardX = 1 , kBillboardY = 2 , kBillboardZ = 4 ,
  kBillboardXZ = 8 , kBillboardXYZ = 16 , kBillboardSimpleXYZ = 32 , kBillboardLocalRotate = 64 ,
  kBillboardScale = 128 , kBillboardScaleX = 129 , kBillboardScaleY = 130 , kBillboardScaleZ = 132 ,
  kBillboardScaleXZ = 136 , kBillboardScaleXYZ = 144 , kBillboardScaleSimpleXYZ = 160
}
 How the world transform turns to face the current camera. More...
Public Attributes inherited from RndParticleSys
std::unique_ptr< Particle[]> mParticles
Static Public Attributes inherited from RndParticleSys
static constexpr int kCopyShareParticles = 0x400
 The bit of the Copy() flags that shares the source's pool rather than allocating one.
static const char * sClassName
 The class name a .rnd file writes, ParticleSys.
static int sRev
 The format version Save() writes and Load() accepts.
static int sLoadRev
 The version Load() read last.
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.
Static Public Attributes inherited from RndTransformable
static int sRev
 The format version Save() writes and Load() accepts.
Static Public Attributes inherited from RndDrawable
static int sRev
 The format version Save() writes and Load() accepts.
Protected Member Functions inherited from RndParticleSys
void AddObjectRefs ()
 Take the references on the material and the owner, and prepare the pool.
void RemoveObjectRefs ()
 Drop the references on the material and the owner, free the live particles, and withdraw from the sharers of the 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.
Protected Member Functions inherited from RndTransformable
void ReleaseTransRefs ()
 Drop the reference on every child without emptying the list.
void AcquireTransRefs ()
 Take a reference on every child.
Protected Member Functions inherited from RndDrawable
void ReleaseDrawRefs ()
 Drop the reference on every child without emptying the list.
void AcquireDrawRefs ()
 Take a reference on every child.
Protected Attributes inherited from RndParticleSys
Particle * mLiveParticles
RndMat * mMat
Mode mMode
int mReadZ
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
Protected Attributes inherited from RndTransformable
std::list< RndTransformable * > mTransList
Transform mLocalXfm
Transform mWorldXfm
Vector3 mOrigin
int mDirty
int mBillboard
Protected Attributes inherited from RndDrawable
int mShowing

Detailed Description

Particle system, PlayStation 2.

The RTTI includes the class name and records RndParticleSys as the one base. The class adds no data member. Only sprite systems draw. VU1 expands each particle into a sprite of its size.

Constructor & Destructor Documentation

◆ PsParticleSys()

PsParticleSys::PsParticleSys ( const char * pszName)
explicit

Construct a system.

Parameters
pszNameThe registry key.
Ghidra address:
NTSC-U/C: 0x0021a378
Ghidra address:
PAL: 0x00223190

◆ ~PsParticleSys()

PsParticleSys::~PsParticleSys ( )
inlineoverride
Ghidra address:
NTSC-U/C: 0x0037d710
Ghidra address:
PAL: 0x003ebe40

Member Function Documentation

◆ DrawShowing()

int PsParticleSys::DrawShowing ( )
overridevirtual

Draw the live particles of a sprite system in each pass of the material, without writing depth.

The particles test depth only when mReadZ is set. A system of another mode draws nothing.

Returns
1, to draw the children.
Ghidra address:
NTSC-U/C: 0x0021a2a8
Ghidra address:
PAL: 0x002230c0

Reimplemented from RndDrawable.

◆ DrawParticles()

void PsParticleSys::DrawParticles ( )

Send the live particles to VU1 in batches of up to 162, each batch followed by a frame flush.

The first batch starts the sprite microprogram, and the others continue it. Each particle sends its colour and its position, with half its size in the fourth word of the position. The name is inferred.

Ghidra address:
NTSC-U/C: 0x00219f28
Ghidra address:
PAL: 0x00222d40

◆ New()

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

Create a system.

Parameters
pszNameThe registry key.
Returns
The system.
Ghidra address:
NTSC-U/C: 0x0037d8c8
Ghidra address:
PAL: 0x003ebff8

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