|
wavelength 1.0.0
|
Front-end panel of Amplitude's menus, with the gizmo pyramid and the panel material animations. More...
#include <freqpanel.h>


Public Member Functions | |
| FreqPanel (DataArray *pData, const char *pszDir) | |
| Construct a panel from its script description. | |
| ~FreqPanel () override | |
| Destroy the panel. | |
| void | Unload () override |
| Drop a reference to the panel's file, forgetting the meshes and the animation on the last reference. | |
| void | Enter (bool bForce, float fTime) override |
| Start the entry animation and the entry of the panel material animation. | |
| void | Exit (bool bForce, float fTime) override |
| Start the exit animation and the exit of the panel material animation. | |
| void | DrawGizmo () override |
| Stretch the gizmo pyramid from the background mesh to the gizmo and draw it. | |
| void | Poll (float fTime) override |
| Advance the panel to a time and move the panel animation to the panel's frame. | |
| void | Draw () override |
| Move the panel material animations to the front-end time and draw the panel. | |
| void | SetShowing (bool bShowing) override |
| Show or hide the panel's view and the gizmo pyramid. | |
| void | SetFocus (UIComponent *pComponent, int nButton) override |
| Move the focus to a component and play the sound of the directional button that moved it. | |
| void | FinishLoad () override |
| Find the meshes and animations of the panel once its file has loaded. | |
| void | ShowGizmoMesh (bool bShowing) |
| Show or hide the gizmo pyramid. | |
| void | UpdateBgBox () |
| Measure the background mesh into mBgBox. | |
| Public Member Functions inherited from UIPanel | |
| UIPanel (DataArray *pData, const char *pszDir) | |
| Construct a hidden panel from its script description. | |
| ~UIPanel () override | |
| Destroy the panel, its components, and the objects its file loaded. | |
| bool | Dispatch (Message *pMsg) override |
| Offer a message to the current screen, the panel, the navigator, and the component with the focus. | |
| bool | DispatchPriv (Message *pMsg) override |
| Handle a message sent to the panel. | |
| virtual void | Load () |
| Take a reference to the panel's file, queueing the file on the first reference. | |
| virtual void | Focus () |
| React to the screen giving the panel the focus by letting the navigator move the focus. | |
| virtual void | Unfocus () |
| React to the screen taking the focus away. | |
| bool | IsLoaded () |
| Report whether the panel's file has loaded, finishing the load when it has. | |
| void | AddComponent (UIComponent *pComponent) |
| Register a component under its name. | |
| void | SetTextsShowing (bool bShowing) |
| Show or hide every text object of the panel's file. | |
| float | ComputeFrame (float fTime) |
| Report the frame of the entry and exit animation at a time. | |
| UIComponent * | FindComponent (const char *pszName, bool bFail) |
| Find a component by name. | |
| void | LocalizeTexts (const char *pszFile, std::list< RndObject * > &objects) |
| Collect and localise the text objects of the panel's file. | |
| const char * | GetName () const |
| UIComponent * | GetFocus () const |
| int | GetState () const |
| float | GetTransitionStart () const |
| const std::map< const char *, std::unique_ptr< UIComponent >, StrLess > & | GetComponents () const |
| Public Member Functions inherited from MsgSink | |
| void * | operator new (size_t nSize) |
| Allocate a sink from the pool heaps under the tag "MsgSink". | |
| void | operator delete (void *pBlock) |
| Return a sink to the pool heaps. | |
| virtual | ~MsgSink () |
| void * | operator new (size_t size) |
| Allocate from the main heap under the name MsgSink. | |
| void | operator delete (void *mem) |
| Return memory to its heap. | |
| virtual | ~MsgSink () |
| Destroy the sink. | |
Static Public Member Functions | |
| static UIPanel * | New (DataArray *pData, const char *pszDir) |
| Create a panel from its script description. | |
| static void | Init (DataArray *pConfig) |
| Read the freq_panel section of the metagame configuration. | |
| Static Public Member Functions inherited from UIPanel | |
| static void | Init (DataArray *pConfig) |
| Read the default frames of the entry and exit animation. | |
| static UIPanel * | New (DataArray *pData, const char *pszDir) |
| Create a panel from its script description. | |
Public Attributes | |
| Box | mBgBox |
Static Public Attributes | |
| static constexpr int | kNumGizmoOffsets = 3 |
| The number of gizmo offsets the configuration provides. | |
| static Vector3 | sGizmoOrigPos |
| The position of the gizmo, the panel_gizmo_orig_pos setting. | |
| static Vector3 | sGizmoOffsets [kNumGizmoOffsets] |
| The points of the gizmo the pyramids reach, the panel_gizmo_offset_1 to _3 settings. | |
Additional Inherited Members | |
| Public Types inherited from UIPanel | |
| enum | State { kStateShown = 0 , kStateHidden = 1 , kStateEntering = 2 , kStateExiting = 3 } |
| Where the panel is in its entry and exit, the values of mState. More... | |
| Protected Attributes inherited from UIPanel | |
| float | mFrame |
| float | mIdleFrame |
| const char * | mName |
| String | mFile |
| int | mState |
| RndView * | mView |
| const char * | mFocusName |
| float | mLoopStart |
| RndAnimatable * | mLoopAnim |
| RndAnimatable * | mEnterExitAnim |
| float | mTransitionStart |
| float | mShownFrame |
| float | mHiddenFrame |
| float | mEnterMs |
| float | mExitMs |
| int | mEnterReversed |
| int | mExitReversed |
| float | mEnterStartFrame |
| float | mExitStartFrame |
| int | mLoadRefs |
| int | mLoaded |
| DataArray * | mData |
| std::list< RndText * > | mTexts |
| std::map< const char *, std::unique_ptr< UIComponent >, StrLess > | mComponents |
| std::unique_ptr< UINavigator > | mNavigator |
| UIComponent * | mFocus |
| RndLoader * | mLoader |
| std::unique_ptr< RndLoader > | mOwnedLoader |
| The loader the panel created, or null when it has none or uses a shared one. | |
Front-end panel of Amplitude's menus, with the gizmo pyramid and the panel material animations.
The RTTI records the class as deriving from UIPanel. The object is 0xe0 bytes, and the vtable is at 0x003cfc28. The metagame registers the class for the panel type freq_panel, and most panel classes of the menus derive from it.
Once its file has loaded, a panel clones pyramid.mesh under its own name as the gizmo mesh. The pyramid reaches from the panel's background mesh <name>_bg.mesh to the gizmo offset the panel's gizmoOffsetIndex selects, and it draws under the panel. The panel also drives the shared material animations mat_2d_always.anim and mat_2d_EE.anim, and the copy of the transform animation panel_anim_name it makes for its <name>_panel.mesh.
| FreqPanel::FreqPanel | ( | DataArray * | pData, |
| const char * | pszDir ) |
Construct a panel from its script description.
| pData | The script description. |
| pszDir | The directory of the description file. |
|
override |
Destroy the panel.
Create a panel from its script description.
The metagame registers the routine for the panel type freq_panel.
| pData | The script description. |
| pszDir | The directory of the description file. |
|
static |
Read the freq_panel section of the metagame configuration.
| pConfig | The metagame section of the configuration. |
|
overridevirtual |
Drop a reference to the panel's file, forgetting the meshes and the animation on the last reference.
Reimplemented from UIPanel.
Reimplemented in FreqSelPanel, HelpPanel, SoloLoseTipsPanel, and SoloWinStatsPanel.
|
overridevirtual |
Start the entry animation and the entry of the panel material animation.
| bForce | Show the panel at once instead of animating. |
| fTime | The front-end time in milliseconds. |
Reimplemented from UIPanel.
Reimplemented in FreqSelPanel, KeyboardPanel, LaunchMTVPanel, MCDialogPanel, NetFoundPlayerPanel, NetLPadGamePanel, NetLPadPlayerPanel, NetMainPanel, NetMainPlayersPanel, NetRankedPlayersPanel, NetSortedLaunchpadsPanel, and SoloLoseTipsPanel.
|
overridevirtual |
Start the exit animation and the exit of the panel material animation.
| bForce | Hide the panel at once instead of animating. |
| fTime | The front-end time in milliseconds. |
Reimplemented from UIPanel.
Reimplemented in KeyboardPanel, NetMainPanel, NetMainPlayersPanel, SoloWinStatsPanel, and SongPicPanel.
|
overridevirtual |
Stretch the gizmo pyramid from the background mesh to the gizmo and draw it.
Reimplemented from UIPanel.
|
overridevirtual |
Advance the panel to a time and move the panel animation to the panel's frame.
| fTime | The front-end time in milliseconds. |
Reimplemented from UIPanel.
Reimplemented in FullRankedPanel, KeyboardPanel, NetMainPanel, SoloLoseTipsPanel, SoloWinStatsPanel, and SongPicPanel.
|
overridevirtual |
Move the panel material animations to the front-end time and draw the panel.
Reimplemented from UIPanel.
Reimplemented in NetMainPlayersPanel.
|
overridevirtual |
Show or hide the panel's view and the gizmo pyramid.
| bShowing | Whether the panel shows. |
Reimplemented from UIPanel.
|
overridevirtual |
Move the focus to a component and play the sound of the directional button that moved it.
| pComponent | The component, or null. |
| nButton | The controller button that moved the focus, or kPadNone. |
Reimplemented from UIPanel.
Reimplemented in KeyboardPanel.
|
overridevirtual |
Find the meshes and animations of the panel once its file has loaded.
The first load makes the panel animation, its copy of panel_anim_name, and the gizmo pyramid, and hands each to the loader so they go when the panel unloads.
Reimplemented from UIPanel.
Reimplemented in FullRankedPanel, HelpPanel, NetButtonPanel, NetMainPanel, NetMainPlayersPanel, and SongPicPanel.
| void FreqPanel::ShowGizmoMesh | ( | bool | bShowing | ) |
Show or hide the gizmo pyramid.
| bShowing | Whether the pyramid shows. |
| void FreqPanel::UpdateBgBox | ( | ) |
Measure the background mesh into mBgBox.
|
staticconstexpr |
The number of gizmo offsets the configuration provides.
|
static |
The position of the gizmo, the panel_gizmo_orig_pos setting.
|
static |
The points of the gizmo the pyramids reach, the panel_gizmo_offset_1 to _3 settings.
| Box FreqPanel::mBgBox |
The bounding box of mBgMesh in its local space.