Neo  0.5.0
Developer Documentation
Neo2D::Gui::Window Class Reference

This class implements a Window that can be used to display widgets. More...

#include <Window.h>

+ Inheritance diagram for Neo2D::Gui::Window:

Public Member Functions

 Window (unsigned int x, unsigned int y, unsigned int width, unsigned int height, const char *label)
 
 ~Window ()
 
void setWindowManager (WindowManager *wm)
 
bool containsPoint (float x, float y)
 
void draw ()
 Draws the widget to the canvas it belongs to. More...
 
void draw (Vector2 offset)
 Draws the widget to the canvas it belongs to. More...
 
void update ()
 Updates the widget and calls the callback if necessary. More...
 
virtual bool isMouseOver ()
 
- Public Member Functions inherited from Neo2D::Gui::Container
 Container (unsigned int x, unsigned int y, unsigned int width, unsigned int height, const char *label)
 
 ~Container ()
 
 DISOWN (Widget *w) void addWidget(Widget *w)
 
- Public Member Functions inherited from Neo2D::Widget
 Widget (unsigned int x, unsigned int y, unsigned int width, unsigned int height, const char *label)
 
 Widget ()
 
void setParent (Widget *w)
 
WidgetgetParent ()
 
float getFontSize ()
 
void setFontSize (float s)
 
void setOffset (Vector2 offset)
 
Vector2 getOffset ()
 
void setSize (unsigned int w, unsigned int h)
 
Vector2 getSize ()
 
void setCallback (NEO_CALLBACK_FUNCTION func)
 Sets the callback. More...
 
void setScriptCallback (const char *name)
 
void setCallback (NEO_CALLBACK_FUNCTION func, long int data)
 Sets the callback and appends user data to it. More...
 
long int getUserData ()
 Retrieves the user data that will be given to every callback call. More...
 
void setUserData (long int data)
 Changes the user data that will be given to every callback call. More...
 
const char * getLabel ()
 Gets the currently displayed label a C string. More...
 
void setLabel (const char *l)
 Changes the current label of the widget. More...
 
void setPosition (Vector2 pos)
 Changes the widget position. More...
 
Vector2 getPosition ()
 Retrieves the current position. More...
 
void setRotation (float rot)
 Changes the widget rotation. More...
 
float getRotation ()
 Retrieves the current rotation. More...
 
void translate (Vector2 vec)
 Translates the object. More...
 
void rotate (float value)
 Rotates the object. More...
 
void doCallback ()
 Calls the callback with the user data as an argument. More...
 
bool isVisible ()
 Returns if the widget is turned visible. More...
 
void setVisible (bool v)
 Sets the visibility status. More...
 
void setScale (Vector2 scale)
 setScale Scale this Widget More...
 
Vector2 getScale ()
 
void setFlip (Vector2 flip)
 setFlip Flip this Widget More...
 
Vector2 getFlip ()
 
const char * getStaticName ()
 

Protected Attributes

OTextm_labelText
 
float m_mx
 
float m_my
 
WINDOW_STATE m_state
 
WindowManagerm_wm
 
- Protected Attributes inherited from Neo2D::Gui::Container
std::vector< Widget * > m_content
 
- Protected Attributes inherited from Neo2D::Widget
float m_x
 The 2D coordinates of the widget. More...
 
float m_y
 
float m_rotation
 The rotation of the widget. More...
 
unsigned int m_width
 The width and height of the widget. More...
 
unsigned int m_height
 
std::string m_label
 The label of the widget. More...
 
Vector2 m_offset
 The offset that was used for rendering in the last frame. More...
 
NEO_CALLBACK_FUNCTION m_callback
 The callback that should be called. More...
 
String m_callbackScript
 
long int m_userData
 Some userdata that is given to the callback. More...
 
bool m_visible
 Is the widget visible? More...
 
Vector2 m_scale
 The scale vector. More...
 
Vector2 m_flip
 The flip vector. More...
 
float m_fontSize
 
Widgetm_parent
 

Detailed Description

This class implements a Window that can be used to display widgets.

Author
Yannick Pflanzer

Constructor & Destructor Documentation

Neo2D::Gui::Window::Window ( unsigned int  x,
unsigned int  y,
unsigned int  width,
unsigned int  height,
const char *  label 
)
inline
Neo2D::Gui::Window::~Window ( )

Member Function Documentation

bool Neo2D::Gui::Window::containsPoint ( float  x,
float  y 
)
inline
void Neo2D::Gui::Window::draw ( )
virtual

Draws the widget to the canvas it belongs to.

See also
Canvas
draw(Vector2 offset)

Reimplemented from Neo2D::Gui::Container.

void Neo2D::Gui::Window::draw ( Vector2  offset)
inlinevirtual

Draws the widget to the canvas it belongs to.

Parameters
offsetThe offset to apply to the position. Used for emulating a camera.
See also
Canvas

Reimplemented from Neo2D::Gui::Container.

virtual bool Neo2D::Gui::Window::isMouseOver ( )
virtual

Reimplemented from Neo2D::Widget.

void Neo2D::Gui::Window::setWindowManager ( WindowManager wm)
inline
void Neo2D::Gui::Window::update ( )
virtual

Updates the widget and calls the callback if necessary.

Reimplemented from Neo2D::Gui::Container.

Member Data Documentation

OText* Neo2D::Gui::Window::m_labelText
protected
float Neo2D::Gui::Window::m_mx
protected
float Neo2D::Gui::Window::m_my
protected
WINDOW_STATE Neo2D::Gui::Window::m_state
protected
WindowManager* Neo2D::Gui::Window::m_wm
protected

The documentation for this class was generated from the following file: