resonance 1.0.1
Loading...
Searching...
No Matches
PhraseMaker Class Referenceabstract

Base of the per-instrument phrase makers. More...

#include <phrasemaker.h>

Inheritance diagram for PhraseMaker:
Collaboration diagram for PhraseMaker:

Public Member Functions

virtual void OnPeriod (int nPeriod)=0
 Act on the start of a period.
virtual int GetPeriodOrigin ()
 Report the song position periods are counted from.
Public Member Functions inherited from MsgSink
void * operator new (size_t nSize)
 Allocate a sink from the tagged heap under the tag "MsgSink".
void operator delete (void *pBlock)
 Release a sink to the tagged heap.
virtual ~MsgSink ()
virtual void Dispatch (Message *pMsg)
 Accept a message.
virtual void DispatchPriv (Message *pMsg)=0
 Act on a message.
Public Member Functions inherited from MsgSource
virtual ~MsgSource ()
virtual void AddSink (MsgSink *pSink)
 Register a sink, ignoring a sink that is already registered.
virtual void RemoveSink (MsgSink *pSink)
 Unregister the first occurrence of a sink.
void Send (Message *pMsg) const
 Deliver a message to every registered sink, in registration order.
void ClearSinks ()
 Unregister every sink.

Additional Inherited Members

Public Attributes inherited from MsgSource
int mGraphBuilt
 A word no member of this class reads.

Detailed Description

Base of the per-instrument phrase makers.

Its RTTI descriptor is at 0x008f0300. It is built over MsgSink at offset 0 and MsgSource at offset 4. AxePhraseMaker derives from it at offset 0.

The primary table at 0x007ddc88 runs six entries. Slot 3, MsgSink::DispatchPriv(), and slot 4 address the shared pure-virtual stub at 0x005381a8, and slot 5 has a body of its own, so the class introduces two virtuals and is abstract. The MsgSource table at 0x007dddf0 adjusts this by -4 and retains AddSink() and RemoveSink(). GsPeriodical drives both new slots: it reads GetPeriodOrigin() once and calls OnPeriod() once per period with the period index.

The destructor at 0x0019d2a0 is implicitly declared. It restores the base tables, frees MsgSource's vector, and releases the object under MsgSink's tag, which is what the compiler generates for a class with no member of its own. The implicit default constructor is emitted out of line at 0x0019d1b0, where AxePhraseMaker's constructor calls it.

Member Function Documentation

◆ OnPeriod()

virtual void PhraseMaker::OnPeriod ( int nPeriod)
pure virtual

Act on the start of a period.

Slot 4, pure.

AxePhraseMaker's override at 0x0019d990 is the one recovered body.

Parameters
nPeriodThe index of the period, counted from the origin GetPeriodOrigin() reports.

Implemented in AxePhraseMaker.

◆ GetPeriodOrigin()

virtual int PhraseMaker::GetPeriodOrigin ( )
virtual

Report the song position periods are counted from.

Slot 5.

The body here discards the finiteness test on zero and returns zero.

Returns
The origin, in MIDI ticks.
Ghidra address:
NTSC-U/C: 0x0019d370
Ghidra address:
PAL: 0x001a30d8

Reimplemented in AxePhraseMaker.


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