Lysa UI  0.0
Lysa UI —UI components for the Lysa Engine
Public Member Functions | List of all members
Image Class Reference

Detailed Description

A widget to display a 2D image.

+ Inheritance diagram for Image:

Public Member Functions

 Image (const lysa::Image &image, bool autoSize=true)
 
 Image (bool autoSize=true)
 
void setAutoSize (bool autoSize)
 
void setColor (const float4 &color)
 
auto getColor () const
 
void setImage (const lysa::Image &image)
 
auto getImage () const
 
- Public Member Functions inherited from Widget
 Widget (Type type=WIDGET)
 
virtual ~Widget () = default
 
Type getType () const
 
bool isVisible () const
 
void show (bool show=true)
 
bool isEnabled () const
 
void enable (bool isEnabled=true)
 
void setPos (float x, float y)
 
float getWidth () const
 
float getHeight () const
 
virtual void setSize (float width, float height)
 
const Rect & getRect () const
 
void setRect (float x, float y, float width, float height)
 
void setRect (const Rect &rect)
 
Alignment getAlignment () const
 
void setAlignment (Alignment alignment)
 
std::shared_ptr< Font > getFont () const
 
void setFont (const std::shared_ptr< Font > &font)
 
float getFontScale () const
 
virtual void setFontScale (float fontScale)
 
bool isFocused () const
 
Widget * getParent () const
 
template<typename T , typename... Args>
std::shared_ptr< T > create (const std::string &resource, const Alignment alignment, Args &&...args)
 
template<typename T , typename... Args>
std::shared_ptr< T > create (const Alignment alignment, Args &&...args)
 
template<typename T >
std::shared_ptr< T > add (std::shared_ptr< T > child, const Alignment alignment, const std::string &resource="", const bool overlap=false)
 
virtual void remove (const std::shared_ptr< Widget > &child)
 
virtual void removeAll ()
 
void setPadding (float padding)
 
float getPadding () const
 
float getVBorder () const
 
float getHBorder () const
 
void setVBorder (float size)
 
void setHBorder (float size)
 
bool isDrawBackground () const
 
void setDrawBackground (bool drawBackground)
 
bool isPushed () const
 
bool isPointed () const
 
bool isFreezed () const
 
bool isRedrawOnMouseEvent () const
 
bool isOverlapping () const
 
Rect getChildrenRect () const
 
void setFreezed (const bool f)
 
void setPushed (const bool p)
 
void refresh () const
 
void setResource (std::shared_ptr< UIResource > resource)
 
uint32 getGroupIndex () const
 
void setGroupIndex (int32 index)
 
void * getUserData () const
 
void setUserData (void *data)
 
float getTransparency () const
 
void setTransparency (float alpha)
 
void resizeChildren ()
 
std::shared_ptr< Widget > setFocus (bool=true)
 
virtual void eventDestroy ()
 
virtual void eventShow ()
 
virtual void eventHide ()
 
virtual void eventEnable ()
 
virtual void eventDisable ()
 
virtual void eventMove (float x, float y)
 
virtual void eventResize ()
 
virtual bool eventTextInput (const std::string &text)
 
virtual bool eventKeyDown (Key key)
 
virtual bool eventKeyUp (Key key)
 
virtual bool eventMouseDown (MouseButton button, float x, float y)
 
virtual bool eventMouseUp (MouseButton button, float x, float y)
 
virtual bool eventMouseMove (uint32, float x, float y)
 
virtual void eventGotFocus ()
 
virtual void eventLostFocus ()
 

Additional Inherited Members

- Public Types inherited from Widget
enum  Type {
  WIDGET, PANEL, BOX, LINE,
  FRAME, BUTTON, TOGGLEBUTTON, TEXT,
  TEXTEDIT, SCROLLBAR, TREEVIEW, IMAGE
}
 
- Protected Attributes inherited from Widget
const Type type
 
Rect rect
 
Rect defaultRect
 
float hborder {0}
 
float vborder {0}
 
float padding {0}
 
bool overlap {false}
 
bool focused {false}
 
bool allowFocus {false}
 
bool allowChildren {true}
 
bool drawBackground {true}
 
bool moveChildrenOnPush {false}
 
bool redrawOnMouseEvent {false}
 
bool redrawOnMouseMove {false}
 
float transparency {1.0f}
 
Widget * parent {nullptr}
 
Alignment alignment {Alignment::NONE}
 
std::shared_ptr< UIResource > resource
 
std::list< std::shared_ptr< Widget > > children
 
void * window {nullptr}
 
void * style {nullptr}
 
bool mouseMoveOnFocus {false}
 
float fontScale {0.0f}
 

Constructor & Destructor Documentation

Image ( const lysa::Image &  image,
bool  autoSize = true 
)

Constructor with image.

Parameters
ctxThe engine context.
imageThe image to display.
autoSizeWhether to automatically resize the widget to the image size.
Image ( bool  autoSize = true)

Constructor without image.

Parameters
ctxThe engine context.
autoSizeWhether to automatically resize the widget.

Member Function Documentation

auto getColor ( ) const
inline

Returns the image color tint.

auto getImage ( ) const
inline

Returns the currently displayed image.

Returns
Pointer to the image, or nullptr.
void setAutoSize ( bool  autoSize)

Sets whether to automatically resize the widget to the image size.

void setColor ( const float4 &  color)

Sets the image color tint.

void setImage ( const lysa::Image &  image)

Sets the image to display.