wavelength 1.0.0
Loading...
Searching...
No Matches
RemixTrack Class Referenceabstract

Track of a song that players edit in a remix. More...

#include <remixtrack.h>

Inheritance diagram for RemixTrack:
Collaboration diagram for RemixTrack:

Public Member Functions

 RemixTrack (int nIndex)
 Construct a track with no player.
virtual void SetMuteRemote (bool bMuteRemote)=0
 Set whether the track is silent while a player on another console is on it.
virtual bool GetMuteRemote () const =0
 Report whether the track is silent while a player on another console is on it.
virtual void SkipBars (int nStartBar, int nEndBar)=0
 Show a range of bars empty, and start the phrases at the end of the range.
virtual void RebuildGems ()=0
 Copy the gems of each section's pattern into the section.
virtual void SetActive (bool bActive)=0
 Set whether the track is the one the song's player plays, which silences its own riffs.
virtual bool IsActive () const =0
 Report whether the track is the one the song's player plays.
virtual void Redraw (int nStartBar)=0
 Show the track again from a bar on.
virtual void Save (BinStream &stream)=0
 Write the edits of the track.
virtual void Load (BinStream &stream)=0
 Read the edits of the track.
Public Member Functions inherited from Track
 Track (int nIndex)
 Construct a track with no player.
virtual ~Track ()
 Release the track.
virtual void Start ()=0
 Start the track with the song.
virtual void Stop ()=0
 Stop the track with the song.
virtual void SetPlayer (Player *pPlayer)
 Assign the player, and record the assignment in the session statistics.
virtual void HandleInput (Player *pPlayer, const PlayNoteEvent &event)=0
 Act on a note a player played on this track.
virtual void HandleInput (Player *pPlayer, const BtnEvent< 8 > &event)=0
 Act on a button event of a player on this track.
virtual void HandleInput (Player *pPlayer, const StickEvent< 2 > &event)=0
 Act on a stick event of a player on this track.
virtual void HandleInput (Player *pPlayer, const StickEvent< 6 > &event)=0
 Act on a stick event of a player on this track.
virtual void HandleInput (Player *pPlayer, const BtnEvent< 10 > &event)=0
 Act on a button event of a player on this track.
int GetIndex () const
Player * GetPlayer () const

Additional Inherited Members

Protected Attributes inherited from Track
int mIndex
Player * mPlayer

Detailed Description

Track of a song that players edit in a remix.

The RTTI includes the class name and records Track as the base. The class is abstract and has no vtable of its own. PitchTrack and VoxTrack derive from it and fill the members it adds in the same order. The member names are inferred.

Constructor & Destructor Documentation

◆ RemixTrack()

RemixTrack::RemixTrack ( int nIndex)
inlineexplicit

Construct a track with no player.

Inline. The constructors of the derived classes expand it.

Parameters
nIndexThe track's index in the song.

Member Function Documentation

◆ SetMuteRemote()

virtual void RemixTrack::SetMuteRemote ( bool bMuteRemote)
pure virtual

Set whether the track is silent while a player on another console is on it.

Parameters
bMuteRemoteWhether the track is silent.

Implemented in PitchTrack, and VoxTrack.

◆ GetMuteRemote()

virtual bool RemixTrack::GetMuteRemote ( ) const
pure virtual

Report whether the track is silent while a player on another console is on it.

Returns
Whether the track is silent.

Implemented in PitchTrack, and VoxTrack.

◆ SkipBars()

virtual void RemixTrack::SkipBars ( int nStartBar,
int nEndBar )
pure virtual

Show a range of bars empty, and start the phrases at the end of the range.

Parameters
nStartBarThe first bar of the range.
nEndBarThe bar after the range.

Implemented in PitchTrack, and VoxTrack.

◆ RebuildGems()

virtual void RemixTrack::RebuildGems ( )
pure virtual

Copy the gems of each section's pattern into the section.

Implemented in PitchTrack, and VoxTrack.

◆ SetActive()

virtual void RemixTrack::SetActive ( bool bActive)
pure virtual

Set whether the track is the one the song's player plays, which silences its own riffs.

Parameters
bActiveWhether the track is active.

Implemented in PitchTrack, and VoxTrack.

◆ IsActive()

virtual bool RemixTrack::IsActive ( ) const
pure virtual

Report whether the track is the one the song's player plays.

Returns
Whether the track is active.

Implemented in PitchTrack, and VoxTrack.

◆ Redraw()

virtual void RemixTrack::Redraw ( int nStartBar)
pure virtual

Show the track again from a bar on.

Parameters
nStartBarThe first bar.

Implemented in PitchTrack, and VoxTrack.

◆ Save()

virtual void RemixTrack::Save ( BinStream & stream)
pure virtual

Write the edits of the track.

Parameters
streamThe stream.

Implemented in PitchTrack, and VoxTrack.

◆ Load()

virtual void RemixTrack::Load ( BinStream & stream)
pure virtual

Read the edits of the track.

Parameters
streamThe stream.

Implemented in PitchTrack, and VoxTrack.


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