|
wavelength 1.0.0
|
Display of the play field and the heads-up display of every player. More...
#include <gfxmanager.h>


Classes | |
| class | GfxLoader |
| Loader of one file of the load list of the gfx configuration. More... | |
| struct | LocalViews |
| Views of the camera of one player, in the order they draw. More... | |
| struct | DebugMsg |
| Message the display lists for debugging. More... | |
Public Member Functions | |
| GfxManager () | |
| Construct an idle display. | |
| ~GfxManager () override | |
| Release the display. | |
| void | Print (const char *pszText) override |
| Discard text written to the display as a stream. | |
| void | Init () |
| Load the cache of textures, register the display script commands, and read the configuration. | |
| void | Terminate () |
| Tear down a loaded world, destroy the vortex, and unregister what Init() registered. | |
| void | Reset () |
| Return the display to its state with no world. | |
| void | Load (float fTime) |
| Start to load the files of the display for a world. | |
| void | BuildTracks (float fStartTick, float fEndTick, const float *pMsPerTick, const std::vector< int > &instruments, const std::vector< int > &trackTypes, int nOption, const std::vector< bool > &unlocked) |
| Build the display of the tracks of a song. | |
| void | Unload () |
| Start changing the display back after the world was destroyed. | |
| int | Poll (float fTime) |
| Advance the display. | |
| void | Draw (float fTick) |
| Draw the display. | |
| float | StartIntro (float fLength) |
| Start the run of the vortex into the play field. | |
| bool | IsIntroFinished () const |
| Report whether the run StartIntro() began has ended. | |
| float | RestartIntro () |
| Start the run of the vortex out of the play field. | |
| float | StartOutro (float fLength) |
| Start the run of the vortex at the end of a song. | |
| bool | IsOutroDone () |
| Report whether the run StartOutro() started is done. | |
| void | AddPreload (const char *pszFile) |
| Queue a file to stream before the world loads. | |
| AsyncStream * | FindPreload (const char *pszFile) |
| Find the stream of a queued file and wait for it to finish. | |
| int | GetTrackInstrument (int nTrack) |
| Report the instrument of a track. | |
| int | GetTrackType (int nTrack) |
| Report the type of a track. | |
| void | HandleBeat (signed char nEvent) |
| Run the arena effect of a beat event of the song. | |
| void | StartBossJourney () |
| Start the journey to the boss arena that follows the boss unlock. | |
| int | IsBossJourneyDone () |
| Report whether the journey StartBossJourney() started is done. | |
| bool | IsIdle () |
| Report whether the tunnel finished its effects. | |
| void | SetEnergy (int nPlayer, float fEnergy) |
| Show the energy of the play field of a solo game. | |
| void | SetDying (int nPlayer, bool bDying) |
| Show whether a player runs out of energy. | |
| void | SetScore (int nPlayer, int nScore, int nMultiplier, int nPoints) |
| Show a player's score. | |
| void | SetStreakMultiplier (int nPlayer, int nMultiplier, int nNextMultiplier, bool bBoosted) |
| Show a player's streak multiplier and the one the next capture earns. | |
| void | ShowPendingPoints (int nPlayer, int nPoints) |
| Show the points a player's current phrase is worth. | |
| void | HidePendingPoints (int nPlayer) |
| Hide a player's pending points. | |
| void | SetPendingPointsResult (int nPlayer, PendingPointsResult result) |
| Show what happened to a player's pending points. | |
| void | SetLeader (int nPlayer, bool bLeader) |
| Mark whether a player leads the score. | |
| void | ShowSongPos (bool bShow) |
| Show or hide the position in the song. | |
| void | ShowTrackLabels (bool bShow) |
| Show or hide the labels of the tracks. | |
| void | ShowPowerup (int nPlayer, int nPowerup) |
| Show the power-up icon of a player. | |
| void | SetMultiplierEndTick (int nPlayer, float fTick) |
| Show the song tick a player's multiplier power-up ends at. | |
| void | ShowSlowdown (int nPlayer, float fStartTick, float fEndTick, float fStopTick) |
| Show the slowdown a player deployed. | |
| void | ShowCripple (int nAttacker, int nVictim) |
| Show a player crippling another. | |
| void | ShowBump (int nAttacker, int nVictim, int nTrack) |
| Show a player knocking another off a track with a bumper. | |
| void | ShowMessage (const char *pszLine, const char *pszSecondLine, int nPlayer, float fDurationMs, float fScale, float fOffsetY, float fOffsetX) |
| Show a message of one or two lines. | |
| void | SetLyricText (const char *pszText, bool bFirstLine) |
| Show the lyric text. | |
| void | ShowButtonIcon (int nLane, const Vector2 *pPosition, const Vector2 *pTarget) |
| Fly the controller button icon of a lane across the screen. | |
| void | SetButtonIconHighlight (int nLane, int nHighlight) |
| Highlight the controller button icon of a lane, or clear the highlight. | |
| void | HideButtonIcon (int nLane) |
| Hide the controller button icon of a lane. | |
| void | SetButtonIconGlyph (int nLane, const char *pszGlyph) |
| Set the glyph the controller button icon of a lane shows. | |
| void | ShowController (bool bShow, float fPosition) |
| Show or hide the diagram of the controller. | |
| void | SetControllerHighlight (bool bHighlight) |
| Highlight the diagram of the controller, or clear the highlight. | |
| void | ShowControllerButton (int nButton, bool bShow) |
| Show or hide one button of the diagram of the controller. | |
| void | OpenDialog (const char *pszText, float fSize, int nPosition) |
| Open the dialog box with a text. | |
| void | CloseDialog () |
| Close the dialog box. | |
| void | SetLetterbox (bool bClosed) |
| Close or open the letterbox. | |
| void | ShowBox (bool bShow) |
| Show or hide the highlight box. | |
| void | ShowArrow (bool bShow) |
| Show or hide the highlight arrow. | |
| void | SetBoxRect (float fX0, float fY0, float fX1, float fY1, float fDuration) |
| Move the highlight box. | |
| void | SetArrowTarget (float fX, float fY, float fAngle, float fDuration) |
| Move the highlight arrow. | |
| void | ShowStick (int nDirection, const Vector2 *pPosition) |
| Show the diagram of a stick. | |
| void | HideStick () |
| Hide the diagram of a stick. | |
| void | SetSectionCount (int nCount) |
| Set the number of sections of the song the remix display lists. | |
| void | SetSectionLabel (int nIndex, const char *pszLabel) |
| Set the label of a section of the song. | |
| void | ShowSections (bool bShow) |
| Show or hide the sections of the song. | |
| void | HighlightSection (int nIndex) |
| Highlight a section of the song. | |
| void | SetRemixPanelText (int nPlayer, int nIndex, const char *pszText, RemixSubPanel ePanel) |
| Set the text of an entry of a remix sub-panel. | |
| void | SelectRemixPanelEntry (int nPlayer, int nIndex, RemixSubPanel ePanel) |
| Move the cursor of a remix sub-panel to an entry. | |
| void | FlashRemixPanel (int nPlayer, RemixSubPanel ePanel) |
| Flash the cursor of a remix sub-panel to confirm a choice. | |
| void | SetRemixPanelLit (int nPlayer, int nIndex, int nLit, RemixSubPanel ePanel) |
| Light or darken an entry of a remix sub-panel. | |
| void | ShowRemixPanel (int nPlayer, RemixSubPanel ePanel) |
| Show one sub-panel of a player's remix menu. | |
| void | ShowRemix (int nPlayer, bool bShow) |
| Show or hide a player's remix menu. | |
| void | SetFreqSize (int nPlayer, int nSize) |
| Set the size of the display of the tracks of a player. | |
| void | SetWinner (int nPlayer) |
| Mark the winner of a song. | |
| void | SetTrackPlayers (int nTrack, int nPlayers, const int *pPlayers) |
| Show which players are on a track. | |
| void | ShowPlayerOnTrack (int nPlayer, int nTrack) |
| Move a player to a track. | |
| void | SetTrackInstrument (int nTrack, int nInstrument) |
| Show the instrument a track changed to, on the track and on every player on it. | |
| void | ShowPlayerOnFreestyleTrack (int nPlayer, int nType, int nInstrument, bool bVictory, int nReserved) |
| Show a player on the freestyle track. | |
| int | GetViewedTrack (int nPlayer) |
| Report the track the camera of a player shows. | |
| void | SetFreestylePosition (int nPlayer, const Vector3 &position) |
| Move a player's freestyle effect to a position of the first stick. | |
| void | SetFreestyleSecondPosition (int nPlayer, const Vector3 &position) |
| Ignore a position of the second stick for a player's freestyle effect. | |
| void | ShowScratchNote (int nPlayer, float fTick, float fDuration) |
| Show a note a scratch plays on a player's track. | |
| void | PlaceGem (int nTrack, int nSlot, int nPlayer, float fTick, int nStyle, int nFlags) |
| Place a gem on the play field. | |
| void | RemoveGem (int nTrack, int nSlot, float fTick) |
| Take a gem off the play field. | |
| void | ClearGems (int nTrack, bool bAll, float fStartTick, float fEndTick) |
| Remove the gems of a track in a range of ticks. | |
| void | HideNextPhrase (int nPlayer) |
| Hide the pointers to the next phrase. | |
| void | ShowNextPhrase (int nTrack, float fTick, int nGemType) |
| Point at the next phrase on a track. | |
| void | SetCatchMeter (int nPlayer, float fLevel) |
| Set the meter that shows how much of a phrase a player has caught. | |
| void | ShowGemResult (int nTrack, int nSlot, bool bHit, int nPlayer, int nFlags, float fTick) |
| Show the result of a gem a player played or removed. | |
| void | HitGem (int nPlayer, int nTrack, int nSlot, float fTick) |
| Show a player hitting a gem. | |
| void | SetFreestyle (int nPlayer, bool bActive, int nColumn) |
| Show or hide a player's freestyle effect. | |
| void | ResetFreestyle (int nPlayer) |
| Return a player's freestyle effect to its idle state. | |
| void | ShowCapture (int nPlayer, int nTrack, int nStyle, bool bQuiet, float fStartTick, float fEndTick) |
| Show a player catching a phrase. | |
| void | CompleteStage (int nPlayer, int nSection) |
| Rank the score bars at the end of a section and, in a solo game, fire the triggers that wait on it. | |
| void | ShowResult (bool bWon, int nPlayer, bool bUnlocked) |
| Show the result of a song. | |
| void | ShowPhrase (int nPlayer, int nTrack, bool bPlayable, float fStartTick, float fEndTick, int nStyle, bool bSlide) |
| Show the bars of a phrase on a track, from the camera of a player. | |
| void | SetBar (int nTrack, int nPlayer, int nOwner, bool bInSong, bool bVisible, int nFlags, signed char nRiff, float fTick, float fTicks) |
| Set the look of one bar of a track. | |
| void | DimBar (int nTrack, float fTick) |
| Dim one bar of a track. | |
| void | SetTrackEnabled (int nTrack, bool bEnabled) |
| Show a track as enabled or disabled. | |
| void | AddCheckpoint (const char *pszLabel, float fTick, float fOffset, float fScale) |
| Place a checkpoint on the tracks and on the position in the song. | |
| void | ClearCheckpoints () |
| Remove every checkpoint. | |
| void | SetOption (bool bOption) |
| Set the display option a solo player toggles. | |
| bool | GetOption () |
| Report the display option a solo player toggles. | |
| void | SetScrollSpeed (float fSpeed) |
| Set the scroll speed of the lanes. | |
| void | BlendToArenaPath (bool bArena) |
| Blend the camera of the tunnel towards the arena path or back. | |
| void | SetPlayerShown (int nPlayer, bool bShown) |
| Show or hide the ship of a player. | |
| void | SetCatcherShown (int nPlayer, bool bShown) |
| Show or hide the catcher of a player. | |
| void | SetEnergyShown (int nPlayer, bool bShown) |
| Show or hide the energy meter. | |
| void | SetScoreShown (int nPlayer, bool bShown) |
| Show or hide the score of a player. | |
| void | SetLaneShown (int nPlayer, bool bShown) |
| Show or hide the avatar display of a player. | |
| void | ShowHud (bool bShow) |
| Show or hide the display of the players' scores and meters over the tracks. | |
| void | ClearLanes () |
| Clear the highlights of the cameras and reset the head-up display. | |
| void | ClearAll () |
| Clear every effect of the tunnel, reset the ships and the panels of the arena, and clear the start of the head-up display. | |
| void | SetActive (bool bActive) |
| Start or stop the victory lap. | |
| const Color * | GetInstrumentColor (int nInstrument) const |
| Report the colour of an instrument, inst_color_<instrument>. | |
| const Color * | GetInstrumentBgColor (int nInstrument) const |
| Report the background colour of an instrument, inst_bg_color_<instrument>. | |
| const Color * | GetPlayerColor (int nPlayer) const |
| Report the colour of a player, player_color_<colour>. | |
| const Color * | GetPlayerBgColor (int nPlayer) const |
| Report the background colour of a player, player_bg_color_<colour>. | |
| Vortex * | GetVortex () const |
| int | GetVortexAfterViews () const |
| void | SetVortexAfterViews (int nValue) |
| Set whether the vortex draws after the head-up display. | |
| const std::list< GfxLoader > & | GetLoaders () const |
| const std::list< std::unique_ptr< AsyncStream > > & | GetPreloads () const |
| int | GetLoadStage () const |
| RndLoader * | GetHudLoader () const |
| int | GetLoaded () const |
| float | GetLoadStartMs () const |
| int | GetState () const |
| float | GetLastTick () const |
| float | GetLastTime () const |
| float | GetScrollSpeed () const |
| float | GetInvScrollSpeed () const |
| float | GetSongTicks () const |
| void | SetSongTicks (float fValue) |
| Set the length of the song in ticks. | |
| float | GetCamPathScale () const |
| int | GetVictoryLap () const |
| void | SetVictoryLap (int nValue) |
| Set whether the victory lap runs. | |
| int | GetArenaUnlocked () const |
| int | GetNoArena () const |
| int | GetMonkeyGems () const |
| int | GetDrugs () const |
| int | GetBlackPanels () const |
| int | GetNoPanels () const |
| signed char | GetTunnelShape () const |
| int | GetHudFlags () const |
| GfxTunnel * | GetTunnel () const |
| Overlay * | GetOverlay () const |
| GfxArena * | GetArena () const |
| RndView * | GetTunnelView () const |
| RndView * | GetMainView () const |
| const std::vector< LocalViews > & | GetLocalViews () const |
| RndView * | GetPanelView () const |
| const std::unique_ptr< Ship > * | GetShips () const |
| Ship * | GetShip (int nPlayer) const |
| Report the ship of a player. | |
| int | GetLeader () const |
| void | SetLeader (int nValue) |
| Set the player in the lead. | |
| int | GetWinnerDrawn () const |
| void | SetWinnerDrawn (int nValue) |
| Set whether the winner's avatar was drawn this frame. | |
| int | GetWinner () const |
| const float * | GetMsPerTick () const |
| const char * | GetMultiplierFormat () const |
| const std::list< DebugMsg > & | GetDebugMsgs () const |
| const std::list< DebugMsg > & | GetDebugMsgs2 () const |
| Public Member Functions inherited from PrnStream | |
| PrnStream () | |
| Construct a stream with a dump level of 0. | |
| virtual | ~PrnStream () |
| Release the stream. | |
| void | Printf (const char *pszFormat,...) |
| Format text into the shared format buffer and write the result through Print(). | |
| PrnStream & | operator<< (const char *pszText) |
| Write text. | |
| PrnStream & | operator<< (char ch) |
| Write a character. | |
| PrnStream & | operator<< (short nValue) |
| Write a short integer in decimal. | |
| PrnStream & | operator<< (int nValue) |
| Write an integer in decimal. | |
| PrnStream & | operator<< (unsigned char nValue) |
| Write a byte as an unsigned integer in decimal. | |
| PrnStream & | operator<< (unsigned short nValue) |
| Write an unsigned short integer in decimal. | |
| PrnStream & | operator<< (unsigned int nValue) |
| Write an unsigned integer in decimal. | |
| PrnStream & | operator<< (unsigned long long nValue) |
| Write an unsigned 64-bit number in decimal. | |
| PrnStream & | operator<< (float fValue) |
| Write a number with two decimals. | |
| PrnStream & | operator<< (bool bValue) |
| Write true or false. | |
| void | Space (int nCount) |
| Write a number of spaces, one Print() call each. | |
| int | GetDumpLevel () const |
| PrnStream () | |
| virtual | ~PrnStream () |
| Destroy the stream. | |
| void | Printf (const char *format,...) |
| Format text with printf() conventions and write it. | |
| PrnStream & | operator<< (char c) |
| Write a character. | |
| PrnStream & | operator<< (int i) |
| Write an integer in decimal. | |
| PrnStream & | operator<< (float f) |
| Write a number with two decimal places. | |
| PrnStream & | operator<< (const char *str) |
| Write text. | |
| void | Space (int count) |
| Write spaces. | |
Static Public Attributes | |
| static constexpr int | kMaxPlayers = 4 |
| The number of ships the display has, one for each player. | |
| static Color | sInstrumentColors [kNumInstruments] |
| The colours of the instruments, indexed by Instrument. | |
| static Color | sInstrumentBgColors [kNumInstruments] |
| The background colours of the instruments, indexed by Instrument. | |
| static Color | sPlayerColors [kNumPlayerColors] |
| The colours of the player slots, indexed by PlayerColor. | |
| static Color | sPlayerBgColors [kNumPlayerColors] |
| The background colours of the player slots, indexed by PlayerColor. | |
| static DataArray * | sMergesAlwaysAllowed |
| The textures that may be skipped by a load without a report, merges_always_allowed. | |
| static float | sEnergyHighZone |
| The energy at which the top zone of the meter starts. | |
| static float | sEnergyLowZone |
| The energy at which the middle zone of the meter starts. | |
| static int | sInitialized |
| Whether Init() ran. | |
| static int | sTerminated |
| Whether Terminate() ran. | |
Display of the play field and the heads-up display of every player.
The RTTI records the class as deriving from PrnStream. The object is 0xd4 bytes, and the one instance is TheGfxManager. The display manages the arena, the tunnel of tracks, the ship of each player, and the head-up display, and most of its routines forward to them.
| enum GfxManager::State |
The values of mState.
| Enumerator | |
|---|---|
| kStateIdle | No world is loaded. |
| kStateLoading | Load() started to load a world. |
| kStatePlaying | BuildTracks() built the tracks of the song. |
| kStateUnloading | Unload() started to change the display back. |
What SetPendingPointsResult() shows happened to a player's pending points.
| Enumerator | |
|---|---|
| kPendingPointsCleared | The pending points were reset. |
| kPendingPointsCaptured | The pending points were added to the score. |
| kPendingPointsLost | The pending points were forfeited. |
Sub-panel of a player's remix menu.
The RTTI includes the name as an argument of a command template. The names of the effect panels follow their scene objects pat, chs, stt, eco, bot, and bpm.
| Enumerator | |
|---|---|
| kRemixSubPanelMain | The list of remix panels. |
| kRemixSubPanelPattern | The pat panel. OvyRemixPanel never builds it. |
| kRemixSubPanelChorus | The chorus effect. |
| kRemixSubPanelStutter | The stutter effect. |
| kRemixSubPanelEcho | The echo effect. |
| kRemixSubPanelBoot | The list of the players the host can remove. |
| kRemixSubPanelTempo | The tempo control. |
| GfxManager::GfxManager | ( | ) |
Construct an idle display.
|
override |
Release the display.
|
inlineoverridevirtual |
Discard text written to the display as a stream.
The body is empty.
| pszText | The text. |
Implements PrnStream.
| void GfxManager::Init | ( | ) |
Load the cache of textures, register the display script commands, and read the configuration.
| void GfxManager::Terminate | ( | ) |
Tear down a loaded world, destroy the vortex, and unregister what Init() registered.
| void GfxManager::Reset | ( | ) |
Return the display to its state with no world.
| void GfxManager::Load | ( | float | fTime | ) |
Start to load the files of the display for a world.
| fTime | The time the display starts at. WorldMgr passes -1. |
| void GfxManager::BuildTracks | ( | float | fStartTick, |
| float | fEndTick, | ||
| const float * | pMsPerTick, | ||
| const std::vector< int > & | instruments, | ||
| const std::vector< int > & | trackTypes, | ||
| int | nOption, | ||
| const std::vector< bool > & | unlocked ) |
Build the display of the tracks of a song.
| fStartTick | The tick the song starts at. |
| fEndTick | The tick the song ends at. |
| pMsPerTick | The milliseconds per tick of the song clock. |
| instruments | The instrument of each track. |
| trackTypes | The type of each track. |
| nOption | The option of the tracks. |
| unlocked | One flag for each path of the song, set for the unlocked ones. |
| void GfxManager::Unload | ( | ) |
Start changing the display back after the world was destroyed.
| int GfxManager::Poll | ( | float | fTime | ) |
Advance the display.
| fTime | The time of the display. |
| void GfxManager::Draw | ( | float | fTick | ) |
Draw the display.
| fTick | The running world's position in ticks, or 0 when no world is running. The display does not read it. |
| float GfxManager::StartIntro | ( | float | fLength | ) |
Start the run of the vortex into the play field.
| fLength | The length of the run in milliseconds, or -1 for the configured length. |
| bool GfxManager::IsIntroFinished | ( | ) | const |
Report whether the run StartIntro() began has ended.
| float GfxManager::RestartIntro | ( | ) |
Start the run of the vortex out of the play field.
| float GfxManager::StartOutro | ( | float | fLength | ) |
Start the run of the vortex at the end of a song.
| fLength | The length of the run in milliseconds, or a negative value for the configured length. |
| bool GfxManager::IsOutroDone | ( | ) |
Report whether the run StartOutro() started is done.
| void GfxManager::AddPreload | ( | const char * | pszFile | ) |
Queue a file to stream before the world loads.
| pszFile | The file. |
| AsyncStream * GfxManager::FindPreload | ( | const char * | pszFile | ) |
Find the stream of a queued file and wait for it to finish.
| pszFile | The file. |
| int GfxManager::GetTrackInstrument | ( | int | nTrack | ) |
Report the instrument of a track.
| nTrack | The track. |
| int GfxManager::GetTrackType | ( | int | nTrack | ) |
Report the type of a track.
| nTrack | The track. |
| void GfxManager::HandleBeat | ( | signed char | nEvent | ) |
Run the arena effect of a beat event of the song.
| nEvent | The event. |
| void GfxManager::StartBossJourney | ( | ) |
Start the journey to the boss arena that follows the boss unlock.
The name is inferred.
| int GfxManager::IsBossJourneyDone | ( | ) |
Report whether the journey StartBossJourney() started is done.
The name is inferred.
| bool GfxManager::IsIdle | ( | ) |
Report whether the tunnel finished its effects.
| void GfxManager::SetEnergy | ( | int | nPlayer, |
| float | fEnergy ) |
Show the energy of the play field of a solo game.
A game that is not solo does not show the energy. Practice shows a full meter.
| nPlayer | The player's index. |
| fEnergy | The energy, from 0 to 1. |
| void GfxManager::SetDying | ( | int | nPlayer, |
| bool | bDying ) |
Show whether a player runs out of energy.
| nPlayer | The player's index. |
| bDying | Whether the player runs out of energy. |
| void GfxManager::SetScore | ( | int | nPlayer, |
| int | nScore, | ||
| int | nMultiplier, | ||
| int | nPoints ) |
Show a player's score.
| nPlayer | The player's index. |
| nScore | The new score. |
| nMultiplier | The streak multiplier the points were scored at. The display does not read it. |
| nPoints | The points just added, or 0. The display does not read them. |
| void GfxManager::SetStreakMultiplier | ( | int | nPlayer, |
| int | nMultiplier, | ||
| int | nNextMultiplier, | ||
| bool | bBoosted ) |
Show a player's streak multiplier and the one the next capture earns.
The texts of the multipliers are built only for a player on this console, and only for a multiplier above 1.
| nPlayer | The player's index. |
| nMultiplier | The current streak multiplier. |
| nNextMultiplier | The streak multiplier after one more capture. |
| bBoosted | Whether a multiplier power-up is active. |
| void GfxManager::ShowPendingPoints | ( | int | nPlayer, |
| int | nPoints ) |
Show the points a player's current phrase is worth.
| nPlayer | The player's index. |
| nPoints | The points. |
| void GfxManager::HidePendingPoints | ( | int | nPlayer | ) |
Hide a player's pending points.
| nPlayer | The player's index. |
| void GfxManager::SetPendingPointsResult | ( | int | nPlayer, |
| PendingPointsResult | result ) |
Show what happened to a player's pending points.
| nPlayer | The player's index. |
| result | What happened to the points. |
| void GfxManager::SetLeader | ( | int | nPlayer, |
| bool | bLeader ) |
Mark whether a player leads the score.
| nPlayer | The player's index. |
| bLeader | Whether the player leads. |
| void GfxManager::ShowSongPos | ( | bool | bShow | ) |
Show or hide the position in the song.
| bShow | Whether the position is shown. |
| void GfxManager::ShowTrackLabels | ( | bool | bShow | ) |
Show or hide the labels of the tracks.
| bShow | Whether the labels are shown. |
| void GfxManager::ShowPowerup | ( | int | nPlayer, |
| int | nPowerup ) |
Show the power-up icon of a player.
| nPlayer | The player's index. |
| nPowerup | The kind of power-up the player has, or GameLogic::kPowerupNone to hide the icon. |
| void GfxManager::SetMultiplierEndTick | ( | int | nPlayer, |
| float | fTick ) |
Show the song tick a player's multiplier power-up ends at.
| nPlayer | The player's index. |
| fTick | The tick. |
| void GfxManager::ShowSlowdown | ( | int | nPlayer, |
| float | fStartTick, | ||
| float | fEndTick, | ||
| float | fStopTick ) |
Show the slowdown a player deployed.
| nPlayer | The player's index. |
| fStartTick | The tick the song arrives at the slow speed. |
| fEndTick | The tick the song starts to speed up again. |
| fStopTick | The tick the song is back at its speed. |
| void GfxManager::ShowCripple | ( | int | nAttacker, |
| int | nVictim ) |
Show a player crippling another.
| nAttacker | The index of the player who deployed the crippler. |
| nVictim | The index of the player struck. |
| void GfxManager::ShowBump | ( | int | nAttacker, |
| int | nVictim, | ||
| int | nTrack ) |
Show a player knocking another off a track with a bumper.
| nAttacker | The index of the player who deployed the bumper. |
| nVictim | The index of the player struck. |
| nTrack | The track the victim moves to. |
| void GfxManager::ShowMessage | ( | const char * | pszLine, |
| const char * | pszSecondLine, | ||
| int | nPlayer, | ||
| float | fDurationMs, | ||
| float | fScale, | ||
| float | fOffsetY, | ||
| float | fOffsetX ) |
Show a message of one or two lines.
| pszLine | The first line. |
| pszSecondLine | The second line, or null. |
| nPlayer | The player the message is for, or -1 for every player. |
| fDurationMs | The time the message stays on the screen, in milliseconds. |
| fScale | The scale of the text. |
| fOffsetY | The vertical offset of the message. |
| fOffsetX | The horizontal offset of the message. |
| void GfxManager::SetLyricText | ( | const char * | pszText, |
| bool | bFirstLine ) |
Show the lyric text.
| pszText | The text. |
| bFirstLine | Show the text on the first line. |
Fly the controller button icon of a lane across the screen.
| nLane | The lane. |
| pPosition | The position of the icon on the screen. |
| pTarget | The position the icon moves to. |
| void GfxManager::SetButtonIconHighlight | ( | int | nLane, |
| int | nHighlight ) |
Highlight the controller button icon of a lane, or clear the highlight.
| nLane | The lane. |
| nHighlight | Non-zero to highlight the icon. |
| void GfxManager::HideButtonIcon | ( | int | nLane | ) |
Hide the controller button icon of a lane.
| nLane | The lane. |
| void GfxManager::SetButtonIconGlyph | ( | int | nLane, |
| const char * | pszGlyph ) |
Set the glyph the controller button icon of a lane shows.
| nLane | The lane. |
| pszGlyph | The glyph of the button, or null. |
| void GfxManager::ShowController | ( | bool | bShow, |
| float | fPosition ) |
Show or hide the diagram of the controller.
| bShow | Whether the diagram is shown. |
| fPosition | The position of the diagram, or -1 for the configured one. |
| void GfxManager::SetControllerHighlight | ( | bool | bHighlight | ) |
Highlight the diagram of the controller, or clear the highlight.
| bHighlight | Whether the diagram is highlighted. |
| void GfxManager::ShowControllerButton | ( | int | nButton, |
| bool | bShow ) |
Show or hide one button of the diagram of the controller.
| nButton | The button. |
| bShow | Whether the button is shown. |
| void GfxManager::OpenDialog | ( | const char * | pszText, |
| float | fSize, | ||
| int | nPosition ) |
Open the dialog box with a text.
| pszText | The text. |
| fSize | The size of the box. |
| nPosition | The position of the box, or -1 for the configured one. |
| void GfxManager::CloseDialog | ( | ) |
Close the dialog box.
| void GfxManager::SetLetterbox | ( | bool | bClosed | ) |
Close or open the letterbox.
| bClosed | Whether the letterbox closes. |
| void GfxManager::ShowBox | ( | bool | bShow | ) |
Show or hide the highlight box.
| bShow | Whether the box is shown. |
| void GfxManager::ShowArrow | ( | bool | bShow | ) |
Show or hide the highlight arrow.
| bShow | Whether the arrow is shown. |
| void GfxManager::SetBoxRect | ( | float | fX0, |
| float | fY0, | ||
| float | fX1, | ||
| float | fY1, | ||
| float | fDuration ) |
Move the highlight box.
| fX0 | The left edge. |
| fY0 | The top edge. |
| fX1 | The right edge. |
| fY1 | The bottom edge. |
| fDuration | The time the move takes. |
| void GfxManager::SetArrowTarget | ( | float | fX, |
| float | fY, | ||
| float | fAngle, | ||
| float | fDuration ) |
Move the highlight arrow.
| fX | The horizontal position. |
| fY | The vertical position. |
| fAngle | The angle of the arrow. |
| fDuration | The time the move takes. |
| void GfxManager::ShowStick | ( | int | nDirection, |
| const Vector2 * | pPosition ) |
Show the diagram of a stick.
| nDirection | The direction the diagram shows. |
| pPosition | The position of the diagram. |
| void GfxManager::HideStick | ( | ) |
Hide the diagram of a stick.
| void GfxManager::SetSectionCount | ( | int | nCount | ) |
Set the number of sections of the song the remix display lists.
| nCount | The number of sections. |
| void GfxManager::SetSectionLabel | ( | int | nIndex, |
| const char * | pszLabel ) |
Set the label of a section of the song.
| nIndex | The section. |
| pszLabel | The label. |
| void GfxManager::ShowSections | ( | bool | bShow | ) |
Show or hide the sections of the song.
| bShow | Whether the sections are shown. |
| void GfxManager::HighlightSection | ( | int | nIndex | ) |
Highlight a section of the song.
| nIndex | The section. |
| void GfxManager::SetRemixPanelText | ( | int | nPlayer, |
| int | nIndex, | ||
| const char * | pszText, | ||
| RemixSubPanel | ePanel ) |
Set the text of an entry of a remix sub-panel.
| nPlayer | The player's index. |
| nIndex | The entry. |
| pszText | The text. |
| ePanel | The sub-panel. |
| void GfxManager::SelectRemixPanelEntry | ( | int | nPlayer, |
| int | nIndex, | ||
| RemixSubPanel | ePanel ) |
Move the cursor of a remix sub-panel to an entry.
| nPlayer | The player's index. |
| nIndex | The entry, or -1 for none. |
| ePanel | The sub-panel. |
| void GfxManager::FlashRemixPanel | ( | int | nPlayer, |
| RemixSubPanel | ePanel ) |
Flash the cursor of a remix sub-panel to confirm a choice.
| nPlayer | The player's index. |
| ePanel | The sub-panel. |
| void GfxManager::SetRemixPanelLit | ( | int | nPlayer, |
| int | nIndex, | ||
| int | nLit, | ||
| RemixSubPanel | ePanel ) |
Light or darken an entry of a remix sub-panel.
| nPlayer | The player's index. |
| nIndex | The entry. |
| nLit | Non-zero to light the entry. |
| ePanel | The sub-panel. |
| void GfxManager::ShowRemixPanel | ( | int | nPlayer, |
| RemixSubPanel | ePanel ) |
Show one sub-panel of a player's remix menu.
| nPlayer | The player's index. |
| ePanel | The sub-panel. |
| void GfxManager::ShowRemix | ( | int | nPlayer, |
| bool | bShow ) |
Show or hide a player's remix menu.
| nPlayer | The player's index. |
| bShow | Whether the menu is shown. |
| void GfxManager::SetFreqSize | ( | int | nPlayer, |
| int | nSize ) |
Set the size of the display of the tracks of a player.
| nPlayer | The index of the player. |
| nSize | One of GameOptions::FreqSize. |
| void GfxManager::SetWinner | ( | int | nPlayer | ) |
Mark the winner of a song.
| nPlayer | The winner's index, or -1 for none. |
| void GfxManager::SetTrackPlayers | ( | int | nTrack, |
| int | nPlayers, | ||
| const int * | pPlayers ) |
Show which players are on a track.
| nTrack | The track. |
| nPlayers | The number of players on the track. |
| pPlayers | The players, in the order they arrived, or null when there are none. |
| void GfxManager::ShowPlayerOnTrack | ( | int | nPlayer, |
| int | nTrack ) |
Move a player to a track.
| nPlayer | The player's index. |
| nTrack | The track. |
| void GfxManager::SetTrackInstrument | ( | int | nTrack, |
| int | nInstrument ) |
Show the instrument a track changed to, on the track and on every player on it.
| nTrack | The track. |
| nInstrument | The instrument. |
| void GfxManager::ShowPlayerOnFreestyleTrack | ( | int | nPlayer, |
| int | nType, | ||
| int | nInstrument, | ||
| bool | bVictory, | ||
| int | nReserved ) |
Show a player on the freestyle track.
| nPlayer | The player's index. |
| nType | The track type of the freestyle track. |
| nInstrument | The instrument of the freestyle track. |
| bVictory | Whether the freestyle rewards a won song. |
| nReserved | Every caller passes 0. |
| int GfxManager::GetViewedTrack | ( | int | nPlayer | ) |
Report the track the camera of a player shows.
| nPlayer | The player's index. |
| void GfxManager::SetFreestylePosition | ( | int | nPlayer, |
| const Vector3 & | position ) |
Move a player's freestyle effect to a position of the first stick.
| nPlayer | The player index. |
| position | The stick position in the horizontal and depth components. |
|
inline |
Ignore a position of the second stick for a player's freestyle effect.
The body is empty.
| nPlayer | The player index. |
| position | The stick position in the horizontal and depth components. |
| void GfxManager::ShowScratchNote | ( | int | nPlayer, |
| float | fTick, | ||
| float | fDuration ) |
Show a note a scratch plays on a player's track.
| nPlayer | The player's index. |
| fTick | The song tick of the note. |
| fDuration | The length of the note in ticks. |
| void GfxManager::PlaceGem | ( | int | nTrack, |
| int | nSlot, | ||
| int | nPlayer, | ||
| float | fTick, | ||
| int | nStyle, | ||
| int | nFlags ) |
Place a gem on the play field.
| nTrack | The track. |
| nSlot | The gem button the gem lies under. |
| nPlayer | The player the gem is for, or -1. |
| fTick | The tick of the gem. |
| nStyle | The style of the gem. |
| nFlags | The flags of the gem. |
| void GfxManager::RemoveGem | ( | int | nTrack, |
| int | nSlot, | ||
| float | fTick ) |
Take a gem off the play field.
| nTrack | The track. |
| nSlot | The gem button the gem lies under. |
| fTick | The tick of the gem. |
| void GfxManager::ClearGems | ( | int | nTrack, |
| bool | bAll, | ||
| float | fStartTick, | ||
| float | fEndTick ) |
Remove the gems of a track in a range of ticks.
| nTrack | The track. |
| bAll | Whether every kind of gem is removed. |
| fStartTick | The first tick of the range. |
| fEndTick | The tick after the range. |
| void GfxManager::HideNextPhrase | ( | int | nPlayer | ) |
Hide the pointers to the next phrase.
| nPlayer | The player's index. |
| void GfxManager::ShowNextPhrase | ( | int | nTrack, |
| float | fTick, | ||
| int | nGemType ) |
Point at the next phrase on a track.
| nTrack | The track. |
| fTick | The tick of the first gem of the phrase. |
| nGemType | The type of that gem. |
| void GfxManager::SetCatchMeter | ( | int | nPlayer, |
| float | fLevel ) |
Set the meter that shows how much of a phrase a player has caught.
| nPlayer | The player's index. |
| fLevel | The level, from 0 to 1. |
| void GfxManager::ShowGemResult | ( | int | nTrack, |
| int | nSlot, | ||
| bool | bHit, | ||
| int | nPlayer, | ||
| int | nFlags, | ||
| float | fTick ) |
Show the result of a gem a player played or removed.
The triggers fire for the leader, and for every player outside a game.
| nTrack | The track. |
| nSlot | The gem button of the gem. |
| bHit | Whether the gem counts as hit. |
| nPlayer | The player's index. |
| nFlags | The flags of the display. |
| fTick | The tick of the gem. |
| void GfxManager::HitGem | ( | int | nPlayer, |
| int | nTrack, | ||
| int | nSlot, | ||
| float | fTick ) |
Show a player hitting a gem.
| nPlayer | The player's index. |
| nTrack | The track. |
| nSlot | The gem button the gem lies under. |
| fTick | The tick of the gem. |
| void GfxManager::SetFreestyle | ( | int | nPlayer, |
| bool | bActive, | ||
| int | nColumn ) |
Show or hide a player's freestyle effect.
| nPlayer | The player index. |
| bActive | Show the effect. |
| nColumn | The column the effect is drawn at. |
| void GfxManager::ResetFreestyle | ( | int | nPlayer | ) |
Return a player's freestyle effect to its idle state.
| nPlayer | The player index. |
| void GfxManager::ShowCapture | ( | int | nPlayer, |
| int | nTrack, | ||
| int | nStyle, | ||
| bool | bQuiet, | ||
| float | fStartTick, | ||
| float | fEndTick ) |
Show a player catching a phrase.
| nPlayer | The player's index. |
| nTrack | The track. |
| nStyle | The style of the display. DuelTrack passes 0. |
| bQuiet | Whether the status display is not told. DuelTrack passes false. |
| fStartTick | The tick the phrase starts at. |
| fEndTick | The tick after the phrase. |
| void GfxManager::CompleteStage | ( | int | nPlayer, |
| int | nSection ) |
Rank the score bars at the end of a section and, in a solo game, fire the triggers that wait on it.
| nPlayer | The player whose completion the triggers receive. |
| nSection | The section. The display does not read it. |
| void GfxManager::ShowResult | ( | bool | bWon, |
| int | nPlayer, | ||
| bool | bUnlocked ) |
Show the result of a song.
| bWon | Whether the song was won. |
| nPlayer | The player. |
| bUnlocked | Whether winning the song unlocked a new one. |
| void GfxManager::ShowPhrase | ( | int | nPlayer, |
| int | nTrack, | ||
| bool | bPlayable, | ||
| float | fStartTick, | ||
| float | fEndTick, | ||
| int | nStyle, | ||
| bool | bSlide ) |
Show the bars of a phrase on a track, from the camera of a player.
| nPlayer | The player's index. |
| nTrack | The track. |
| bPlayable | Whether the player plays the phrase. |
| fStartTick | The tick the phrase starts at. |
| fEndTick | The tick after the phrase. |
| nStyle | The style of the display. |
| bSlide | Whether the camera moves to the phrase. |
| void GfxManager::SetBar | ( | int | nTrack, |
| int | nPlayer, | ||
| int | nOwner, | ||
| bool | bInSong, | ||
| bool | bVisible, | ||
| int | nFlags, | ||
| signed char | nRiff, | ||
| float | fTick, | ||
| float | fTicks ) |
Set the look of one bar of a track.
| nTrack | The track. |
| nPlayer | The player whose camera shows the bar. |
| nOwner | The player the bar belongs to, or -1. |
| bInSong | Whether the bar maps to a bar of the song. |
| bVisible | Whether the bar is shown. |
| nFlags | The flags of the bar. |
| nRiff | The riff of the bar, or -1. |
| fTick | The tick the bar starts at. |
| fTicks | The length of the bar in ticks. |
| void GfxManager::DimBar | ( | int | nTrack, |
| float | fTick ) |
Dim one bar of a track.
| nTrack | The track. |
| fTick | The tick the bar starts at. |
| void GfxManager::SetTrackEnabled | ( | int | nTrack, |
| bool | bEnabled ) |
Show a track as enabled or disabled.
| nTrack | The track. |
| bEnabled | Whether the track is enabled. |
| void GfxManager::AddCheckpoint | ( | const char * | pszLabel, |
| float | fTick, | ||
| float | fOffset, | ||
| float | fScale ) |
Place a checkpoint on the tracks and on the position in the song.
The position in the song is the fraction of the song the tick makes, or fOffset when the arena does not know the length of the song.
| pszLabel | The label of the checkpoint, or null. |
| fTick | The tick of the checkpoint. |
| fOffset | The position in the song used when the length of the song is unknown. |
| fScale | The scale of the checkpoint. |
| void GfxManager::ClearCheckpoints | ( | ) |
Remove every checkpoint.
| void GfxManager::SetOption | ( | bool | bOption | ) |
Set the display option a solo player toggles.
| bOption | The option. |
| bool GfxManager::GetOption | ( | ) |
Report the display option a solo player toggles.
| void GfxManager::SetScrollSpeed | ( | float | fSpeed | ) |
Set the scroll speed of the lanes.
| fSpeed | The speed, 1 for normal. |
| void GfxManager::BlendToArenaPath | ( | bool | bArena | ) |
Blend the camera of the tunnel towards the arena path or back.
The name is inferred.
| bArena | Blend towards the arena path. |
| void GfxManager::SetPlayerShown | ( | int | nPlayer, |
| bool | bShown ) |
Show or hide the ship of a player.
| nPlayer | The player's index. |
| bShown | Whether the ship is shown. |
| void GfxManager::SetCatcherShown | ( | int | nPlayer, |
| bool | bShown ) |
Show or hide the catcher of a player.
| nPlayer | The player's index. |
| bShown | Whether the catcher is shown. |
| void GfxManager::SetEnergyShown | ( | int | nPlayer, |
| bool | bShown ) |
Show or hide the energy meter.
| nPlayer | The player's index. The display does not read it. |
| bShown | Whether the meter is shown. |
| void GfxManager::SetScoreShown | ( | int | nPlayer, |
| bool | bShown ) |
Show or hide the score of a player.
| nPlayer | The player's index. |
| bShown | Whether the score is shown. |
| void GfxManager::SetLaneShown | ( | int | nPlayer, |
| bool | bShown ) |
Show or hide the avatar display of a player.
| nPlayer | The player's index. |
| bShown | Whether the display is shown. |
| void GfxManager::ShowHud | ( | bool | bShow | ) |
Show or hide the display of the players' scores and meters over the tracks.
| bShow | Whether the display shows. |
| void GfxManager::ClearLanes | ( | ) |
Clear the highlights of the cameras and reset the head-up display.
| void GfxManager::ClearAll | ( | ) |
Clear every effect of the tunnel, reset the ships and the panels of the arena, and clear the start of the head-up display.
| void GfxManager::SetActive | ( | bool | bActive | ) |
Start or stop the victory lap.
The victory lap hides the energy and score bars.
| bActive | Whether the victory lap runs. |
| const Color * GfxManager::GetInstrumentColor | ( | int | nInstrument | ) | const |
Report the colour of an instrument, inst_color_<instrument>.
| nInstrument | The instrument, one of Instrument. |
| const Color * GfxManager::GetInstrumentBgColor | ( | int | nInstrument | ) | const |
Report the background colour of an instrument, inst_bg_color_<instrument>.
| nInstrument | The instrument, one of Instrument. |
| const Color * GfxManager::GetPlayerColor | ( | int | nPlayer | ) | const |
Report the colour of a player, player_color_<colour>.
| nPlayer | The player. |
| const Color * GfxManager::GetPlayerBgColor | ( | int | nPlayer | ) | const |
Report the background colour of a player, player_bg_color_<colour>.
| nPlayer | The player. |
|
inline |
|
inline |
|
inline |
Set whether the vortex draws after the head-up display.
| nValue | The new value. |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Set the length of the song in ticks.
| fValue | The new value. |
|
inline |
|
inline |
|
inline |
Set whether the victory lap runs.
| nValue | The new value. |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Report the ship of a player.
| nPlayer | The player. |
|
inline |
|
inline |
Set the player in the lead.
| nValue | The new value. |
|
inline |
|
inline |
Set whether the winner's avatar was drawn this frame.
| nValue | The new value. |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
staticconstexpr |
The number of ships the display has, one for each player.
|
static |
The colours of the instruments, indexed by Instrument.
|
static |
The background colours of the instruments, indexed by Instrument.
|
static |
The colours of the player slots, indexed by PlayerColor.
|
static |
The background colours of the player slots, indexed by PlayerColor.
|
static |
The textures that may be skipped by a load without a report, merges_always_allowed.
|
static |
The energy at which the top zone of the meter starts.
|
static |
The energy at which the middle zone of the meter starts.
|
static |
|
static |