|
| BitmapButton (const char *typeName="BitmapButton", bool initRenderer=true) |
|
| BitmapButton (const BitmapButton &) |
| Copy constructor.
|
|
| BitmapButton (BitmapButton &&) |
| Move constructor.
|
|
BitmapButton & | operator= (const BitmapButton &) |
| Overload of copy assignment operator.
|
|
BitmapButton & | operator= (BitmapButton &&) |
| Move assignment.
|
|
| ~BitmapButton () |
| Destructor.
|
|
void | setSize (const Layout2d &size) override |
| Changes the size of the button.
|
|
virtual void | setText (const String &text) override |
| Changes the caption of the button.
|
|
void | setImage (const Texture &image) |
| Sets the image that should be displayed next to the text.
|
|
const Texture & | getImage () const |
| Returns the image being displayed next to the text.
|
|
void | setImageScaling (float relativeHeight) |
| Sets the relative size of the image to display next to the text.
|
|
float | getImageScaling () const |
| Returns the relative size of the image displayed next to the text.
|
|
virtual void | setSize (const Layout2d &size) |
| Changes the size of the widget.
|
|
void | setSize (Layout width, Layout height) |
| Changes the size of the widget.
|
|
| Button (const char *typeName="Button", bool initRenderer=true) |
|
void | leftMousePressed (Vector2f pos) override |
|
void | leftMouseReleased (Vector2f pos) override |
|
void | leftMouseButtonNoLongerDown () override |
|
void | keyPressed (const Event::KeyEvent &event) override |
|
| ButtonBase (const char *typeName, bool initRenderer) |
|
| ButtonBase (const ButtonBase &) |
| Copy constructor.
|
|
| ButtonBase (ButtonBase &&) |
| Move constructor.
|
|
ButtonBase & | operator= (const ButtonBase &) |
| Overload of copy assignment operator.
|
|
ButtonBase & | operator= (ButtonBase &&) |
| Move assignment.
|
|
ButtonRenderer * | getSharedRenderer () |
| Returns the renderer, which gives access to functions that determine how the widget is displayed.
|
|
const ButtonRenderer * | getSharedRenderer () const |
|
ButtonRenderer * | getRenderer () |
| Returns the renderer, which gives access to functions that determine how the widget is displayed.
|
|
const ButtonRenderer * | getRenderer () const |
|
void | setSize (const Layout2d &size) override |
| Changes the size of the button.
|
|
void | setEnabled (bool enabled) override |
| Enables or disables the widget.
|
|
const String & | getText () const |
| Returns the caption of the button.
|
|
void | setTextSize (unsigned int size) override |
| Changes the character size of the text.
|
|
unsigned int | getTextSize () const override |
| Returns the character size of the text.
|
|
void | setFocused (bool focused) override |
| Focus or unfocus the widget.
|
|
bool | isMouseOnWidget (Vector2f pos) const override |
| Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
|
|
void | leftMousePressed (Vector2f pos) override |
|
void | leftMouseReleased (Vector2f pos) override |
|
void | leftMouseButtonNoLongerDown () override |
|
void | draw (BackendRenderTargetBase &target, RenderStates states) const override |
| Draw the widget to a render target.
|
|
virtual void | setSize (const Layout2d &size) |
| Changes the size of the widget.
|
|
void | setSize (Layout width, Layout height) |
| Changes the size of the widget.
|
|
| ClickableWidget (const char *typeName="ClickableWidget", bool initRenderer=true) |
|
bool | isMouseOnWidget (Vector2f pos) const override |
| Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
|
|
void | leftMousePressed (Vector2f pos) override |
|
void | leftMouseReleased (Vector2f pos) override |
|
void | rightMousePressed (Vector2f pos) override |
|
void | rightMouseReleased (Vector2f pos) override |
|
void | rightMouseButtonNoLongerDown () override |
|
void | draw (BackendRenderTargetBase &target, RenderStates states) const override |
| Draw the widget to a render target.
|
|
| Widget (const char *typeName, bool initRenderer) |
|
| Widget (const Widget &) |
| Copy constructor.
|
|
| Widget (Widget &&) |
| Move constructor.
|
|
virtual | ~Widget () |
| Destructor.
|
|
Widget & | operator= (const Widget &) |
| Overload of copy assignment operator.
|
|
Widget & | operator= (Widget &&) |
| Move assignment.
|
|
void | setRenderer (std::shared_ptr< RendererData > rendererData) |
| Sets a new renderer for the widget. The renderer determines how the widget looks.
|
|
WidgetRenderer * | getSharedRenderer () |
| Returns the renderer, which gives access to functions that determine how the widget is displayed.
|
|
const WidgetRenderer * | getSharedRenderer () const |
|
WidgetRenderer * | getRenderer () |
| Returns the renderer, which gives access to functions that determine how the widget is displayed.
|
|
const WidgetRenderer * | getRenderer () const |
|
virtual void | setPosition (const Layout2d &position) |
| sets the position of the widget
|
|
void | setPosition (Layout x, Layout y) |
| Sets the position of the widget.
|
|
Vector2f | getPosition () const |
| Gets the position of the widget.
|
|
void | setSize (Layout width, Layout height) |
| Changes the size of the widget.
|
|
void | setWidth (Layout width) |
| Changes the width of the widget.
|
|
void | setHeight (Layout height) |
| Changes the height of the widget.
|
|
Vector2f | getSize () const |
| Returns the size of the widget.
|
|
virtual Vector2f | getFullSize () const |
| Returns the entire size that the widget is using.
|
|
virtual Vector2f | getAbsolutePosition () const |
| Get the absolute position of the top-left point of the widget instead of the relative position to its parent.
|
|
virtual Vector2f | getWidgetOffset () const |
| Returns the distance between the position where the widget is drawn and where the widget is placed.
|
|
void | setOrigin (float x, float y) |
| Sets the origin point on which the position, scale and rotation is based.
|
|
void | setOrigin (Vector2f origin) |
| Sets the origin point on which the position, scale and rotation is based.
|
|
Vector2f | getOrigin () const |
| Returns the relative origin point on which the position, scale and rotation is based.
|
|
void | setScale (Vector2f scaleFactors) |
| Sets the scaling to be applied to the widget.
|
|
void | setScale (Vector2f scaleFactors, Vector2f origin) |
| Sets the scaling to be applied to the widget.
|
|
void | setScale (float scaleFactor) |
| Sets the scaling to be applied to the widget.
|
|
void | setScale (float scaleFactor, Vector2f origin) |
| Sets the scaling to be applied to the widget.
|
|
Vector2f | getScale () const |
| Returns the scaling to be applied to the widget.
|
|
Vector2f | getScaleOrigin () const |
| Returns the origin used for scaling.
|
|
void | setRotation (float angle) |
| Sets the rotation to be applied to the widget.
|
|
void | setRotation (float angle, Vector2f origin) |
| Sets the rotation to be applied to the widget.
|
|
float | getRotation () const |
| Returns the rotation to be applied to the widget.
|
|
Vector2f | getRotationOrigin () const |
| Returns the origin used for rotations.
|
|
void | showWithEffect (ShowEffectType type, Duration duration) |
| Shows the widget by introducing it with an animation.
|
|
void | hideWithEffect (ShowEffectType type, Duration duration) |
| Hides the widget by making it leave with an animation.
|
|
virtual void | setVisible (bool visible) |
| Shows or hides a widget.
|
|
bool | isVisible () const |
| Returns true when the widget is visible.
|
|
bool | isEnabled () const |
| Returns true when the widget is enabled.
|
|
bool | isFocused () const |
| Returns true when the widget is focused and false otherwise.
|
|
const String & | getWidgetType () const |
| Returns the type of the widget.
|
|
Container * | getParent () const |
| Returns a pointer to the parent widget.
|
|
GuiBase * | getParentGui () const |
| Returns a pointer to the gui to which this widget belongs.
|
|
bool | isAnimationPlaying () const |
| Returns whether there is an active animation (started with showWithEffect or hideWithEffect)
|
|
void | moveToFront () |
| Places the widget before all other widgets.
|
|
void | moveToBack () |
| Places the widget behind all other widgets.
|
|
void | setUserData (Any userData) |
| Stores some data into the widget.
|
|
template<typename T > |
T | getUserData () const |
| Returns data stored in the widget.
|
|
void | setInheritedFont (const Font &font) |
| Sets the font of the widget that is used when no font is set in the renderer.
|
|
const Font & | getInheritedFont () const |
| Returns the font of the widget that is used when no font is set in the renderer.
|
|
void | setInheritedOpacity (float opacity) |
| Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.
|
|
float | getInheritedOpacity () const |
| Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
|
|
void | setToolTip (Widget::Ptr toolTip) |
| Sets the tool tip that should be displayed when hovering over the widget.
|
|
Widget::Ptr | getToolTip () const |
| Returns the tool tip that is displayed when hovering over the widget.
|
|
void | setWidgetName (const String &name) |
| Changes the name of a widget.
|
|
String | getWidgetName () const |
| Returns the name of a widget.
|
|
void | setMouseCursor (Cursor::Type cursor) |
| Changes which mouse cursor is shown when hovering over the widget.
|
|
Cursor::Type | getMouseCursor () const |
| Returns which mouse cursor is shown when hovering over the widget.
|
|
void | setFocusable (bool focusable) |
| Changes whether a widget could be focused.
|
|
bool | isFocusable () const |
| Returns whether a widget could be focused.
|
|
virtual bool | canGainFocus () const |
| Returns whether the widget can currently gain focus.
|
|
bool | isContainer () const |
| Returns whether the widget is a container widget or not.
|
|
bool | isDraggableWidget () const |
| Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
|
|
bool | isMouseDown () const |
| Returns whether the left mouse button has been pressed on top of the widget.
|
|
virtual void | setParent (Container *parent) |
|
virtual bool | updateTime (Duration elapsedTime) |
|
virtual void | mousePressed (Event::MouseButton button, Vector2f pos) |
|
virtual void | mouseReleased (Event::MouseButton button, Vector2f pos) |
|
virtual void | mouseMoved (Vector2f pos) |
|
virtual void | textEntered (char32_t key) |
|
virtual bool | mouseWheelScrolled (float delta, Vector2f pos) |
|
virtual void | mouseNoLongerOnWidget () |
|
virtual Widget::Ptr | askToolTip (Vector2f mousePos) |
|
const Layout2d & | getPositionLayout () const |
|
const Layout2d & | getSizeLayout () const |
|
void | bindPositionLayout (Layout *layout) |
|
void | unbindPositionLayout (Layout *layout) |
|
void | bindSizeLayout (Layout *layout) |
|
void | unbindSizeLayout (Layout *layout) |
|
template<typename WidgetType > |
std::shared_ptr< const WidgetType > | cast () const |
| Downcast const widget.
|
|
template<typename WidgetType > |
std::shared_ptr< WidgetType > | cast () |
| Downcast widget.
|
|
|
void | rendererChanged (const String &property) override |
| Function called when one of the properties of the renderer is changed.
|
|
std::unique_ptr< DataIO::Node > | save (SavingRenderersMap &renderers) const override |
| Saves the widget as a tree node in order to save it to a file.
|
|
void | load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override |
| Loads the widget from a tree of nodes.
|
|
void | updateSize () override |
|
void | initComponentsBitmapButton () |
|
void | updateComponentPositions () |
|
Widget::Ptr | clone () const override |
| Makes a copy of the widget if you don't know its exact type.
|
|
void | mouseEnteredWidget () override |
| This function is called when the mouse enters the widget.
|
|
void | mouseLeftWidget () override |
| This function is called when the mouse leaves the widget.
|
|
Signal & | getSignal (String signalName) override |
| Retrieves a signal based on its name.
|
|
Widget::Ptr | clone () const override |
| Makes a copy of the widget if you don't know its exact type.
|
|
void | mouseEnteredWidget () override |
| This function is called when the mouse enters the widget.
|
|
void | mouseLeftWidget () override |
| This function is called when the mouse leaves the widget.
|
|
void | rendererChanged (const String &property) override |
| Function called when one of the properties of the renderer is changed.
|
|
std::unique_ptr< DataIO::Node > | save (SavingRenderersMap &renderers) const override |
| Saves the widget as a tree node in order to save it to a file.
|
|
void | load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override |
| Loads the widget from a tree of nodes.
|
|
void | updateState () |
|
virtual void | initComponents () |
|
void | addComponent (const std::shared_ptr< priv::dev::Component > &component) |
|
std::shared_ptr< priv::dev::Component > | getComponent (const String &name) |
|
Signal & | getSignal (String signalName) override |
| Retrieves a signal based on its name.
|
|
Widget::Ptr | clone () const override |
| Makes a copy of the widget if you don't know its exact type.
|
|
|
SignalString | onPress = {"Pressed"} |
| The button was pressed. Optional parameter: text of the button.
|
|
SignalVector2f | onMousePress = {"MousePressed"} |
| The mouse went down on the widget. Optional parameter: mouse position relative to widget.
|
|
SignalVector2f | onMouseRelease = {"MouseReleased"} |
| The mouse was released on top of the widget. Optional parameter: mouse position relative to widget.
|
|
SignalVector2f | onClick = {"Clicked"} |
| The widget was clicked. Optional parameter: mouse position relative to widget.
|
|
SignalVector2f | onRightMousePress = {"RightMousePressed"} |
| The right mouse button went down on the widget. Optional parameter: mouse position relative to widget.
|
|
SignalVector2f | onRightMouseRelease = {"RightMouseReleased"} |
| The right mouse button was released on top of the widget. Optional parameter: mouse position relative to widget.
|
|
SignalVector2f | onRightClick = {"RightClicked"} |
| The widget was right clicked. Optional parameter: mouse position relative to widget.
|
|
SignalVector2f | onPositionChange = {"PositionChanged"} |
| The position of the widget changed. Optional parameter: new position.
|
|
SignalVector2f | onSizeChange = {"SizeChanged"} |
| The size of the widget changed. Optional parameter: new size.
|
|
Signal | onFocus = {"Focused"} |
| The widget was focused.
|
|
Signal | onUnfocus = {"Unfocused"} |
| The widget was unfocused.
|
|
Signal | onMouseEnter = {"MouseEntered"} |
| The mouse entered the widget.
|
|
Signal | onMouseLeave = {"MouseLeft"} |
| The mouse left the widget.
|
|
SignalShowEffect | onAnimationFinish = {"AnimationFinished"} |
|
SignalShowEffect | onShowEffectFinish = {"ShowEffectFinished"} |
| A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
|
|
using | SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > > |
|
using | LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > > |
|
String | m_string |
|
bool | m_down = false |
|
priv::dev::ComponentState | m_state = priv::dev::ComponentState::Normal |
|
bool | m_autoSize = true |
|
bool | m_updatingSizeWhileSettingText = false |
|
priv::dev::StylePropertyBackground | background |
|
priv::dev::StylePropertyText | text |
|
std::map< String, priv::dev::StylePropertyBase * > | m_stylePropertiesNames |
|
std::map< String, std::vector< priv::dev::StylePropertyBase * > > | m_stylePropertiesGlobalNames |
|
std::map< String, std::shared_ptr< priv::dev::Component > > | m_namedComponents |
|
std::shared_ptr< priv::dev::BackgroundComponent > | m_backgroundComponent |
|
std::shared_ptr< priv::dev::TextComponent > | m_textComponent |
|
std::vector< std::shared_ptr< priv::dev::Component > > | m_components |
|
String | m_type |
|
String | m_name |
|
Layout2d | m_position |
|
Layout2d | m_size |
|
unsigned int | m_textSize = 0 |
|
Vector2f | m_origin |
|
Optional< Vector2f > | m_rotationOrigin |
|
Optional< Vector2f > | m_scaleOrigin |
|
Vector2f | m_scaleFactors = {1, 1} |
|
float | m_rotationDeg = 0 |
|
Vector2f | m_prevPosition |
|
Vector2f | m_prevSize |
|
std::unordered_set< Layout * > | m_boundPositionLayouts |
|
std::unordered_set< Layout * > | m_boundSizeLayouts |
|
bool | m_enabled = true |
|
bool | m_visible = true |
|
Container * | m_parent = nullptr |
|
GuiBase * | m_parentGui = nullptr |
|
bool | m_mouseHover = false |
|
bool | m_mouseDown = false |
|
bool | m_focused = false |
|
bool | m_focusable = true |
|
Duration | m_animationTimeElapsed |
|
bool | m_draggableWidget = false |
|
bool | m_containerWidget = false |
|
Widget::Ptr | m_toolTip = nullptr |
|
aurora::CopiedPtr< WidgetRenderer > | m_renderer = nullptr |
|
std::vector< std::shared_ptr< priv::Animation > > | m_showAnimations |
|
Font | m_inheritedFont |
|
float | m_inheritedOpacity = 1 |
|
Font | m_fontCached = Font::getGlobalFont() |
|
float | m_opacityCached = 1 |
|
bool | m_transparentTextureCached = false |
|
Any | m_userData |
|
Cursor::Type | m_mouseCursor = Cursor::Type::Arrow |
|
std::function< void(const String &property)> | m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); } |
|