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

View that shows the children of another view, its children owner, under its own transform and frame. More...

#include <rndview.h>

Inheritance diagram for RndView:
Collaboration diagram for RndView:

Public Member Functions

 RndView (const char *pszName)
 Construct a view that owns its children and is in range.
 ~RndView () override
 Drop the reference on the children owner.
void * operator new (size_t nSize)
 Allocate a view from its pool.
void operator delete (void *pBlock)
 Return a view to its pool.
int SetFrameSelf (float fFrame) override
 Record whether the unfiltered frame is in a non-empty mVisibleRange.
void ListDrawables (std::list< RndDrawable * > &drawables) override
 Add the view, when the children owner's children have something to draw, then the view's children, to a list.
int DrawShowing () override
 Draw the children owner's children at this view's frame and transform, when in range.
int UpdateWorldXfm (RndTransformable *pParent, int bForce) override
 Update the world transform when in range.
void DumpText (PrnStream &stream) override
 Write a description of the view and its bases.
void Save (BinStream &stream) override
 Write the view and its bases.
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 view and its bases.
void Load (BinStream &stream) override
 Read what Save() wrote, or an earlier version of it.
void SetVisibleRange (float fStart, float fEnd)
 Set the range of frames the view shows in, and put the view in range.
void SetInRange (int nInRange)
 Put the view in or out of range.
const Vector2 & GetVisibleRange () const
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 RndDrawable
 RndDrawable ()
 Construct a showing drawable without a highlight or children.
 ~RndDrawable () override
 Drop the references on the children.
virtual void ListDrawObjects (std::list< RndObject * > &objects)
 Add the objects the drawable uses to a list.
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
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.
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 RndCollideable
 RndCollideable ()
 Construct a collideable without children.
 ~RndCollideable () override
 Drop the references on the children.
virtual void Collide (const Segment &segment, std::list< Collision > &collisions)
 Test a segment against the collideable and add what it strikes to a list.
virtual void Collide (const Vector2 &point, std::list< Collision > &collisions)
 Test a screen point against the collideable and add what it strikes to a list.
RndCollideable * Parent ()
 Find the collideable whose children include this one.
bool AddCollide (RndCollideable *pCollide)
 Append a child.
void RemoveCollide (RndCollideable *pCollide)
 Remove a child.

Static Public Member Functions

static RndObject * New (const char *pszName)
 Create a view.
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 RndDrawable
static void CollectChildren (std::list< RndObject * > &objects, RndDrawable *pDrawable)
 Append every draw descendant of a drawable, 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 RndCollideable
static void CollectChildren (std::list< RndObject * > &objects, RndCollideable *pCollideable)
 Append every collision descendant of a collideable, depth first, each before its descendants.

Static Public Attributes

static constexpr int kCopyShareChildren = 0x20
 The bit of the Copy() flags that shares the source's children owner.
static const char * sClassName
 The class name a .rnd file writes, View.
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.
Static Public Attributes inherited from RndDrawable
static int sRev
 The format version Save() writes and Load() accepts.
Static Public Attributes inherited from RndTransformable
static int sRev
 The format version Save() writes and Load() accepts.
Static Public Attributes inherited from RndCollideable
static int sRev
 The format version Save() writes and Load() accepts.

Protected Member Functions

void ReleaseRefs ()
 Drop the reference on the children owner.
void AcquireRefs ()
 Take a reference on the children owner, and put the view in range.
void SyncChildren ()
 Bring the children owner's animations to this view's frame and its transforms under this view's transform.
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 RndDrawable
void ReleaseDrawRefs ()
 Drop the reference on every child without emptying the list.
void AcquireDrawRefs ()
 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 RndCollideable
void ReleaseCollideRefs ()
 Drop the reference on every child without emptying the list.
void AcquireCollideRefs ()
 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...
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...
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 RndDrawable
int mShowing
Protected Attributes inherited from RndTransformable
std::list< RndTransformable * > mTransList
Transform mLocalXfm
Transform mWorldXfm
Vector3 mOrigin
int mDirty
int mBillboard

Detailed Description

View that shows the children of another view, its children owner, under its own transform and frame.

The RTTI includes the class name and records RndAnimatable, RndDrawable, RndTransformable, and RndCollideable as bases. A view is shown only while its frame is in mVisibleRange, when the range is not empty.

Constructor & Destructor Documentation

◆ RndView()

RndView::RndView ( const char * pszName)
explicit

Construct a view that owns its children and is in range.

Parameters
pszNameThe registry key.
Ghidra address:
NTSC-U/C: 0x00247a50
Ghidra address:
PAL: 0x002504f0

◆ ~RndView()

RndView::~RndView ( )
override

Drop the reference on the children owner.

Ghidra address:
NTSC-U/C: 0x00393420
Ghidra address:
PAL: 0x00401b28

Member Function Documentation

◆ operator new()

void * RndView::operator new ( size_t nSize)
inline

Allocate a view from its pool.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void RndView::operator delete ( void * pBlock)
inline

Return a view to its pool.

Parameters
pBlockThe block.

◆ SetFrameSelf()

int RndView::SetFrameSelf ( float fFrame)
overridevirtual

Record whether the unfiltered frame is in a non-empty mVisibleRange.

The filtered frame is ignored.

Parameters
fFrameThe filtered frame.
Returns
Whether the view is in range.
Ghidra address:
NTSC-U/C: 0x002481f8
Ghidra address:
PAL: 0x00250c98

Reimplemented from RndAnimatable.

◆ ListDrawables()

void RndView::ListDrawables ( std::list< RndDrawable * > & drawables)
overridevirtual

Add the view, when the children owner's children have something to draw, then the view's children, to a list.

The children owner's animations and transforms are first brought to this view's frame and transform.

Parameters
drawablesThe list to add to.
Ghidra address:
NTSC-U/C: 0x002488d8
Ghidra address:
PAL: 0x00251378

Reimplemented from RndDrawable.

◆ DrawShowing()

int RndView::DrawShowing ( )
overridevirtual

Draw the children owner's children at this view's frame and transform, when in range.

Returns
Whether to draw the view's children.
Ghidra address:
NTSC-U/C: 0x002480f0
Ghidra address:
PAL: 0x00250b90

Reimplemented from RndDrawable.

◆ UpdateWorldXfm()

int RndView::UpdateWorldXfm ( RndTransformable * pParent,
int bForce )
overridevirtual

Update the world transform when in range.

Parameters
pParentThe parent, or null.
bForceNon-zero to update even when the transform is not out of date.
Returns
What RndTransformable::UpdateWorldXfm() reports, or 0 out of range.
Ghidra address:
NTSC-U/C: 0x00248240
Ghidra address:
PAL: 0x00250ce0

Reimplemented from RndTransformable.

◆ DumpText()

void RndView::DumpText ( PrnStream & stream)
overridevirtual

Write a description of the view and its bases.

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

Reimplemented from RndAnimatable.

◆ Save()

void RndView::Save ( BinStream & stream)
overridevirtual

Write the view and its bases.

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

Reimplemented from RndAnimatable.

◆ Replace()

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

Replace a referenced object with another.

A children owner replaced by null becomes the view itself.

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

Reimplemented from RndAnimatable.

◆ ClassName()

const char * RndView::ClassName ( ) const
inlineoverridevirtual

Report the class name.

Returns
sClassName.
Ghidra address:
NTSC-U/C: 0x00393960
Ghidra address:
PAL: 0x00402068

Implements RndObject.

◆ Copy()

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

Copy another view and its bases.

The children owner is the view itself when the source owns its children and the flags do not include kCopyShareChildren. Otherwise it is the source's.

Parameters
pSourceThe view to copy from.
nFlagsThe set of fields to copy.
Ghidra address:
NTSC-U/C: 0x002487e0
Ghidra address:
PAL: 0x00251280

Reimplemented from RndAnimatable.

◆ Load()

void RndView::Load ( BinStream & stream)
overridevirtual

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

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

Reimplemented from RndAnimatable.

◆ SetVisibleRange()

void RndView::SetVisibleRange ( float fStart,
float fEnd )

Set the range of frames the view shows in, and put the view in range.

The name is inferred.

Parameters
fStartThe first frame.
fEndThe frame after the last.
Ghidra address:
NTSC-U/C: 0x00248270
Ghidra address:
PAL: 0x00250d10

◆ SetInRange()

void RndView::SetInRange ( int nInRange)

Put the view in or out of range.

The name is inferred.

Parameters
nInRangeNon-zero for in range.
Ghidra address:
NTSC-U/C: 0x00248288
Ghidra address:
PAL: 0x00250d28

◆ New()

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

Create a view.

Parameters
pszNameThe registry key.
Returns
The view.
Ghidra address:
NTSC-U/C: 0x00393970
Ghidra address:
PAL: 0x00402078

◆ GetVisibleRange()

const Vector2 & RndView::GetVisibleRange ( ) const
inline
Returns
The frames the view shows in, empty for all.

◆ ReleaseRefs()

void RndView::ReleaseRefs ( )
protected

Drop the reference on the children owner.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x002483a0
Ghidra address:
PAL: 0x00250e40

◆ AcquireRefs()

void RndView::AcquireRefs ( )
protected

Take a reference on the children owner, and put the view in range.

The name is inferred.

Ghidra address:
NTSC-U/C: 0x002483d0
Ghidra address:
PAL: 0x00250e70

◆ SyncChildren()

void RndView::SyncChildren ( )
protected

Bring the children owner's animations to this view's frame and its transforms under this view's transform.

The binary expands the routine inline in DrawShowing() and ListDrawables(). The name is inferred.

Member Data Documentation

◆ kCopyShareChildren

int RndView::kCopyShareChildren = 0x20
staticconstexpr

The bit of the Copy() flags that shares the source's children owner.

◆ sClassName

const char* RndView::sClassName
static

The class name a .rnd file writes, View.

Ghidra address:
NTSC-U/C: 0x003b0a64
Ghidra address:
PAL: 0x0042f8fc

◆ sRev

int RndView::sRev
static

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

Ghidra address:
NTSC-U/C: 0x003b0a68
Ghidra address:
PAL: 0x0042f900

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