irr::gui::IGUIElement Class Reference

Base class of all GUI elements. More...

#include <IGUIElement.h>

Inheritance diagram for irr::gui::IGUIElement:

Public Member Functions
	IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment *environment, IGUIElement *parent, s32 id, const core::rect< s32 > &rectangle)
	Constructor. More...
virtual	~IGUIElement ()
	Destructor. More...
IGUIElement *	getParent () const
	Returns parent of this element. More...
core::rect< s32 >	getRelativePosition () const
	Returns the relative rectangle of this element. More...
void	setRelativePosition (const core::rect< s32 > &r)
	Sets the relative rectangle of this element. More...
void	setRelativePosition (const core::position2di &position)
	Sets the relative rectangle of this element, maintaining its current width and height. More...
void	setRelativePositionProportional (const core::rect< f32 > &r)
	Sets the relative rectangle of this element as a proportion of its parent's area. More...
core::rect< s32 >	getAbsolutePosition () const
	Gets the absolute rectangle of this element. More...
core::rect< s32 >	getAbsoluteClippingRect () const
	Returns the visible area of the element. More...
void	setNotClipped (bool noClip)
	Sets whether the element will ignore its parent's clipping rectangle. More...
bool	isNotClipped () const
	Gets whether the element will ignore its parent's clipping rectangle. More...
void	setMaxSize (core::dimension2du size)
	Sets the maximum size allowed for this element. More...
void	setMinSize (core::dimension2du size)
	Sets the minimum size allowed for this element. More...
void	setAlignment (EGUI_ALIGNMENT left, EGUI_ALIGNMENT right, EGUI_ALIGNMENT top, EGUI_ALIGNMENT bottom)
	The alignment defines how the borders of this element will be positioned when the parent element is resized. More...
virtual void	updateAbsolutePosition ()
	Updates the absolute position. More...
virtual IGUIElement *	getElementFromPoint (const core::position2d< s32 > &point)
	Returns the topmost GUI element at the specific position. More...
virtual bool	isPointInside (const core::position2d< s32 > &point) const
	Returns true if a point is within this element. More...
virtual void	addChild (IGUIElement *child)
	Adds a GUI element as new child of this element. More...
virtual void	removeChild (IGUIElement *child)
	Removes a child. More...
virtual void	remove ()
	Removes this element from its parent. More...
virtual void	draw ()
	Draws the element and its children. More...
virtual void	OnPostRender (u32 timeMs)
	animate the element and its children. More...
virtual void	move (core::position2d< s32 > absoluteMovement)
	Moves this element. More...
virtual bool	isVisible () const
	Returns true if element is visible. More...
virtual bool	isTrulyVisible () const
	Check whether the element is truly visible, taking into accounts its parents' visibility. More...
virtual void	setVisible (bool visible)
	Sets the visible state of this element. More...
virtual bool	isSubElement () const
	Returns true if this element was created as part of its parent control. More...
virtual void	setSubElement (bool subElement)
	Sets whether this control was created as part of its parent. More...
void	setTabStop (bool enable)
	If set to true, the focus will visit this element when using the tab key to cycle through elements. More...
bool	isTabStop () const
	Returns true if this element can be focused by navigating with the tab key. More...
void	setTabOrder (s32 index)
	Sets the priority of focus when using the tab key to navigate between a group of elements. More...
s32	getTabOrder () const
	Returns the number in the tab order sequence. More...
void	setTabGroup (bool isGroup)
	Sets whether this element is a container for a group of elements which can be navigated using the tab key. More...
bool	isTabGroup () const
	Returns true if this element is a tab group. More...
IGUIElement *	getTabGroup ()
	Returns the container element which holds all elements in this element's tab group. More...
virtual bool	isEnabled () const
	Returns true if element is enabled. More...
virtual void	setEnabled (bool enabled)
	Sets the enabled state of this element. More...
virtual void	setText (const wchar_t *text)
	Sets the new caption of this element. More...
virtual const wchar_t *	getText () const
	Returns caption of this element. More...
virtual void	setToolTipText (const wchar_t *text)
	Sets the new caption of this element. More...
virtual const core::stringw &	getToolTipText () const
	Returns caption of this element. More...
virtual s32	getID () const
	Returns id. Can be used to identify the element. More...
virtual void	setID (s32 id)
	Sets the id of this element. More...
virtual bool	OnEvent (const SEvent &event) _IRR_OVERRIDE_
	Called if an event happened. More...
virtual bool	bringToFront (IGUIElement *element)
	Brings a child to front. More...
virtual bool	sendToBack (IGUIElement *child)
	Moves a child to the back, so it's siblings are drawn on top of it. More...
virtual const core::list< IGUIElement * > &	getChildren () const
	Returns list with children of this element. More...
virtual IGUIElement *	getElementFromId (s32 id, bool searchchildren=false) const
	Finds the first element with the given id. More...
bool	isMyChild (IGUIElement *child) const
bool	getNextElement (s32 startOrder, bool reverse, bool group, IGUIElement *&first, IGUIElement *&closest, bool includeInvisible=false, bool includeDisabled=false) const
	searches elements to find the closest next element to tab to More...
EGUI_ELEMENT_TYPE	getType () const
	Returns the type of the gui element. More...
virtual bool	hasType (EGUI_ELEMENT_TYPE type) const
	Returns true if the gui element supports the given type. More...
virtual const c8 *	getTypeName () const
	Returns the type name of the gui element. More...
virtual const c8 *	getName () const
	Returns the name of the element. More...
virtual void	setName (const c8 *name)
	Sets the name of the element. More...
virtual void	setName (const core::stringc &name)
	Sets the name of the element. More...
virtual void	serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const _IRR_OVERRIDE_
	Writes attributes of the scene node. More...
virtual void	deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0) _IRR_OVERRIDE_
	Reads attributes of the scene node. More...
Public Member Functions inherited from irr::IReferenceCounted
	IReferenceCounted ()
	Constructor. More...
virtual	~IReferenceCounted ()
	Destructor. More...
void	grab () const
	Grabs the object. Increments the reference counter by one. More...
bool	drop () const
	Drops the object. Decrements the reference counter by one. More...
s32	getReferenceCount () const
	Get the reference count. More...
const c8 *	getDebugName () const
	Returns the debug name of the object. More...
Public Member Functions inherited from irr::IEventReceiver
virtual	~IEventReceiver ()
	Destructor. More...

Protected Member Functions
void	addChildToEnd (IGUIElement *child)
void	recalculateAbsolutePosition (bool recursive)
Protected Member Functions inherited from irr::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object. More...

Protected Attributes
core::list< IGUIElement * >	Children
	List of all children of this element. More...
IGUIElement *	Parent
	Pointer to the parent. More...
core::rect< s32 >	RelativeRect
	relative rect of element More...
core::rect< s32 >	AbsoluteRect
	absolute rect of element More...
core::rect< s32 >	AbsoluteClippingRect
	absolute clipping rect of element More...
core::rect< s32 >	DesiredRect
core::rect< s32 >	LastParentRect
	for calculating the difference when resizing parent More...
core::rect< f32 >	ScaleRect
	relative scale of the element inside its parent More...
core::dimension2du	MaxSize
	maximum and minimum size of the element More...
core::dimension2du	MinSize
bool	IsVisible
	is visible? More...
bool	IsEnabled
	is enabled? More...
bool	IsSubElement
	is a part of a larger whole and should not be serialized? More...
bool	NoClip
	does this element ignore its parent's clipping rectangle? More...
core::stringw	Text
	caption More...
core::stringw	ToolTipText
	tooltip More...
core::stringc	Name
	users can set this for identifying the element by string More...
s32	ID
	users can set this for identifying the element by integer More...
bool	IsTabStop
	tab stop like in windows More...
s32	TabOrder
	tab order More...
bool	IsTabGroup
	tab groups are containers like windows, use ctrl+tab to navigate More...
EGUI_ALIGNMENT	AlignLeft
	tells the element how to act when its parent is resized More...
EGUI_ALIGNMENT	AlignRight
EGUI_ALIGNMENT	AlignTop
EGUI_ALIGNMENT	AlignBottom
IGUIEnvironment *	Environment
	GUI Environment. More...
EGUI_ELEMENT_TYPE	Type
	type of element More...

Detailed Description

Base class of all GUI elements.

Definition at line 23 of file IGUIElement.h.

Constructor & Destructor Documentation

IGUIElement()

irr::gui::IGUIElement::IGUIElement ( EGUI_ELEMENT_TYPE  type, IGUIEnvironment *  environment, IGUIElement *  parent, s32  id, const core::rect< s32 > &  rectangle  )

inline

Constructor.

Definition at line 28 of file IGUIElement.h.

                : Parent(0), RelativeRect(rectangle), AbsoluteRect(rectangle),
                AbsoluteClippingRect(rectangle), DesiredRect(rectangle),
                MaxSize(0,0), MinSize(1,1), IsVisible(true), IsEnabled(true),
                IsSubElement(false), NoClip(false), ID(id), IsTabStop(false), TabOrder(-1), IsTabGroup(false),
                AlignLeft(EGUIA_UPPERLEFT), AlignRight(EGUIA_UPPERLEFT), AlignTop(EGUIA_UPPERLEFT), AlignBottom(EGUIA_UPPERLEFT),
                Environment(environment), Type(type)
        {
                #ifdef _DEBUG
                setDebugName("IGUIElement");
                #endif

                // if we were given a parent to attach to
                if (parent)
                {
                        parent->addChildToEnd(this);
                        recalculateAbsolutePosition(true);
                }
        }

~IGUIElement()

virtual irr::gui::IGUIElement::~IGUIElement ( )

inlinevirtual

Destructor.

Definition at line 51 of file IGUIElement.h.

        {
                // delete all children
                core::list<IGUIElement*>::Iterator it = Children.begin();
                for (; it != Children.end(); ++it)
                {
                        (*it)->Parent = 0;
                        (*it)->drop();
                }
        }

Member Function Documentation

addChild()

virtual void irr::gui::IGUIElement::addChild ( IGUIElement *  child )

inlinevirtual

Adds a GUI element as new child of this element.

Definition at line 276 of file IGUIElement.h.

        {
                if ( child && child != this )
                {
                        addChildToEnd(child);
                        child->updateAbsolutePosition();
                }
        }

addChildToEnd()

void irr::gui::IGUIElement::addChildToEnd ( IGUIElement *  child )

inlineprotected

Definition at line 827 of file IGUIElement.h.

        {
                if (child)
                {
                        child->grab(); // prevent destruction when removed
                        child->remove(); // remove from old parent
                        child->LastParentRect = getAbsolutePosition();
                        child->Parent = this;
                        Children.push_back(child);
                }
        }

bringToFront()

virtual bool irr::gui::IGUIElement::bringToFront ( IGUIElement *  element )

inlinevirtual

Brings a child to front.

Returns

True if successful, false if not.

Definition at line 535 of file IGUIElement.h.

        {
                core::list<IGUIElement*>::Iterator it = Children.begin();
                for (; it != Children.end(); ++it)
                {
                        if (element == (*it))
                        {
                                Children.erase(it);
                                Children.push_back(element);
                                return true;
                        }
                }

                return false;
        }

deserializeAttributes()

virtual void irr::gui::IGUIElement::deserializeAttributes ( io::IAttributes *  in, io::SAttributeReadWriteOptions *  options = 0  )

inlinevirtual

Reads attributes of the scene node.

Implement this to set the attributes of your scene node for scripting languages, editors, debuggers or xml deserialization purposes.

Reimplemented from irr::io::IAttributeExchangingObject.

Definition at line 797 of file IGUIElement.h.

        {
                setName(in->getAttributeAsString("Name", Name));
                setID(in->getAttributeAsInt("Id", ID));
                setText(in->getAttributeAsStringW("Caption", Text).c_str());
                setToolTipText(in->getAttributeAsStringW("ToolTip").c_str());
                setVisible(in->getAttributeAsBool("Visible", IsVisible));
                setEnabled(in->getAttributeAsBool("Enabled", IsEnabled));
                IsTabStop = in->getAttributeAsBool("TabStop", IsTabStop);
                IsTabGroup = in->getAttributeAsBool("TabGroup", IsTabGroup);
                TabOrder = in->getAttributeAsInt("TabOrder", TabOrder);

                core::position2di p = in->getAttributeAsPosition2d("MaxSize", core::position2di(MaxSize.Width, MaxSize.Height));
                setMaxSize(core::dimension2du(p.X,p.Y));

                p = in->getAttributeAsPosition2d("MinSize", core::position2di(MinSize.Width, MinSize.Height));
                setMinSize(core::dimension2du(p.X,p.Y));

                setAlignment((EGUI_ALIGNMENT) in->getAttributeAsEnumeration("LeftAlign", GUIAlignmentNames, AlignLeft),
                        (EGUI_ALIGNMENT)in->getAttributeAsEnumeration("RightAlign", GUIAlignmentNames, AlignRight),
                        (EGUI_ALIGNMENT)in->getAttributeAsEnumeration("TopAlign", GUIAlignmentNames, AlignTop),
                        (EGUI_ALIGNMENT)in->getAttributeAsEnumeration("BottomAlign", GUIAlignmentNames, AlignBottom));

                setRelativePosition(in->getAttributeAsRect("Rect", DesiredRect));

                setNotClipped(in->getAttributeAsBool("NoClip", NoClip));
        }

draw()

virtual void irr::gui::IGUIElement::draw ( )

inlinevirtual

Draws the element and its children.

Definition at line 309 of file IGUIElement.h.

        {
                if ( isVisible() )
                {
                        core::list<IGUIElement*>::Iterator it = Children.begin();
                        for (; it != Children.end(); ++it)
                                (*it)->draw();
                }
        }

getAbsoluteClippingRect()

core::rect<s32> irr::gui::IGUIElement::getAbsoluteClippingRect ( ) const

inline

Returns the visible area of the element.

Definition at line 143 of file IGUIElement.h.

        {
                return AbsoluteClippingRect;
        }

getAbsolutePosition()

core::rect<s32> irr::gui::IGUIElement::getAbsolutePosition ( ) const

inline

Gets the absolute rectangle of this element.

Definition at line 136 of file IGUIElement.h.

        {
                return AbsoluteRect;
        }

getChildren()

virtual const core::list<IGUIElement*>& irr::gui::IGUIElement::getChildren ( ) const

inlinevirtual

Returns list with children of this element.

Definition at line 573 of file IGUIElement.h.

        {
                return Children;
        }

getElementFromId()

virtual IGUIElement* irr::gui::IGUIElement::getElementFromId ( s32  id, bool  searchchildren = false  ) const

inlinevirtual

Finds the first element with the given id.

Parameters

id	Id to search for.
searchchildren	Set this to true, if also children of this element may contain the element with the searched id and they should be searched too.

Returns

Returns the first element with the given id. If no element with this id was found, 0 is returned.

Definition at line 586 of file IGUIElement.h.

        {
                IGUIElement* e = 0;

                core::list<IGUIElement*>::ConstIterator it = Children.begin();
                for (; it != Children.end(); ++it)
                {
                        if ((*it)->getID() == id)
                                return (*it);

                        if (searchchildren)
                                e = (*it)->getElementFromId(id, true);

                        if (e)
                                return e;
                }

                return e;
        }

getElementFromPoint()

virtual IGUIElement* irr::gui::IGUIElement::getElementFromPoint ( const core::position2d< s32 > &  point )

inlinevirtual

Returns the topmost GUI element at the specific position.

This will check this GUI element and all of its descendants, so it may return this GUI element. To check all GUI elements, call this function on device->getGUIEnvironment()->getRootGUIElement(). Note that the root element is the size of the screen, so doing so (with an on-screen point) will always return the root element if no other element is above it at that point.

Parameters

point

The point at which to find a GUI element.

Returns

The topmost GUI element at that point, or 0 if there are no candidate elements at this point.

Definition at line 239 of file IGUIElement.h.

        {
                IGUIElement* target = 0;

                // we have to search from back to front, because later children
                // might be drawn over the top of earlier ones.

                core::list<IGUIElement*>::ConstIterator it = Children.getLast();

                if (isVisible())
                {
                        while(it != Children.end())
                        {
                                target = (*it)->getElementFromPoint(point);
                                if (target)
                                        return target;

                                --it;
                        }
                }

                if (isVisible() && isPointInside(point))
                        target = this;

                return target;
        }

getID()

virtual s32 irr::gui::IGUIElement::getID ( ) const

inlinevirtual

Returns id. Can be used to identify the element.

Definition at line 513 of file IGUIElement.h.

        {
                return ID;
        }

getName()

virtual const c8* irr::gui::IGUIElement::getName ( ) const

inlinevirtual

Returns the name of the element.

Returns

Name as character string.

Definition at line 747 of file IGUIElement.h.

        {
                return Name.c_str();
        }

getNextElement()

bool irr::gui::IGUIElement::getNextElement ( s32  startOrder, bool  reverse, bool  group, IGUIElement *&  first, IGUIElement *&  closest, bool  includeInvisible = false, bool  includeDisabled = false  ) const

inline

searches elements to find the closest next element to tab to

Parameters

startOrder	The TabOrder of the current element, -1 if none
reverse	true if searching for a lower number
group	true if searching for a higher one
first	element with the highest/lowest known tab order depending on search direction
closest	the closest match, depending on tab order and direction
includeInvisible	includes invisible elements in the search (default=false)
includeDisabled	includes disabled elements in the search (default=false)

Returns

true if successfully found an element, false to continue searching/fail

Definition at line 634 of file IGUIElement.h.

        {
                // we'll stop searching if we find this number
                s32 wanted = startOrder + ( reverse ? -1 : 1 );
                if (wanted==-2)
                        wanted = 1073741824; // maximum s32

                core::list<IGUIElement*>::ConstIterator it = Children.begin();

                s32 closestOrder, currentOrder;

                while(it != Children.end())
                {
                        // ignore invisible elements and their children
                        if ( ( (*it)->isVisible() || includeInvisible ) &&
                                (group == true || (*it)->isTabGroup() == false) )
                        {
                                // ignore disabled, but children are checked (disabled is currently per element ignoring parent states)
                                if ( (*it)->isEnabled() || includeDisabled )
                                {
                                        // only check tab stops and those with the same group status
                                        if ((*it)->isTabStop() && ((*it)->isTabGroup() == group))
                                        {
                                                currentOrder = (*it)->getTabOrder();

                                                // is this what we're looking for?
                                                if (currentOrder == wanted)
                                                {
                                                        closest = *it;
                                                        return true;
                                                }

                                                // is it closer than the current closest?
                                                if (closest)
                                                {
                                                        closestOrder = closest->getTabOrder();
                                                        if ( ( reverse && currentOrder > closestOrder && currentOrder < startOrder)
                                                                ||(!reverse && currentOrder < closestOrder && currentOrder > startOrder))
                                                        {
                                                                closest = *it;
                                                        }
                                                }
                                                else
                                                if ( (reverse && currentOrder < startOrder) || (!reverse && currentOrder > startOrder) )
                                                {
                                                        closest = *it;
                                                }

                                                // is it before the current first?
                                                if (first)
                                                {
                                                        closestOrder = first->getTabOrder();

                                                        if ( (reverse && closestOrder < currentOrder) || (!reverse && closestOrder > currentOrder) )
                                                        {
                                                                first = *it;
                                                        }
                                                }
                                                else
                                                {
                                                        first = *it;
                                                }
                                        }
                                }
                                // search within children
                                if ((*it)->getNextElement(startOrder, reverse, group, first, closest))
                                {
                                        return true;
                                }
                        }
                        ++it;
                }
                return false;
        }

getParent()

IGUIElement* irr::gui::IGUIElement::getParent ( ) const

inline

Returns parent of this element.

Definition at line 64 of file IGUIElement.h.

        {
                return Parent;
        }

getRelativePosition()

core::rect<s32> irr::gui::IGUIElement::getRelativePosition ( ) const

inline

Returns the relative rectangle of this element.

Definition at line 70 of file IGUIElement.h.

        {
                return RelativeRect;
        }

getTabGroup()

IGUIElement* irr::gui::IGUIElement::getTabGroup ( )

inline

Returns the container element which holds all elements in this element's tab group.

Definition at line 452 of file IGUIElement.h.

        {
                IGUIElement *ret=this;

                while (ret && !ret->isTabGroup())
                        ret = ret->getParent();

                return ret;
        }

getTabOrder()

s32 irr::gui::IGUIElement::getTabOrder ( ) const

inline

Returns the number in the tab order sequence.

Definition at line 429 of file IGUIElement.h.

        {
                return TabOrder;
        }

getText()

virtual const wchar_t* irr::gui::IGUIElement::getText ( ) const

inlinevirtual

Returns caption of this element.

Definition at line 492 of file IGUIElement.h.

        {
                return Text.c_str();
        }

getToolTipText()

virtual const core::stringw& irr::gui::IGUIElement::getToolTipText ( ) const

inlinevirtual

Returns caption of this element.

Definition at line 506 of file IGUIElement.h.

        {
                return ToolTipText;
        }

getType()

EGUI_ELEMENT_TYPE irr::gui::IGUIElement::getType ( ) const

inline

Returns the type of the gui element.

This is needed for the .NET wrapper but will be used later for serializing and deserializing. If you wrote your own GUIElements, you need to set the type for your element as first parameter in the constructor of IGUIElement. For own (=unknown) elements, simply use EGUIET_ELEMENT as type

Definition at line 717 of file IGUIElement.h.

        {
                return Type;
        }

getTypeName()

virtual const c8* irr::gui::IGUIElement::getTypeName ( ) const

inlinevirtual

Returns the type name of the gui element.

This is needed serializing elements. For serializing your own elements, override this function and return your own type name which is created by your IGUIElementFactory

Definition at line 740 of file IGUIElement.h.

        {
                return GUIElementTypeNames[Type];
        }

hasType()

virtual bool irr::gui::IGUIElement::hasType ( EGUI_ELEMENT_TYPE  type ) const

inlinevirtual

Returns true if the gui element supports the given type.

This is mostly used to check if you can cast a gui element to the class that goes with the type. Most gui elements will only support their own type, but if you derive your own classes from interfaces you can overload this function and add a check for the type of the base-class additionally. This allows for checks comparable to the dynamic_cast of c++ with enabled rtti. Note that you can't do that by calling BaseClass::hasType(type), but you have to do an explicit comparison check, because otherwise the base class usually just checks for the member variable Type which contains the type of your derived class.

Definition at line 731 of file IGUIElement.h.

        {
                return type == Type;
        }

isEnabled()

virtual bool irr::gui::IGUIElement::isEnabled ( ) const

inlinevirtual

Returns true if element is enabled.

Currently elements do not care about parent-states. So if you want to affect children you have to enable/disable them all. The only exception to this are sub-elements which also check their parent.

Definition at line 468 of file IGUIElement.h.

        {
                if ( isSubElement() && IsEnabled && getParent() )
                        return getParent()->isEnabled();

                return IsEnabled;
        }

isMyChild()

bool irr::gui::IGUIElement::isMyChild ( IGUIElement *  child ) const

inline

returns true if the given element is a child of this one.

Parameters

child

The child element to check

Definition at line 609 of file IGUIElement.h.

        {
                if (!child)
                        return false;
                do
                {
                        if (child->Parent)
                                child = child->Parent;

                } while (child->Parent && child != this);


                return child == this;
        }

isNotClipped()

bool irr::gui::IGUIElement::isNotClipped ( ) const

inline

Gets whether the element will ignore its parent's clipping rectangle.

Returns

true if the element is not clipped by its parent's clipping rectangle.

Definition at line 160 of file IGUIElement.h.

        {
                return NoClip;
        }

isPointInside()

virtual bool irr::gui::IGUIElement::isPointInside ( const core::position2d< s32 > &  point ) const

inlinevirtual

Returns true if a point is within this element.

Elements with a shape other than a rectangle should override this method

Definition at line 269 of file IGUIElement.h.

        {
                return AbsoluteClippingRect.isPointInside(point);
        }

isSubElement()

virtual bool irr::gui::IGUIElement::isSubElement ( ) const

inlinevirtual

Returns true if this element was created as part of its parent control.

Definition at line 367 of file IGUIElement.h.

        {
                return IsSubElement;
        }

isTabGroup()

bool irr::gui::IGUIElement::isTabGroup ( ) const

inline

Returns true if this element is a tab group.

Definition at line 445 of file IGUIElement.h.

        {
                return IsTabGroup;
        }

isTabStop()

bool irr::gui::IGUIElement::isTabStop ( ) const

inline

Returns true if this element can be focused by navigating with the tab key.

Definition at line 392 of file IGUIElement.h.

        {
                return IsTabStop;
        }

isTrulyVisible()

virtual bool irr::gui::IGUIElement::isTrulyVisible ( ) const

inlinevirtual

Check whether the element is truly visible, taking into accounts its parents' visibility.

Returns

true if the element and all its parents are visible, false if this or any parent element is invisible.

Definition at line 348 of file IGUIElement.h.

        {
                if(!IsVisible)
                        return false;

                if(!Parent)
                        return true;

                return Parent->isTrulyVisible();
        }

isVisible()

virtual bool irr::gui::IGUIElement::isVisible ( ) const

inlinevirtual

Returns true if element is visible.

Definition at line 340 of file IGUIElement.h.

        {
                return IsVisible;
        }

move()

virtual void irr::gui::IGUIElement::move ( core::position2d< s32 >  absoluteMovement )

inlinevirtual

Moves this element.

Definition at line 333 of file IGUIElement.h.

        {
                setRelativePosition(DesiredRect + absoluteMovement);
        }

OnEvent()

virtual bool irr::gui::IGUIElement::OnEvent ( const SEvent &  event )

inlinevirtual

Called if an event happened.

Implements irr::IEventReceiver.

Definition at line 527 of file IGUIElement.h.

        {
                return Parent ? Parent->OnEvent(event) : false;
        }

OnPostRender()

virtual void irr::gui::IGUIElement::OnPostRender ( u32  timeMs )

inlinevirtual

animate the element and its children.

Definition at line 321 of file IGUIElement.h.

        {
                if ( isVisible() )
                {
                        core::list<IGUIElement*>::Iterator it = Children.begin();
                        for (; it != Children.end(); ++it)
                                (*it)->OnPostRender( timeMs );
                }
        }

recalculateAbsolutePosition()

void irr::gui::IGUIElement::recalculateAbsolutePosition ( bool  recursive )

inlineprotected

Definition at line 840 of file IGUIElement.h.

        {
                core::rect<s32> parentAbsolute(0,0,0,0);
                core::rect<s32> parentAbsoluteClip;
                f32 fw=0.f, fh=0.f;

                if (Parent)
                {
                        parentAbsolute = Parent->AbsoluteRect;

                        if (NoClip)
                        {
                                IGUIElement* p=this;
                                while (p->Parent)
                                        p = p->Parent;
                                parentAbsoluteClip = p->AbsoluteClippingRect;
                        }
                        else
                                parentAbsoluteClip = Parent->AbsoluteClippingRect;
                }

                const s32 diffx = parentAbsolute.getWidth() - LastParentRect.getWidth();
                const s32 diffy = parentAbsolute.getHeight() - LastParentRect.getHeight();

                if (AlignLeft == EGUIA_SCALE || AlignRight == EGUIA_SCALE)
                        fw = (f32)parentAbsolute.getWidth();

                if (AlignTop == EGUIA_SCALE || AlignBottom == EGUIA_SCALE)
                        fh = (f32)parentAbsolute.getHeight();

                switch (AlignLeft)
                {
                        case EGUIA_UPPERLEFT:
                                break;
                        case EGUIA_LOWERRIGHT:
                                DesiredRect.UpperLeftCorner.X += diffx;
                                break;
                        case EGUIA_CENTER:
                                DesiredRect.UpperLeftCorner.X += diffx/2;
                                break;
                        case EGUIA_SCALE:
                                DesiredRect.UpperLeftCorner.X = core::round32(ScaleRect.UpperLeftCorner.X * fw);
                                break;
                }

                switch (AlignRight)
                {
                        case EGUIA_UPPERLEFT:
                                break;
                        case EGUIA_LOWERRIGHT:
                                DesiredRect.LowerRightCorner.X += diffx;
                                break;
                        case EGUIA_CENTER:
                                DesiredRect.LowerRightCorner.X += diffx/2;
                                break;
                        case EGUIA_SCALE:
                                DesiredRect.LowerRightCorner.X = core::round32(ScaleRect.LowerRightCorner.X * fw);
                                break;
                }

                switch (AlignTop)
                {
                        case EGUIA_UPPERLEFT:
                                break;
                        case EGUIA_LOWERRIGHT:
                                DesiredRect.UpperLeftCorner.Y += diffy;
                                break;
                        case EGUIA_CENTER:
                                DesiredRect.UpperLeftCorner.Y += diffy/2;
                                break;
                        case EGUIA_SCALE:
                                DesiredRect.UpperLeftCorner.Y = core::round32(ScaleRect.UpperLeftCorner.Y * fh);
                                break;
                }

                switch (AlignBottom)
                {
                        case EGUIA_UPPERLEFT:
                                break;
                        case EGUIA_LOWERRIGHT:
                                DesiredRect.LowerRightCorner.Y += diffy;
                                break;
                        case EGUIA_CENTER:
                                DesiredRect.LowerRightCorner.Y += diffy/2;
                                break;
                        case EGUIA_SCALE:
                                DesiredRect.LowerRightCorner.Y = core::round32(ScaleRect.LowerRightCorner.Y * fh);
                                break;
                }

                RelativeRect = DesiredRect;

                const s32 w = RelativeRect.getWidth();
                const s32 h = RelativeRect.getHeight();

                // make sure the desired rectangle is allowed
                if (w < (s32)MinSize.Width)
                        RelativeRect.LowerRightCorner.X = RelativeRect.UpperLeftCorner.X + MinSize.Width;
                if (h < (s32)MinSize.Height)
                        RelativeRect.LowerRightCorner.Y = RelativeRect.UpperLeftCorner.Y + MinSize.Height;
                if (MaxSize.Width && w > (s32)MaxSize.Width)
                        RelativeRect.LowerRightCorner.X = RelativeRect.UpperLeftCorner.X + MaxSize.Width;
                if (MaxSize.Height && h > (s32)MaxSize.Height)
                        RelativeRect.LowerRightCorner.Y = RelativeRect.UpperLeftCorner.Y + MaxSize.Height;

                RelativeRect.repair();

                AbsoluteRect = RelativeRect + parentAbsolute.UpperLeftCorner;

                if (!Parent)
                        parentAbsoluteClip = AbsoluteRect;

                AbsoluteClippingRect = AbsoluteRect;
                AbsoluteClippingRect.clipAgainst(parentAbsoluteClip);

                LastParentRect = parentAbsolute;

                if ( recursive )
                {
                        // update all children
                        core::list<IGUIElement*>::Iterator it = Children.begin();
                        for (; it != Children.end(); ++it)
                        {
                                (*it)->recalculateAbsolutePosition(recursive);
                        }
                }
        }

remove()

virtual void irr::gui::IGUIElement::remove ( )

inlinevirtual

Removes this element from its parent.

Definition at line 301 of file IGUIElement.h.

        {
                if (Parent)
                        Parent->removeChild(this);
        }

removeChild()

virtual void irr::gui::IGUIElement::removeChild ( IGUIElement *  child )

inlinevirtual

Removes a child.

Definition at line 286 of file IGUIElement.h.

        {
                core::list<IGUIElement*>::Iterator it = Children.begin();
                for (; it != Children.end(); ++it)
                        if ((*it) == child)
                        {
                                (*it)->Parent = 0;
                                (*it)->drop();
                                Children.erase(it);
                                return;
                        }
        }

sendToBack()

virtual bool irr::gui::IGUIElement::sendToBack ( IGUIElement *  child )

inlinevirtual

Moves a child to the back, so it's siblings are drawn on top of it.

Returns

True if successful, false if not.

Definition at line 554 of file IGUIElement.h.

        {
                core::list<IGUIElement*>::Iterator it = Children.begin();
                if (child == (*it)) // already there
                        return true;
                for (; it != Children.end(); ++it)
                {
                        if (child == (*it))
                        {
                                Children.erase(it);
                                Children.push_front(child);
                                return true;
                        }
                }

                return false;
        }

serializeAttributes()

virtual void irr::gui::IGUIElement::serializeAttributes ( io::IAttributes *  out, io::SAttributeReadWriteOptions *  options = 0  ) const

inlinevirtual

Writes attributes of the scene node.

Implement this to expose the attributes of your scene node for scripting languages, editors, debuggers or xml serialization purposes.

Reimplemented from irr::io::IAttributeExchangingObject.

Definition at line 772 of file IGUIElement.h.

        {
                out->addString("Name", Name.c_str());
                out->addInt("Id", ID );
                out->addString("Caption", getText());
                out->addString("ToolTip", getToolTipText().c_str());
                out->addRect("Rect", DesiredRect);
                out->addPosition2d("MinSize", core::position2di(MinSize.Width, MinSize.Height));
                out->addPosition2d("MaxSize", core::position2di(MaxSize.Width, MaxSize.Height));
                out->addEnum("LeftAlign", AlignLeft, GUIAlignmentNames);
                out->addEnum("RightAlign", AlignRight, GUIAlignmentNames);
                out->addEnum("TopAlign", AlignTop, GUIAlignmentNames);
                out->addEnum("BottomAlign", AlignBottom, GUIAlignmentNames);
                out->addBool("Visible", IsVisible);
                out->addBool("Enabled", IsEnabled);
                out->addBool("TabStop", IsTabStop);
                out->addBool("TabGroup", IsTabGroup);
                out->addInt("TabOrder", TabOrder);
                out->addBool("NoClip", NoClip);
        }

setAlignment()

void irr::gui::IGUIElement::setAlignment ( EGUI_ALIGNMENT  left, EGUI_ALIGNMENT  right, EGUI_ALIGNMENT  top, EGUI_ALIGNMENT  bottom  )

inline

The alignment defines how the borders of this element will be positioned when the parent element is resized.

Definition at line 188 of file IGUIElement.h.

        {
                AlignLeft = left;
                AlignRight = right;
                AlignTop = top;
                AlignBottom = bottom;

                if (Parent)
                {
                        core::rect<s32> r(Parent->getAbsolutePosition());

                        core::dimension2df d((f32)r.getSize().Width, (f32)r.getSize().Height);

                        if (AlignLeft   == EGUIA_SCALE)
                                ScaleRect.UpperLeftCorner.X = (f32)DesiredRect.UpperLeftCorner.X / d.Width;
                        if (AlignRight  == EGUIA_SCALE)
                                ScaleRect.LowerRightCorner.X = (f32)DesiredRect.LowerRightCorner.X / d.Width;
                        if (AlignTop    == EGUIA_SCALE)
                                ScaleRect.UpperLeftCorner.Y = (f32)DesiredRect.UpperLeftCorner.Y / d.Height;
                        if (AlignBottom == EGUIA_SCALE)
                                ScaleRect.LowerRightCorner.Y = (f32)DesiredRect.LowerRightCorner.Y / d.Height;
                }
        }

setEnabled()

virtual void irr::gui::IGUIElement::setEnabled ( bool  enabled )

inlinevirtual

Sets the enabled state of this element.

Definition at line 478 of file IGUIElement.h.

        {
                IsEnabled = enabled;
        }

setID()

virtual void irr::gui::IGUIElement::setID ( s32  id )

inlinevirtual

Sets the id of this element.

Definition at line 520 of file IGUIElement.h.

        {
                ID = id;
        }

setMaxSize()

void irr::gui::IGUIElement::setMaxSize ( core::dimension2du  size )

inline

Sets the maximum size allowed for this element.

If set to 0,0, there is no maximum size

Definition at line 168 of file IGUIElement.h.

        {
                MaxSize = size;
                updateAbsolutePosition();
        }

setMinSize()

void irr::gui::IGUIElement::setMinSize ( core::dimension2du  size )

inline

Sets the minimum size allowed for this element.

Definition at line 176 of file IGUIElement.h.

        {
                MinSize = size;
                if (MinSize.Width < 1)
                        MinSize.Width = 1;
                if (MinSize.Height < 1)
                        MinSize.Height = 1;
                updateAbsolutePosition();
        }

setName() [1/2]

virtual void irr::gui::IGUIElement::setName ( const c8 *  name )

inlinevirtual

Sets the name of the element.

Parameters

name	New name of the gui element.

Definition at line 755 of file IGUIElement.h.

        {
                Name = name;
        }

setName() [2/2]

virtual void irr::gui::IGUIElement::setName ( const core::stringc &  name )

inlinevirtual

Sets the name of the element.

Parameters

name	New name of the gui element.

Definition at line 763 of file IGUIElement.h.

        {
                Name = name;
        }

setNotClipped()

void irr::gui::IGUIElement::setNotClipped ( bool  noClip )

inline

Sets whether the element will ignore its parent's clipping rectangle.

Parameters

noClip

If true, the element will not be clipped by its parent's clipping rectangle.

Definition at line 151 of file IGUIElement.h.

        {
                NoClip = noClip;
                updateAbsolutePosition();
        }

setRelativePosition() [1/2]

void irr::gui::IGUIElement::setRelativePosition ( const core::rect< s32 > &  r )

inline

Sets the relative rectangle of this element.

Parameters

r	The absolute position to set

Definition at line 78 of file IGUIElement.h.

        {
                if (Parent)
                {
                        const core::rect<s32>& r2 = Parent->getAbsolutePosition();

                        core::dimension2df d((f32)(r2.getSize().Width), (f32)(r2.getSize().Height));

                        if (AlignLeft   == EGUIA_SCALE)
                                ScaleRect.UpperLeftCorner.X = (f32)r.UpperLeftCorner.X / d.Width;
                        if (AlignRight  == EGUIA_SCALE)
                                ScaleRect.LowerRightCorner.X = (f32)r.LowerRightCorner.X / d.Width;
                        if (AlignTop    == EGUIA_SCALE)
                                ScaleRect.UpperLeftCorner.Y = (f32)r.UpperLeftCorner.Y / d.Height;
                        if (AlignBottom == EGUIA_SCALE)
                                ScaleRect.LowerRightCorner.Y = (f32)r.LowerRightCorner.Y / d.Height;
                }

                DesiredRect = r;
                updateAbsolutePosition();
        }

setRelativePosition() [2/2]

void irr::gui::IGUIElement::setRelativePosition ( const core::position2di &  position )

inline

Sets the relative rectangle of this element, maintaining its current width and height.

Parameters

position

The new relative position to set. Width and height will not be changed.

Definition at line 102 of file IGUIElement.h.

        {
                const core::dimension2di mySize = RelativeRect.getSize();
                const core::rect<s32> rectangle(position.X, position.Y,
                                                position.X + mySize.Width, position.Y + mySize.Height);
                setRelativePosition(rectangle);
        }

setRelativePositionProportional()

void irr::gui::IGUIElement::setRelativePositionProportional ( const core::rect< f32 > &  r )

inline

Sets the relative rectangle of this element as a proportion of its parent's area.

Note

This method used to be 'void setRelativePosition(const core::rect<f32>& r)'

Parameters

r	The rectangle to set, interpreted as a proportion of the parent's area. Meaningful values are in the range [0...1], unless you intend this element to spill outside its parent.

Definition at line 116 of file IGUIElement.h.

        {
                if (!Parent)
                        return;

                const core::dimension2di& d = Parent->getAbsolutePosition().getSize();

                DesiredRect = core::rect<s32>(
                                        core::floor32((f32)d.Width * r.UpperLeftCorner.X),
                                        core::floor32((f32)d.Height * r.UpperLeftCorner.Y),
                                        core::floor32((f32)d.Width * r.LowerRightCorner.X),
                                        core::floor32((f32)d.Height * r.LowerRightCorner.Y));

                ScaleRect = r;

                updateAbsolutePosition();
        }

setSubElement()

virtual void irr::gui::IGUIElement::setSubElement ( bool  subElement )

inlinevirtual

Sets whether this control was created as part of its parent.

For example, it is true when a scrollbar is part of a listbox. SubElements are not saved to disk when calling guiEnvironment->saveGUI()

Definition at line 376 of file IGUIElement.h.

        {
                IsSubElement = subElement;
        }

setTabGroup()

void irr::gui::IGUIElement::setTabGroup ( bool  isGroup )

inline

Sets whether this element is a container for a group of elements which can be navigated using the tab key.

For example, windows are tab groups. Groups can be navigated using ctrl+tab, providing isTabStop is true.

Definition at line 438 of file IGUIElement.h.

        {
                IsTabGroup = isGroup;
        }

setTabOrder()

void irr::gui::IGUIElement::setTabOrder ( s32  index )

inline

Sets the priority of focus when using the tab key to navigate between a group of elements.

See setTabGroup, isTabGroup and getTabGroup for information on tab groups. Elements with a lower number are focused first

Definition at line 401 of file IGUIElement.h.

        {
                // negative = autonumber
                if (index < 0)
                {
                        TabOrder = 0;
                        IGUIElement *el = getTabGroup();
                        while (IsTabGroup && el && el->Parent)
                                el = el->Parent;

                        IGUIElement *first=0, *closest=0;
                        if (el)
                        {
                                // find the highest element number
                                el->getNextElement(-1, true, IsTabGroup, first, closest, true);
                                if (first)
                                {
                                        TabOrder = first->getTabOrder() + 1;
                                }
                        }

                }
                else
                        TabOrder = index;
        }

setTabStop()

void irr::gui::IGUIElement::setTabStop ( bool  enable )

inline

If set to true, the focus will visit this element when using the tab key to cycle through elements.

If this element is a tab group (see isTabGroup/setTabGroup) then ctrl+tab will be used instead.

Definition at line 385 of file IGUIElement.h.

        {
                IsTabStop = enable;
        }

setText()

virtual void irr::gui::IGUIElement::setText ( const wchar_t *  text )

inlinevirtual

Sets the new caption of this element.

Definition at line 485 of file IGUIElement.h.

        {
                Text = text;
        }

setToolTipText()

virtual void irr::gui::IGUIElement::setToolTipText ( const wchar_t *  text )

inlinevirtual

Sets the new caption of this element.

Definition at line 499 of file IGUIElement.h.

        {
                ToolTipText = text;
        }

setVisible()

virtual void irr::gui::IGUIElement::setVisible ( bool  visible )

inlinevirtual

Sets the visible state of this element.

Definition at line 360 of file IGUIElement.h.

        {
                IsVisible = visible;
        }

updateAbsolutePosition()

virtual void irr::gui::IGUIElement::updateAbsolutePosition ( )

inlinevirtual

Updates the absolute position.

Definition at line 214 of file IGUIElement.h.

        {
                recalculateAbsolutePosition(false);

                // update all children
                core::list<IGUIElement*>::Iterator it = Children.begin();
                for (; it != Children.end(); ++it)
                {
                        (*it)->updateAbsolutePosition();
                }
        }

Member Data Documentation

AbsoluteClippingRect

core::rect<s32> irr::gui::IGUIElement::AbsoluteClippingRect

protected

absolute clipping rect of element

Definition at line 983 of file IGUIElement.h.

AbsoluteRect

core::rect<s32> irr::gui::IGUIElement::AbsoluteRect

protected

absolute rect of element

Definition at line 980 of file IGUIElement.h.

AlignBottom

EGUI_ALIGNMENT irr::gui::IGUIElement::AlignBottom

protected

Definition at line 1032 of file IGUIElement.h.

AlignLeft

EGUI_ALIGNMENT irr::gui::IGUIElement::AlignLeft

protected

tells the element how to act when its parent is resized

Definition at line 1032 of file IGUIElement.h.

AlignRight

EGUI_ALIGNMENT irr::gui::IGUIElement::AlignRight

protected

Definition at line 1032 of file IGUIElement.h.

AlignTop

EGUI_ALIGNMENT irr::gui::IGUIElement::AlignTop

protected

Definition at line 1032 of file IGUIElement.h.

Children

core::list<IGUIElement*> irr::gui::IGUIElement::Children

protected

List of all children of this element.

Definition at line 971 of file IGUIElement.h.

DesiredRect

core::rect<s32> irr::gui::IGUIElement::DesiredRect

protected

the rectangle the element would prefer to be, if it was not constrained by parent or max/min size

Definition at line 987 of file IGUIElement.h.

Environment

IGUIEnvironment* irr::gui::IGUIElement::Environment

protected

GUI Environment.

Definition at line 1035 of file IGUIElement.h.

ID

s32 irr::gui::IGUIElement::ID

protected

users can set this for identifying the element by integer

Definition at line 1020 of file IGUIElement.h.

IsEnabled

bool irr::gui::IGUIElement::IsEnabled

protected

is enabled?

Definition at line 1002 of file IGUIElement.h.

IsSubElement

bool irr::gui::IGUIElement::IsSubElement

protected

is a part of a larger whole and should not be serialized?

Definition at line 1005 of file IGUIElement.h.

IsTabGroup

bool irr::gui::IGUIElement::IsTabGroup

protected

tab groups are containers like windows, use ctrl+tab to navigate

Definition at line 1029 of file IGUIElement.h.

IsTabStop

bool irr::gui::IGUIElement::IsTabStop

protected

tab stop like in windows

Definition at line 1023 of file IGUIElement.h.

IsVisible

bool irr::gui::IGUIElement::IsVisible

protected

is visible?

Definition at line 999 of file IGUIElement.h.

LastParentRect

core::rect<s32> irr::gui::IGUIElement::LastParentRect

protected

for calculating the difference when resizing parent

Definition at line 990 of file IGUIElement.h.

MaxSize

core::dimension2du irr::gui::IGUIElement::MaxSize

protected

maximum and minimum size of the element

Definition at line 996 of file IGUIElement.h.

MinSize

core::dimension2du irr::gui::IGUIElement::MinSize

protected

Definition at line 996 of file IGUIElement.h.

Name

core::stringc irr::gui::IGUIElement::Name

protected

users can set this for identifying the element by string

Definition at line 1017 of file IGUIElement.h.

NoClip

bool irr::gui::IGUIElement::NoClip

protected

does this element ignore its parent's clipping rectangle?

Definition at line 1008 of file IGUIElement.h.

Parent

IGUIElement* irr::gui::IGUIElement::Parent

protected

Pointer to the parent.

Definition at line 974 of file IGUIElement.h.

RelativeRect

core::rect<s32> irr::gui::IGUIElement::RelativeRect

protected

relative rect of element

Definition at line 977 of file IGUIElement.h.

ScaleRect

core::rect<f32> irr::gui::IGUIElement::ScaleRect

protected

relative scale of the element inside its parent

Definition at line 993 of file IGUIElement.h.

TabOrder

s32 irr::gui::IGUIElement::TabOrder

protected

tab order

Definition at line 1026 of file IGUIElement.h.

Text

core::stringw irr::gui::IGUIElement::Text

protected

caption

Definition at line 1011 of file IGUIElement.h.

ToolTipText

core::stringw irr::gui::IGUIElement::ToolTipText

protected

tooltip

Definition at line 1014 of file IGUIElement.h.

Type

EGUI_ELEMENT_TYPE irr::gui::IGUIElement::Type

protected

type of element

Definition at line 1038 of file IGUIElement.h.

---

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

• include/irrlicht/IGUIElement.h