resonance 1.0.1
Loading...
Searching...
No Matches
VolumeEffector Class Reference

Effect that sets a channel's volume controller while it is applied. More...

#include <volumeeffector.h>

Inheritance diagram for VolumeEffector:
Collaboration diagram for VolumeEffector:

Public Member Functions

 VolumeEffector (unsigned char nChannel, int nAppliedLevel)
virtual ~VolumeEffector ()
 Switch the effect off, then tear down the base.
virtual int Type ()
 Report which effect this object applies.
virtual void SetEnabled (int bEnabled)
 Send controller 0x2f with mAppliedLevel while applied and with 0x7f otherwise.
Public Member Functions inherited from Effector
 Effector ()
virtual ~Effector ()
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

Static Public Member Functions inherited from Effector
static Effector * CreateForType (int nType, unsigned char nChannel, int nTrack)
 Build the effect one type selects.
Public Attributes inherited from MsgSource
int mGraphBuilt
 A word no member of this class reads.

Detailed Description

Effect that sets a channel's volume controller while it is applied.

Its RTTI descriptor is at 0x008ef6c0. It has Effector as its one base. The factory's allocation at 0x001a0e64 measures the object at 0x20 bytes. Its table is at 0x007de810. The factory reads the controller value from configuration code 0x392.

Constructor & Destructor Documentation

◆ VolumeEffector()

VolumeEffector::VolumeEffector ( unsigned char nChannel,
int nAppliedLevel )
Parameters
nChannelThe MIDI channel the controller change goes to.
nAppliedLevelThe controller value while the effect is applied.
Ghidra address:
NTSC-U/C: 0x001a1a10
Ghidra address:
PAL: 0x001a7778

◆ ~VolumeEffector()

virtual VolumeEffector::~VolumeEffector ( )
virtual

Switch the effect off, then tear down the base.

Ghidra address:
NTSC-U/C: 0x001a1a68
Ghidra address:
PAL: 0x001a77d0

Member Function Documentation

◆ Type()

virtual int VolumeEffector::Type ( )
virtual

Report which effect this object applies.

Returns
kEffectorTypeVolume.
Ghidra address:
NTSC-U/C: 0x001a1b30
Ghidra address:
PAL: 0x001a7898

Implements Effector.

◆ SetEnabled()

virtual void VolumeEffector::SetEnabled ( int bEnabled)
virtual

Send controller 0x2f with mAppliedLevel while applied and with 0x7f otherwise.

A request that repeats the current position sends nothing.

Parameters
bEnabledNon-zero to apply the effect.
Ghidra address:
NTSC-U/C: 0x001a07c0
Ghidra address:
PAL: 0x001a6528

Reimplemented from Effector.


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