1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
|
/**
bespoke synth, a software modular synthesizer
Copyright (C) 2021 Ryan Challinor (contact: awwbees@gmail.com)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
**/
//
// HelpDisplay.h
// Bespoke
//
// Created by Ryan Challinor on 2/7/15.
//
//
#pragma once
#include "IDrawableModule.h"
#include "RadioButton.h"
#include "ClickButton.h"
#include "ModuleFactory.h"
class HelpDisplay : public IDrawableModule, public IRadioButtonListener, public IButtonListener
{
public:
HelpDisplay();
virtual ~HelpDisplay();
static IDrawableModule* Create() { return new HelpDisplay(); }
static bool AcceptsAudio() { return false; }
static bool AcceptsNotes() { return false; }
static bool AcceptsPulses() { return false; }
bool IsSaveable() override { return false; }
bool HasTitleBar() const override { return false; }
void CreateUIControls() override;
void Poll() override;
void Show() { mScrollOffsetY = 0; }
std::string GetUIControlTooltip(IUIControl* control);
std::string GetModuleTooltip(IDrawableModule* module);
std::string GetModuleTooltipFromName(std::string moduleTypeName);
void CheckboxUpdated(Checkbox* checkbox, double time) override;
void RadioButtonUpdated(RadioButton* radio, int oldVal, double time) override {}
void ButtonClicked(ClickButton* button, double time) override;
void ScreenshotModule(IDrawableModule* module);
static bool sShowTooltips;
bool IsEnabled() const override { return true; }
private:
//IDrawableModule
void DrawModule() override;
void GetModuleDimensions(float& w, float& h) override;
bool MouseScrolled(float x, float y, float scrollX, float scrollY, bool isSmoothScroll, bool isInvertedScroll) override;
void RenderScreenshot(int x, int y, int width, int height, std::string filename);
struct UIControlTooltipInfo
{
std::string controlName;
std::string tooltip;
};
struct ModuleTooltipInfo
{
std::string module;
std::string tooltip;
std::list<UIControlTooltipInfo> controlTooltips;
};
void LoadHelp();
void LoadTooltips();
ModuleTooltipInfo* FindModuleInfo(std::string moduleTypeName);
UIControlTooltipInfo* FindControlInfo(IUIControl* control);
std::vector<std::string> mHelpText;
Checkbox* mShowTooltipsCheckbox{ nullptr };
ClickButton* mCopyBuildInfoButton{ nullptr };
ClickButton* mDumpModuleInfoButton{ nullptr };
ClickButton* mDoModuleScreenshotsButton{ nullptr };
ClickButton* mDoModuleDocumentationButton{ nullptr };
ClickButton* mTutorialVideoLinkButton{ nullptr };
ClickButton* mDocsLinkButton{ nullptr };
ClickButton* mDiscordLinkButton{ nullptr };
float mWidth{ 700 };
float mHeight{ 700 };
static bool sTooltipsLoaded;
static std::list<ModuleTooltipInfo> sTooltips;
std::list<ModuleFactory::Spawnable> mScreenshotsToProcess;
IDrawableModule* mScreenshotModule{ nullptr };
float mScrollOffsetY{ 0 };
float mMaxScrollAmount{ 0 };
enum class ScreenshotState
{
None,
WaitingForSpawn,
WaitingForScreenshot
};
ScreenshotState mScreenshotState{ ScreenshotState::None };
int mScreenshotCountdown{ 0 };
};
|