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

Animation of a mesh's vertex positions, texture coordinates, and colours by keys. More...

#include <rndmeshanim.h>

Inheritance diagram for RndMeshAnim:
Collaboration diagram for RndMeshAnim:

Public Member Functions

 RndMeshAnim (const char *pszName)
 Construct an animation of nothing without keys.
 ~RndMeshAnim () override
 Drop the references on the mesh and the keys owner.
float EndFrame () override
 Report the last frame of any key.
void ListAnimObjects (std::list< RndObject * > &objects) override
 Add the mesh to a list, then the objects of the children.
int SetFrameSelf (float fFrame) override
 Apply a frame to the vertices of the mesh's geometry, then rebuild the parts that changed.
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 a referenced object with another.
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.
void SetMesh (RndMesh *pMesh)
 Set the mesh the animation drives.
RndMeshAnim * GetKeysOwner () const
const std::vector< Key< std::vector< Vector3 > > > & GetVertPointsKeys () const
std::vector< Key< std::vector< Vector3 > > > & GetVertPointsKeys ()
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 = 0x40
 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, MeshAnim.
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 mesh and the keys owner.
void AcquireRefs ()
 Take references on the mesh and the keys 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 a mesh's vertex positions, texture coordinates, and colours by keys.

The RTTI includes the class name and records RndAnimatable as the one base. Each key holds a value for every vertex. The keys may be shared, in which case mKeysOwner identifies the animation that has them.

Constructor & Destructor Documentation

◆ RndMeshAnim()

RndMeshAnim::RndMeshAnim ( const char * pszName)
explicit

Construct an animation of nothing without keys.

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

Parameters
pszNameThe registry key.

◆ ~RndMeshAnim()

RndMeshAnim::~RndMeshAnim ( )
override

Drop the references on the mesh and the keys owner.

Ghidra address:
NTSC-U/C: 0x0038e548
Ghidra address:
PAL: 0x003fcc50

Member Function Documentation

◆ EndFrame()

float RndMeshAnim::EndFrame ( )
overridevirtual

Report the last frame of any key.

Returns
The frame.
Ghidra address:
NTSC-U/C: 0x00235c50
Ghidra address:
PAL: 0x0023e7d0

Reimplemented from RndAnimatable.

◆ ListAnimObjects()

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

Add the mesh to a list, then the objects of the children.

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

Reimplemented from RndAnimatable.

◆ SetFrameSelf()

int RndMeshAnim::SetFrameSelf ( float fFrame)
overridevirtual

Apply a frame to the vertices of the mesh's geometry, then rebuild the parts that changed.

Only as many vertices as both the key and the geometry have are set.

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

Reimplemented from RndAnimatable.

◆ DumpText()

void RndMeshAnim::DumpText ( PrnStream & stream)
overridevirtual

Write a description of the animation and its base.

The mesh appears under the label "light:".

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

Reimplemented from RndAnimatable.

◆ Save()

void RndMeshAnim::Save ( BinStream & stream)
overridevirtual

Write the animation and its base.

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

Reimplemented from RndAnimatable.

◆ Replace()

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

Replace a referenced object with another.

A keys owner replaced by null becomes the animation itself.

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

Reimplemented from RndAnimatable.

◆ ClassName()

const char * RndMeshAnim::ClassName ( ) const
inlineoverridevirtual

Report the class name.

Returns
sClassName.
Ghidra address:
NTSC-U/C: 0x0038e7b8
Ghidra address:
PAL: 0x003fcec0

Implements RndObject.

◆ Copy()

void RndMeshAnim::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 keys owner becomes this one's.

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

Reimplemented from RndAnimatable.

◆ Load()

void RndMeshAnim::Load ( BinStream & stream)
overridevirtual

Read what Save() wrote.

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

Reimplemented from RndAnimatable.

◆ SetMesh()

void RndMeshAnim::SetMesh ( RndMesh * pMesh)

Set the mesh the animation drives.

Parameters
pMeshThe mesh, or null.
Ghidra address:
NTSC-U/C: 0x00235410
Ghidra address:
PAL: 0x0023df90

◆ New()

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

Create an animation.

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

◆ GetKeysOwner()

RndMeshAnim * RndMeshAnim::GetKeysOwner ( ) const
inline
Returns
The animation that has the keys.

◆ GetVertPointsKeys() [1/2]

const std::vector< Key< std::vector< Vector3 > > > & RndMeshAnim::GetVertPointsKeys ( ) const
inline
Returns
The vertex position keys.

◆ GetVertPointsKeys() [2/2]

std::vector< Key< std::vector< Vector3 > > > & RndMeshAnim::GetVertPointsKeys ( )
inline
Returns
The vertex position keys, for writing.

◆ ReleaseRefs()

void RndMeshAnim::ReleaseRefs ( )
protected

Drop the references on the mesh and the keys owner.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x00235818
Ghidra address:
PAL: 0x0023e398

◆ AcquireRefs()

void RndMeshAnim::AcquireRefs ( )
protected

Take references on the mesh and the keys owner.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x00235868
Ghidra address:
PAL: 0x0023e3e8

Member Data Documentation

◆ kCopyShareKeys

int RndMeshAnim::kCopyShareKeys = 0x40
staticconstexpr

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

◆ sClassName

const char* RndMeshAnim::sClassName
static

The class name a .rnd file writes, MeshAnim.

Ghidra address:
NTSC-U/C: 0x003b09f4
Ghidra address:
PAL: 0x0042f88c

◆ sRev

int RndMeshAnim::sRev
static

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

Ghidra address:
NTSC-U/C: 0x003b09f8
Ghidra address:
PAL: 0x0042f890

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