MainMenu class
#include <Jazz2/UI/Menu/MainMenu.h>
Main menu.
Top-level state handler and IMenuContainer that drives the standalone main menu. It renders the animated menu background and logo, plays the menu music, and hosts the stack of menu sections starting from BeginSection.
Base classes
- class Jazz2::IStateHandler
- Base interface of a state handler, only one handler runs at a time.
- class IMenuContainer
- Base interface of a menu container.
Constructors, destructors, conversion operators
- MainMenu(IRootController* root, bool afterIntro)
- Creates a new instance.
- ~MainMenu() override
Public functions
- void Reset()
- Recreates the menu to the default state.
- auto GetViewSize() const -> Vector2i override
- Returns viewport size of the handler.
- void OnBeginFrame() override
- Called at the beginning of each frame.
-
void OnInitializeViewport(std::
int32_t width, std:: int32_t height) override - Called when the viewport needs to be initialized (e.g., when the resolution is changed).
- void OnKeyPressed(const KeyboardEvent& event) override
- Called when a key is pressed.
- void OnKeyReleased(const KeyboardEvent& event) override
- Called when a key is released.
- void OnTextInput(const TextInputEvent& event) override
- Called when a text input is detected.
-
void OnTouchEvent(const nCine::
TouchEvent& event) override - Called when a touch event is triggered.
-
auto SwitchToSectionDirect(std::
unique_ptr<MenuSection> section) -> MenuSection* override - Switches to already created section.
- void LeaveSection() override
- Leaves current section.
- auto GetCurrentSection() const -> MenuSection* override
- Returns the current section.
- auto GetUnderlyingSection() const -> MenuSection* override
- Returns the next section after the top one.
- void ChangeLevel(LevelInitialization&& levelInit) override
- Changes current level.
- auto HasResumableState() const -> bool override
- Returns
trueif a saved state can be resumed. - void ResumeSavedState() override
- Resumes a saved state.
-
void ConnectToServer(StringView endpoint,
std::
uint16_t defaultPort) override - Connects to a multiplayer server asynchronously.
-
auto CreateServer(Jazz2::
Multiplayer:: ServerInitialization&& serverInit) -> bool override - Creates a multiplayer server.
- void ApplyPreferencesChanges(ChangedPreferencesType type) override
- Applies changes to preferences.
- auto ActionPressed(PlayerAction action) -> bool override
- Returns
trueif specified action is pressed. - auto ActionHit(PlayerAction action) -> bool override
- Returns
trueif specified action is hit (newly pressed). - auto GetContentBounds() const -> Recti override
- Returns content bounds.
-
void DrawElement(AnimState state,
std::
int32_t frame, float x, float y, std:: uint16_t z, Alignment align, const Colorf& color, float scaleX = 1.0f, float scaleY = 1.0f, bool additiveBlending = false, bool unaligned = false) override - Draws a textured element.
-
void DrawElement(AnimState state,
float x,
float y,
std::
uint16_t z, Alignment align, const Colorf& color, Vector2f size, const Vector4f& texCoords, bool unaligned = false) override -
void DrawSolid(float x,
float y,
std::
uint16_t z, Alignment align, Vector2f size, const Colorf& color, bool additiveBlending = false) override - Draws a solid rectangle.
-
void DrawTexture(const Texture& texture,
float x,
float y,
std::
uint16_t z, Alignment align, Vector2f size, const Colorf& color, bool unaligned = false) override - Draws a textured rectangle.
- auto MeasureString(StringView text, float scale = 1.0f, float charSpacing = 1.0f, float lineSpacing = 1.0f) -> Vector2f override
- Measures a string.
-
void DrawStringShadow(StringView text,
std::
int32_t& charOffset, float x, float y, uint16_t z, Alignment align, const Colorf& color, float scale = 1.0f, float angleOffset = 0.0f, float varianceX = 4.0f, float varianceY = 4.0f, float speed = 0.4f, float charSpacing = 1.0f, float lineSpacing = 1.0f) override -
void DrawStringGlow(StringView text,
std::
int32_t& charOffset, float x, float y, std:: uint16_t z, Alignment align, const Colorf& color, float scale = 1.0f, float angleOffset = 0.0f, float varianceX = 4.0f, float varianceY = 4.0f, float speed = 0.4f, float charSpacing = 1.0f, float lineSpacing = 1.0f) override - Draw a string with underglow and shadow.
- void PlaySfx(StringView identifier, float gain = 1.0f) override
- Plays a common sound effect.
Constants
- static int32_t DefaultWidth constexpr
- Default width of viewport.
- static int32_t DefaultHeight constexpr
- Default height of viewport.
Function documentation
Jazz2:: UI:: Menu:: MainMenu:: MainMenu(IRootController* root,
bool afterIntro)
Creates a new instance.
| Parameters | |
|---|---|
| root | Root controller the menu is attached to |
| afterIntro | Whether the menu is shown right after the intro, playing a fade-in transition |
void Jazz2:: UI:: Menu:: MainMenu:: DrawElement(AnimState state,
float x,
float y,
std:: uint16_t z,
Alignment align,
const Colorf& color,
Vector2f size,
const Vector4f& texCoords,
bool unaligned = false) override
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.