Mezzanine::UI::Screen Class Reference

This class is a helper class for creating UI's. It is responsible for storing and keeping track of all the elements of a single UI screen. More...

#include <screen.h>

Inheritance diagram for Mezzanine::UI::Screen:

Collaboration diagram for Mezzanine::UI::Screen:

Public Types
typedef bool(	ChildCallback )(QuadRenderable *Quad)
	Callback type for child processing.
typedef WidgetFactoryContainer::const_iterator	ConstWidgetFactoryIterator
	Const Iterator type for Widget instances stored by this class.
typedef WidgetContainer::const_iterator	ConstWidgetIterator
	Const Iterator type for Widget instances stored by this class.
typedef std::vector < AtlasAndPosition >	TextureVertexContainer
	Basic container type for the storage of render data on this screen.
typedef std::map< String, Widget * >	WidgetContainer
	Basic container type for Widget storage by this class.
typedef std::map< String, WidgetFactory * >	WidgetFactoryContainer
	Basic container type for Widget storage by this class.
typedef WidgetFactoryContainer::iterator	WidgetFactoryIterator
	Iterator type for Widget instances stored by this class.
typedef WidgetContainer::iterator	WidgetIterator
	Iterator type for Widget instances stored by this class.
Public Types inherited from Mezzanine::UI::QuadRenderable
typedef std::list< Widget * >	ChildContainer
	Basic container type for Widget storage by this class.
typedef ChildContainer::iterator	ChildIterator
	Iterator type for Widget instances stored by this class.
typedef ChildContainer::const_iterator	ConstChildIterator
	Const Iterator type for Widget instances stored by this class.
typedef RenderLayerGroupContainer::const_iterator	ConstRenderLayerGroupIterator
	Const Iterator type for RenderLayerGroup instances stored by this class.
typedef RenderLayerContainer::const_iterator	ConstRenderLayerIterator
	Const Iterator type for RenderLayer instances stored by this class.
typedef ChildContainer::const_reverse_iterator	ConstReverseChildIterator
	Const Reverse Iterator type for Widget instances stored by this class.
typedef std::pair< UInt16, String >	GroupOrderEntry
	An std::pair type for storing ZOrders in relation to a named RenderLayerGroup.
typedef std::vector < GroupOrderEntry >	GroupOrderEntryVector
	Container type for GroupOrderEntry storage by this class.
typedef std::vector < RenderLayer * >	RenderLayerContainer
	Basic container type for RenderLayer storage by this class.
typedef std::map< String, RenderLayerGroup * >	RenderLayerGroupContainer
	Basic container type for RenderLayerGroup storage by this class.
typedef RenderLayerGroupContainer::iterator	RenderLayerGroupIterator
	Iterator type for RenderLayerGroup instances stored by this class.
typedef RenderLayerContainer::iterator	RenderLayerIterator
	Iterator type for RenderLayer instances stored by this class.
typedef ChildContainer::reverse_iterator	ReverseChildIterator
	Reverse Iterator type for Widget instances stored by this class.
Public Types inherited from Mezzanine::UI::Renderable
enum	RenderableType { RT_LineList, RT_Screen, RT_Widget }
	A small enum to describe the type of renderable this is.

Public Member Functions
virtual void	_MarkAllLayersDirty ()
	Tells this QuadRenderable that all of it's layers are dirty. More...
void	_MarkDirty ()
	Marks this renderable as dirty, and informs other renderables if needed. More...
template<typename Callback >
Boolean	_ProcessAllChildren (Callback *CB)
	Processes all children of this screen by their zorder. More...
void	_RenderScreen ()
	Manually calls the UI system to render this screen. More...
void	_RenderVertices (bool Force=false)
	Prepares all vertices for rendering to the screen. More...
template<typename Callback >
Boolean	_ReverseProcessAllChildren (Callback *CB)
	Processes all children of this screen in reverse zorder. More...
void	_SetOrientation (const Mezzanine::OrientationMode &Mode)
	Forces an orientation mode change for this screen. More...
void	_Transform (ScreenRenderData &RenderData, const Whole &Begin, const Whole &End)
	Updates the vertex positions so they are in front of the camera in world space. More...
void	AddAllDefaultWidgetFactories ()
	Adds all the default widget factories provided by the engine to the Screen.
void	AddWidgetFactory (WidgetFactory *ToBeAdded)
	Adds/registers a widget factory with this Screen, allowing it to be constructed through this API. More...
virtual void	CheckViewportSize ()
	Checks to see if the viewport has changed in size. If so it updates all the UI elements on the screen.
virtual Button *	CreateButton (const String &Name)
	Creates a Button. More...
virtual Button *	CreateButton (const String &Name, const UnifiedRect &RendRect)
	Creates a Button. More...
virtual CheckBox *	CreateCheckBox (const String &Name)
	Creates a CheckBox. More...
virtual CheckBox *	CreateCheckBox (const String &Name, const UnifiedRect &RendRect)
	Creates a CheckBox. More...
virtual HorizontalContainer *	CreateHorizontalContainer (const String &RendName)
	Creates a widget container aligned on the X axis. More...
virtual HorizontalContainer *	CreateHorizontalContainer (const String &RendName, const UnifiedRect &RendRect)
	Creates a widget container aligned on the X axis. More...
virtual HorizontalScrollbar *	CreateHorizontalScrollbar (const String &Name, const UI::ScrollbarStyle Style)
	Creates a Scrollbar aligned on the X axis. More...
virtual HorizontalScrollbar *	CreateHorizontalScrollbar (const String &Name, const UnifiedRect &RendRect, const UI::ScrollbarStyle Style)
	Creates a Scrollbar aligned on the X axis. More...
virtual MenuButton *	CreateMenuButton (const String &Name)
	Creates a MenuButton. More...
virtual MenuButton *	CreateMenuButton (const String &Name, const UnifiedRect &RendRect)
	Creates a MenuButton. More...
virtual MenuEntry *	CreateMenuEntry (const String &Name)
	Creates a MenuEntry. More...
virtual MenuEntry *	CreateMenuEntry (const String &Name, const UnifiedRect &RendRect)
	Creates a MenuEntry. More...
virtual RadioButton *	CreateRadioButton (const String &Name)
	Creates a RadioButton. More...
virtual RadioButton *	CreateRadioButton (const String &Name, const UnifiedRect &RendRect)
	Creates a RadioButton. More...
virtual VerticalContainer *	CreateVerticalContainer (const String &RendName)
	Creates a widget container aligned on the Y axis. More...
virtual VerticalContainer *	CreateVerticalContainer (const String &RendName, const UnifiedRect &RendRect)
	Creates a widget container aligned on the Y axis. More...
virtual VerticalScrollbar *	CreateVerticalScrollbar (const String &Name, const UI::ScrollbarStyle Style)
	Creates a Scrollbar aligned on the Y axis. More...
virtual VerticalScrollbar *	CreateVerticalScrollbar (const String &Name, const UnifiedRect &RendRect, const UI::ScrollbarStyle Style)
	Creates a Scrollbar aligned on the Y axis. More...
virtual Widget *	CreateWidget (const XML::Node &WidgetNode)
	Creates a widget from an XML::Node. Exceptions This method will throw an exception if the WidgetNode is not named after a known widget. More...
virtual Widget *	CreateWidget (const String &Name)
	Creates a generic widget. More...
virtual Widget *	CreateWidget (const String &Name, const UnifiedRect &RendRect)
	Creates a generic widget. More...
void	DestroyAllWidgetFactories ()
	Destroys all widget factories in this Screen. More...
virtual void	DestroyAllWidgets ()
	Destroys all widgets being stored by this screen.
virtual void	DestroyWidget (Widget *ToBeDestroyed)
	Destroys a widget. More...
void	DestroyWidgetFactory (WidgetFactory *ToBeDestroyed)
	Removes and destroys a widget factory in this Screen. More...
void	DestroyWidgetFactory (const String &ImplName)
	Removes and destroys a widget factory in this Screen. More...
virtual Widget *	FindHoveredWidget (const Vector2 &MousePos)
	Gets the quad the mouse is over if any. More...
TextureAtlas *	GetAtlas (const String &Atlas) const
	Gets an atlas that has been loaded. More...
virtual String	GetDerivedSerializableName () const
	Gets the most derived serializable name of this Renderable. More...
FontData *	GetFont (const String &FontName, const String &Atlas) const
	Gets the specified FontData from an Atlas. More...
virtual UIManager *	GetManager () const
	Gets the UIManager this screen belongs to. More...
UI::MarkupParser *	GetMarkupParser (const String &ParserName) const
	Gets a MarkupParser by it's registered name. More...
virtual const Vector2 &	GetMouseHitPosition () const
	Gets the mouse position from the last call to "FindHoveredQuad(const Vector2&). More...
virtual MouseHoverStrategy *	GetMouseHoverStrategy () const
	Gets the MouseHoverStrategy currently being used by this screen. More...
virtual Whole	GetNumWidgets ()
	Gets the number of widgets being used in this screen. More...
virtual String	GetPrimaryAtlas ()
	Gets the currently set primary atlas. More...
virtual RenderableType	GetRenderableType () const
	Gets the type of renderable this is. More...
Sprite *	GetSprite (const String &SpriteName, const String &Atlas) const
	Gets a sprite from an Atlas. More...
Real	GetTexelOffsetX () const
	Gets the X axis Texel Offset for the current rendersystem. More...
Real	GetTexelOffsetY () const
	Gets the Y axis Texel Offset for the current rendersystem. More...
Vector2	GetTextureSize (const String &Atlas) const
	Gets the texture size of the specified Atlas. More...
virtual Graphics::Viewport *	GetViewport () const
	Gets the Viewport this screen is currently rendering to. More...
virtual const Vector2 &	GetViewportDimensions () const
	Gets the current viewport dimensions. More...
virtual Boolean	GetVisible () const
	Gets the visibility setting of this renderable. More...
Vector2	GetWhitePixel (const String &Atlas) const
	Gets the position of the white pixel from an Atlas. More...
virtual Widget *	GetWidget (const String &Name)
	Gets a widget in this screen by name. More...
virtual void	Hide ()
	Forces this renderable to hide. More...
bool	IsMarkupParserRegistered (const String &ParserName) const
	Checks to see if a MarkupParser has already been registsered under a specific name. More...
virtual Boolean	IsVisible () const
	Gets whether or not this renderable is being drawn. More...
virtual void	ProtoDeSerializeProperties (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the properties of this object with it. More...
virtual void	ProtoSerializeProperties (XML::Node &SelfRoot) const
	Convert the properties of this class to an XML::Node ready for serialization. More...
void	RemoveWidgetFactory (WidgetFactory *ToBeRemoved)
	Removes a widget factory from this Screen. More...
void	RemoveWidgetFactory (const String &ImplName)
	Removes a widget factory from this Screen. More...
virtual void	SetMouseHoverStrategy (MouseHoverStrategy *Strategy)
	Sets the strategy to use when detect which object the mouse is hovered over. More...
virtual void	SetPrimaryAtlas (const String &Atlas)
	Sets the Atlas to be assumed when one isn't provided for atlas related tasks. More...
virtual void	SetVisible (Boolean CanSee)
virtual void	Show ()
	Forces this renderable to be shown. More...
Public Member Functions inherited from Mezzanine::UI::QuadRenderable
virtual void	_AppendRenderData (ScreenRenderData &RenderData)
	Appends the vertices of this renderable to another vector. More...
virtual void	_AppendRenderDataCascading (ScreenRenderData &RenderData)
	Appends the vertices of this renderable to another vector, and then does the same for this renderable's children. More...
virtual Boolean	_HasAvailableRenderData () const
	Checks if there are available render data from this QuadRenderable (or it's subrenderables). More...
virtual void	_MarkAllChildrenDirty ()
	Tells this QuadRenderable to mark each of it's children (and their children) as dirty. More...
virtual void	_NotifyParenthood (QuadRenderable *NewParent)
	Notifies this QuadRenderable that it has been added to another QuadRenderable. More...
virtual void	_SetZOrder (const UInt16 &Zorder)
	Ssts the ZOrder value for this renderable. More...
virtual void	AddChild (Widget *Child)
	Adds a Widget to this as a child of this quad. More...
virtual void	AddChild (Widget *Child, const UInt16 ZOrder)
	Adds a Widget to this as a child of this quad. More...
void	AddLayerToGroup (RenderLayer *Layer, const UInt16 ZOrder, const String &GroupName)
	Adds a RenderLayer to the specified group. More...
void	AddLayerToGroups (RenderLayer *Layer, const GroupOrderEntryVector &Entrys)
	Adds a RenderLayer to multiple groups. More...
virtual Boolean	CheckOverlap (const QuadRenderable *Quad) const
	Checks to see if another Quad is overlapping with this one. More...
ChildIterator	ChildrenBegin ()
	Gets an iterator to the first child Widget. More...
ConstChildIterator	ChildrenBegin () const
	Gets a const iterator to the first child Widget. More...
ChildIterator	ChildrenEnd ()
	Gets an iterator to one passed the last child Widget. More...
ConstChildIterator	ChildrenEnd () const
	Gets an iterator to one passed the last child Widget. More...
ImageLayer *	CreateImageLayer ()
	Creates an ImageLayer for this renderable. More...
ImageLayer *	CreateImageLayer (const UInt16 ZOrder, const String &GroupName)
	Creates an ImageLayer for this renderable and adds it to a RenderLayerGroup. More...
ImageLayer *	CreateImageLayer (const GroupOrderEntryVector &Entrys)
	Creates an ImageLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
MultiLineTextLayer *	CreateMultiLineTextLayer ()
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const UInt16 ZOrder, const String &GroupName)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const GroupOrderEntryVector &Entrys)
	Creates a MultiLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const String &FontName)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const String &FontName, const UInt16 ZOrder, const String &GroupName)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const String &FontName, const GroupOrderEntryVector &Entrys)
	Creates a MultiLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const Real &LineHeight)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const Real &LineHeight, const UInt16 ZOrder, const String &GroupName)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const Real &LineHeight, const GroupOrderEntryVector &Entrys)
	Creates a MultiLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
RenderLayerGroup *	CreateOrRetrieveRenderLayerGroup (const String &Name)
	Gets the named RenderLayerGroup or creates one with the specified name if it does not exist. More...
RenderLayerGroup *	CreateRenderLayerGroup (const String &Name)
	Creates a new RenderLayerGroup that can have. Exceptions This function will throw an exception if a group already exists with the provided name. More...
SingleLineTextLayer *	CreateSingleLineTextLayer ()
	Creats a SingleLineTextLayer for this renderable. More...
SingleLineTextLayer *	CreateSingleLineTextLayer (const UInt16 ZOrder, const String &GroupName)
	Creats a SingleLineTextLayer for this renderable. More...
SingleLineTextLayer *	CreateSingleLineTextLayer (const GroupOrderEntryVector &Entrys)
	Creates a SingleLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
SingleLineTextLayer *	CreateSingleLineTextLayer (const String &FontName)
	Creats a SingleLineTextLayer for this renderable. More...
SingleLineTextLayer *	CreateSingleLineTextLayer (const String &FontName, const UInt16 ZOrder, const String &GroupName)
	Creats a SingleLineTextLayer for this renderable. More...
SingleLineTextLayer *	CreateSingleLineTextLayer (const String &FontName, const GroupOrderEntryVector &Entrys)
	Creates a SingleLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
SingleLineTextLayer *	CreateSingleLineTextLayer (const Real &LineHeight)
	Creats a SingleLineTextLayer for this renderable. More...
SingleLineTextLayer *	CreateSingleLineTextLayer (const Real &LineHeight, const UInt16 ZOrder, const String &GroupName)
	Creats a SingleLineTextLayer for this renderable. More...
SingleLineTextLayer *	CreateSingleLineTextLayer (const Real &LineHeight, const GroupOrderEntryVector &Entrys)
	Creates a SingleLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
void	DestroyAllRenderLayerGroups ()
	Destroy's all RenderLayerGroups being stored/managed by this QuadRenderable.
void	DestroyAllRenderLayers ()
	Destroys all RenderLayers being stored by this renderable.
void	DestroyRenderLayer (RenderLayer *ToBeDestroyed)
	Destroys a RenderLayer being stored by this renderable. More...
void	DestroyRenderLayerGroup (const String &Name)
	Destroy's a RenderLayerGroup by name. More...
void	DestroyRenderLayerGroup (RenderLayerGroup *ToBeDestroyed)
	Destroy's a RenderLayerGroup by pointer. More...
RenderLayerGroup *	GetActiveGroup () const
	Gets the current RenderLayerGroup used for rendering. More...
virtual Vector2	GetActualPosition () const
	Gets the pixel position of this widget. More...
virtual Vector2	GetActualSize () const
	Gets the pixel size of this widget. More...
virtual Widget *	GetChild (const UInt16 Zorder) const
	Gets a child by it's ZOrder. More...
virtual Widget *	GetChild (const String &RendName) const
	Gets a child by it's name. More...
virtual UI::SizingRules	GetHorizontalSizingRules () const
	Gets the current behavior this quad will follow for the X axis when it is resized. More...
virtual Real	GetIdealHeightForText () const
	Gets the height needed for this quadrenderable to be able to completely display text in it's child text layers. More...
virtual bool	GetManualTransformUpdates () const
	Gets whether or not this quad will be automatically updated when parent transforms are updated. More...
virtual UnifiedVec2	GetMaxSize () const
	Gets the currently set maximum size for this quad. More...
virtual UnifiedVec2	GetMinSize () const
	Gets the currently set minimum size for this quad. More...
virtual bool	GetMousePassthrough () const
	Gets whether or not Mouse Passthrough is enabled. More...
QuadRenderable *	GetNextSibling (Boolean Wrap=true)
	Gets the QuadRenderable after this one among the QuadRenderables owned by it's parent. More...
virtual Whole	GetNumChildren () const
	Gets the number of children in this QuadRenderable. More...
UInt32	GetNumRenderLayerGroups () const
	Gets the number of RenderLayerGroup's created for this renderable. More...
UInt32	GetNumRenderLayers () const
	Gets the number of RenderLayers created for this renderable. More...
UInt32	GetNumVisibleRenderLayers () const
	Gets the number of RenderLayers that are visible in this renderable. More...
QuadRenderable *	GetParent () const
	Gets the parent of this quad. More...
virtual const PositioningInfo &	GetPositioningPolicy () const
	Gets the current behavior this QuadRenderable will use when it is positioned. More...
virtual UI::PositioningFlags	GetPositioningRules () const
	Gets the current behavior this quad will follow when it is positioned automatically. More...
QuadRenderable *	GetPrevSibling (Boolean Wrap=true)
	Gets the QuadRenderable before this one among the QuadRenderables owned by it's parent. More...
virtual Rect	GetRect () const
	Gets this QuadRenderables' Rect. More...
RenderLayer *	GetRenderLayer (const UInt32 &Index) const
	Gets a RenderLayer belonging to this QuadRenderable by index. More...
RenderLayerGroup *	GetRenderLayerGroup (const String &Name) const
	Gets a RenderLayerGroup by name. More...
virtual UI::RenderPriority	GetRenderPriority () const
	Gets the priority this QuadRenderable should be rendered with. More...
virtual const SizingInfo &	GetSizingPolicy () const
	Gets the current behavior this QuadRenderable will use when it is sized. More...
virtual QuadRenderable *	GetTopMostQuad ()
	Gets the QuadRenderable that is both an ancestor of this quad, and a direct child of the screen. More...
virtual UnifiedVec2	GetUnifiedPosition () const
	Gets the position of this QuadRenderable as a Unified Vector2. More...
virtual UnifiedRect	GetUnifiedRect () const
	Gets the Unified positiona nd size of this QuadRenderable as a unified rect. More...
virtual UnifiedVec2	GetUnifiedSize () const
	Gets the size of this QuadRenderable as a Unified Vector2. More...
virtual UI::SizingRules	GetVerticalSizingRules () const
	Gets the current behavior this quad will follow for the Y axis when it is resized. More...
virtual const UInt16 &	GetZOrder () const
	Gets the currently set ZOrder of this QuadRenderable with it's parent. More...
virtual Boolean	IsChildOfScreen () const
	Gets whether or not this QuadRenderable is a direct child of it's screen. More...
virtual Boolean	IsInside (const Vector2 &Point) const
	Checks to see if a point in 2D space is inside this quad. More...
Boolean	IsVertexCachingEnabled () const
	Gets whether or not vertex caching is enabled for this Quad. More...
virtual void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...
virtual void	ProtoDeSerializeChildQuads (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the ChildQuads of this object with it. More...
virtual void	ProtoDeSerializeRenderLayerGroups (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the RenderLayerGroups of this object with it. More...
virtual void	ProtoDeSerializeRenderLayers (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the RenderLayers of this object with it. More...
virtual void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...
virtual void	ProtoSerializeChildQuads (XML::Node &SelfRoot) const
	Convert the child quads of this class to an XML::Node ready for serialization. More...
virtual void	ProtoSerializeRenderLayerGroups (XML::Node &SelfRoot) const
	Convert the RenderLayerGroups of this class to an XML::Node ready for seriailization. More...
virtual void	ProtoSerializeRenderLayers (XML::Node &SelfRoot) const
	Convert the RenderLayers of this class to an XML::Node ready for serialization. More...
ReverseChildIterator	RChildrenBegin ()
	Gets an iterator to the last Widget. More...
ConstReverseChildIterator	RChildrenBegin () const
	Gets a const iterator to the last Widget. More...
ReverseChildIterator	RChildrenEnd ()
	Gets an iterator to one before the first child Widget. More...
ConstReverseChildIterator	RChildrenEnd () const
	Gets a const iterator to one before the first child Widget. More...
virtual void	RemoveAllChildren ()
	Removes all child Widgets from this QuadRenderable.
virtual void	RemoveChild (Widget *Child)
	Removes a child Widget by pointer. More...
void	RemoveLayerFromAllGroups (RenderLayer *Layer)
	Removes a single RenderLayer from all RenderLayerGroups owned by this QuadRenderable. More...
void	RemoveLayerFromGroup (RenderLayer *Layer, const String &GroupName)
	Removes a single RenderLayer from a specified RenderLayerGroup. More...
RenderLayerIterator	RenderLayerBegin ()
	Gets an iterator to the first RenderLayer. More...
ConstRenderLayerIterator	RenderLayerBegin () const
	Gets a const iterator to the first RenderLayer. More...
RenderLayerIterator	RenderLayerEnd ()
	Gets an iterator to one passed the last RenderLayer. More...
ConstRenderLayerIterator	RenderLayerEnd () const
	Gets an iterator to one passed the last RenderLayer. More...
RenderLayerGroupIterator	RenderLayerGroupBegin ()
	Gets an iterator to the first RenderLayerGroup. More...
ConstRenderLayerGroupIterator	RenderLayerGroupBegin () const
	Gets a const iterator to the first RenderLayerGroup. More...
RenderLayerGroupIterator	RenderLayerGroupEnd ()
	Gets an iterator to one passed the last RenderLayerGroup. More...
ConstRenderLayerGroupIterator	RenderLayerGroupEnd () const
	Gets an iterator to one passed the last RenderLayerGroup. More...
Boolean	RenderLayerGroupExists (const String &Name) const
	Checks to see if a RenderLayerGroup exists. More...
void	SetActiveGroup (const String &Name)
	Sets the RenderLayerGroup that will be used to render this renderable. More...
void	SetActiveGroup (RenderLayerGroup *Group)
	Sets the RenderLayerGroup that will be used to render this renderable. More...
virtual void	SetHorizontalSizingRules (const UI::SizingRules Rules)
	Sets the behavior this quad will have on the X axis when it is resized. More...
void	SetLocalVertexCaching (Boolean Enable)
	Enables or disables caching of vertex's belonging to this and all child renderables. More...
virtual void	SetManualTransformUpdates (Boolean Enable)
	Sets whether or not this quad has specific behaviors for it's transform updates and they should not be done automatically. More...
virtual void	SetMaxSize (const UnifiedVec2 &Max)
	Sets the maximum size this quad is allowed to have. More...
virtual void	SetMinSize (const UnifiedVec2 &Min)
	Sets the minimum size this quad is allowed to have. More...
virtual void	SetMousePassthrough (Boolean Enable)
	Sets whether or not this quad should be skipped when determining if the mouse is hovered over this quad. More...
virtual void	SetPositioningPolicy (const PositioningInfo &Policy)
	Sets the behavior to be used when this QuadRenderable is positioned. More...
virtual void	SetPositioningRules (const UI::PositioningFlags Rules)
	Sets the behavior this quad will have when it is positioned automatically. More...
virtual void	SetRenderPriority (const UI::RenderPriority RP)
	Sets the priority this QuadRenderable should be rendered with. More...
virtual void	SetRenderPriorityCascading (const UI::RenderPriority RP)
	Sets the priority this QuadRenderable and all it's children should be rendered with. More...
virtual void	SetSizingPolicy (const SizingInfo &Policy)
	Sets the behavior to be used when this QuadRenderable is sized. More...
virtual void	SetUnifiedPosition (const UnifiedVec2 &Position)
	Sets the position this QuadRenderable will have within it's parent. More...
virtual void	SetUnifiedSize (const UnifiedVec2 &Size)
	Sets the size this QuadRenderable will have within it's parent. More...
virtual void	SetVerticalSizingRules (const UI::SizingRules Rules)
	Sets the behavior this quad will have on the Y axis when it is resized. More...
virtual void	UpdateChildDimensions ()
	Updates the dimensions of the children in this QuadRenderable. More...
virtual void	UpdateDimensions ()
	Updates the dimensions of this QuadRenderable based on the transform of it's parent. More...
virtual void	UpdateDimensions (const Rect &OldSelfRect, const Rect &NewSelfRect)
	Updates the dimensions of this QuadRenderable based on the transform of it's parent. More...
Public Member Functions inherited from Mezzanine::UI::Renderable
bool	_IsDirty () const
	Gets whether or not this renderable is dirty. More...
const String &	GetName () const
	Gets the name of this renderable. More...
Screen *	GetScreen () const
	Gets the parent screen of this renderable. More...

Static Public Member Functions
template<typename Callback >
static Boolean	_ProcessAllChildren (Widget *Wid, Callback *CB)
	Processes all children of this screen by their zorder. More...
template<typename Callback >
static Boolean	_ReverseProcessAllChildren (Widget *Wid, Callback *CB)
	Processes all children of this screen in reverse zorder. More...
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...
Static Public Member Functions inherited from Mezzanine::UI::QuadRenderable
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...
Static Public Member Functions inherited from Mezzanine::UI::Renderable
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...

Protected Member Functions
	Screen (const String &RendName, const String &Atlas, Graphics::Viewport *WindowViewport, UIManager *Manager)
	Internal constructor. More...
	Screen (const XML::Node &XMLNode, UIManager *Manager)
	XML constructor. More...
virtual	~Screen ()
	Class destructor.
virtual Widget *	CheckAndInsertExcept (Widget *ToInsert)
	Verifies uniqueness of a widget and inserts it if it is. Exceptions If a widget with the same name already exists in this Screen, a II_DUPLICATE_IDENTITY_EXCEPTION will be thrown. More...
virtual void	CreateVertexBuffer (const Whole &InitialSize)
	Creates a new Vertex Buffer for vertices generated by the UI system. More...
virtual void	DestroyVertexBuffer ()
	Destroys the Vertex Buffer storing all the UI vertices generated by this screen. More...
virtual Graphics::SceneManager *	GetSceneManager () const
	Gets a pointer to the SceneManager connected to this screens viewport. More...
virtual WidgetFactory *	GetWidgetFactoryExcept (const String &WidgetTypeName)
	Gets a registered WidgetFactory that creates the specified type of widget. Exceptions If a widget factor of the specified widget type isn't registered then a II_IDENTITY_NOT_FOUND_EXCEPTION will be thrown. More...
virtual void	PrepareRenderSystem ()
	Sets up all the necessary projection and world matrices for UI rendering. More...
virtual void	ResizeVertexBuffer (const Whole &RequestedSize)
	Resizes the Vertex Buffer. More...
Protected Member Functions inherited from Mezzanine::UI::QuadRenderable
	QuadRenderable (Screen *Parent)
	Blank constructor. More...
	QuadRenderable (const String &RendName, Screen *Parent)
	Class constructor. More...
	QuadRenderable (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
	Parent-less constructor. More...
virtual	~QuadRenderable ()
	Class destructor. More...
void	AppendLayerVertices (std::vector< VertexData > &Vertices)
	Adds all the vertices belonging to all the layers of this renderable to the provided vector. More...
void	CleanLayers ()
	Redraws all dirty layers. More...
virtual void	ProtoDeSerializeImpl (const XML::Node &SelfRoot)
	Implementation method for deseriailizing additional sets of data. More...
virtual void	ProtoSerializeImpl (XML::Node &SelfRoot) const
	Implementation method for serializing additional sets of data. More...
void	ResizeLayers (const Whole NewSize)
	Resizes the container for RenderLayers in this QuadRenderable. More...
Protected Member Functions inherited from Mezzanine::UI::Renderable
	Renderable (Screen *Parent)
	Blank constructor. More...
	Renderable (const String &RendName, Screen *Parent)
	Class constructor. More...
virtual	~Renderable ()
	Class destructor.

Protected Attributes
Graphics::Viewport *	GameViewport
	A pointer to the viewport this screen is bound to. More...
Vector2	InverseSize
	The inverse size (1/size) of the viewport this screen is bound to in pixels. More...
Vector2	MouseHitPosition
	The pixel position on this screen where the mouse clicked on a Widget. More...
MouseHoverStrategy *	MouseStrat
	A pointer to the strategy to be used when detecting the hovered widget. More...
Mezzanine::OrientationMode	Orientation
	The current orientation mode of this screen. More...
String	PrimaryAtlas
	The name of the this screens primary atlas for texture lookups. More...
Vector3	Scale
	The scaling to be applied to all vertices that are generated by this screen. More...
ScreenInternalData *	SID
	A pointer to the class storing all sensative internal data THAT IS NOT FOR YOUR EYES! More...
TextureVertexContainer	TextureByVertex
	A container storing a mapping of the textures needed to render each section of vertices. More...
UIManager *	UIMan
	A pointer to the UIManager that owns this screen. More...
ScreenRenderData	VertexCache
	A container storing the actual vertices to be rendered. More...
Matrix4x4	VertexTransform
	The transformation matrix used to update vertex transforms if needed. More...
WidgetFactoryContainer	WidgetFactories
	A container storing all the factories for the widgets supported by this screen. More...
WidgetContainer	Widgets
	A container storing all the created Widgets owned by this screen. More...
Protected Attributes inherited from Mezzanine::UI::QuadRenderable
Rect	ActDims
	The actual (pixel) position and size of this Quad on the screen it belongs to. More...
RenderLayerGroup *	ActiveGroup
	This is a pointer to the group of RenderLayers currently being used for rendering. More...
Boolean	AllLayersDirty
	Determines whether or not this Quad needs all of it's layers refreshed. Usually after a transform update. More...
ChildContainer	ChildWidgets
	This is a container storing all the children that belong to this Quad. More...
LayoutStrategy *	LayoutStrat
	This is a pointer to the strategy being used by this Quad to determine the positions and sizes of children during transform updates. More...
Boolean	ManualTransformUpdates
	Controls whether or not this Quad and it's children will recieve automatic transform updates. More...
Boolean	MousePassthrough
	Controls whether or not this Quad will be considered for mouse hover checks. More...
QuadRenderable *	ParentQuad
	This is a pointer to the Quad that owns this Quad and is responsible for transform updates applied to this Quad. More...
PositioningInfo	PositioningPolicy
	This stores all the information needed to determine the specific behaviors this Quad should have when it's position is being updated. More...
UI::RenderPriority	Priority
	Determines the "higher ZOrder" of this Quad compared to all other renderables on screen. More...
RenderLayerGroupContainer	RenderLayerGroups
	This is a container storing all the RenderLayerGroup instances created by and belonging to this Quad. More...
RenderLayerContainer	RenderLayers
	This is a container storing all the RenderLayer instances created by and belonging to this Quad. More...
SizingInfo	SizingPolicy
	This stores all the information needed to determine the specific behaviors this Quad should have when it's size is being updated. More...
ScreenRenderData *	VertexCache
	This is a pointer to the optional cache of vertex's belonging to this Quad and all of it's children. More...
UInt16	ZOrder
	This is the ZOrder of this Quad in relation to all other Quads in it's parent. More...
Protected Attributes inherited from Mezzanine::UI::Renderable
Boolean	Dirty
	Stores whether this Renderables vertices need to be regenerated. More...
String	Name
	The unique name of this Renderable. More...
Screen *	ParentScreen
	A pointer to the Screen that created this Renderable. More...
Boolean	Visible
	Stores whether this Renderable is to be rendered (also dependent on parent visibility). More...

Friends
class	Mezzanine::UI::UIManager

Detailed Description

This class is a helper class for creating UI's. It is responsible for storing and keeping track of all the elements of a single UI screen.

UI's can optionally be divided up into Screens. Each screen is batched together for rendering, so keeping the amount of screens to a minimum will improve performance.

Definition at line 135 of file screen.h.

Constructor & Destructor Documentation

Mezzanine::UI::Screen::Screen ( const String &  RendName, const String &  Atlas, Graphics::Viewport *  WindowViewport, UIManager *  Manager  )

protected

Internal constructor.

Parameters

RendName	The name of this screen.
Atlas	The name of the primary atlas to be assigned to this screen. This can be overridden later, even by individual UI elements.
WindowViewport	The Viewport to which this screen belongs.
Manager	A pointer to the UI manager creating this screen.

Definition at line 192 of file screen.cpp.

Mezzanine::UI::Screen::Screen ( const XML::Node &  XMLNode, UIManager *  Manager  )

protected

XML constructor.

Parameters

XMLNode	The node of the xml document to construct from.
Manager	A pointer to the UI manager creating this screen.

Definition at line 228 of file screen.cpp.

Member Function Documentation

void Mezzanine::UI::Screen::_MarkAllLayersDirty ( )

virtual

Tells this QuadRenderable that all of it's layers are dirty.

Reimplemented from Mezzanine::UI::QuadRenderable.

Definition at line 891 of file screen.cpp.

void Mezzanine::UI::Screen::_MarkDirty ( )

virtual

Marks this renderable as dirty, and informs other renderables if needed.

Reimplemented from Mezzanine::UI::QuadRenderable.

Definition at line 885 of file screen.cpp.

template<typename Callback >

Boolean Mezzanine::UI::Screen::_ProcessAllChildren ( Callback *  CB)

inline

Processes all children of this screen by their zorder.

Parameters

CB	The callback implementing how the children are to be processed.

Returns

Returns the result of the callback, and exits early if true.

Definition at line 591 of file screen.h.

template<typename Callback >

static Boolean Mezzanine::UI::Screen::_ProcessAllChildren ( Widget *  Wid, Callback *  CB  )

inlinestatic

Processes all children of this screen by their zorder.

Parameters

Wid	The Widget whose children need to be processed.
CB	The callback implementing how the children are to be processed.

Returns

Returns the result of the callback, and exits early if true.

Definition at line 620 of file screen.h.

void Mezzanine::UI::Screen::_RenderScreen

(

)

Manually calls the UI system to render this screen.

Definition at line 900 of file screen.cpp.

void Mezzanine::UI::Screen::_RenderVertices

(

bool

Force = false)

Prepares all vertices for rendering to the screen.

Parameters

Force

Whether or not to force preparation regardless of if they need it.

Definition at line 972 of file screen.cpp.

template<typename Callback >

Boolean Mezzanine::UI::Screen::_ReverseProcessAllChildren ( Callback *  CB)

inline

Processes all children of this screen in reverse zorder.

Parameters

CB	The callback implementing how the children are to be processed.

Returns

Returns the result of the callback, and exits early if true.

Definition at line 605 of file screen.h.

template<typename Callback >

static Boolean Mezzanine::UI::Screen::_ReverseProcessAllChildren ( Widget *  Wid, Callback *  CB  )

inlinestatic

Processes all children of this screen in reverse zorder.

Parameters

Wid	The Widget whose children need to be processed.
CB	The callback implementing how the children are to be processed.

Returns

Returns the result of the callback, and exits early if true.

Definition at line 637 of file screen.h.

void Mezzanine::UI::Screen::_SetOrientation

(

const Mezzanine::OrientationMode &

Mode)

Forces an orientation mode change for this screen.

Parameters

Mode	The orientation mode to be applied to the UI on this screen.

Definition at line 946 of file screen.cpp.

void Mezzanine::UI::Screen::_Transform	(	ScreenRenderData &	RenderData,
		const Whole &	Begin,
		const Whole &	End
	)

Updates the vertex positions so they are in front of the camera in world space.

Parameters

RenderData	Vector of the vertices to be transformed.
Begin	The first Vertex to transform in the range.
End	The last Vertex to transform in the range.

Definition at line 955 of file screen.cpp.

void Mezzanine::UI::Screen::AddWidgetFactory

(

WidgetFactory *

ToBeAdded)

Adds/registers a widget factory with this Screen, allowing it to be constructed through this API.

Parameters

ToBeAdded

The widget factory to be added.

Definition at line 442 of file screen.cpp.

Widget * Mezzanine::UI::Screen::CheckAndInsertExcept ( Widget *  ToInsert)

protectedvirtual

Verifies uniqueness of a widget and inserts it if it is.

Exceptions

If	a widget with the same name already exists in this Screen, a II_DUPLICATE_IDENTITY_EXCEPTION will be thrown.

Parameters

ToInsert

The widget to be verified and inserted.

Returns

Returns a pointer to the same widget that was passed into this method.

Definition at line 286 of file screen.cpp.

Button * Mezzanine::UI::Screen::CreateButton ( const String &  Name)

virtual

Creates a Button.

Parameters

Name	The name to be given to this Button.

Returns

Returns a pointer to the created Button.

Definition at line 590 of file screen.cpp.

Button * Mezzanine::UI::Screen::CreateButton ( const String &  Name, const UnifiedRect &  RendRect  )

virtual

Creates a Button.

Parameters

Name	The name to be given to this Button.
RendRect	The rect describing this Button's transform relative to it's parent.

Returns

Returns a pointer to the created Button.

Definition at line 597 of file screen.cpp.

CheckBox * Mezzanine::UI::Screen::CreateCheckBox ( const String &  Name)

virtual

Creates a CheckBox.

Parameters

Name	The name of the CheckBox.

Returns

Returns a pointer to the created CheckBox.

Definition at line 632 of file screen.cpp.

CheckBox * Mezzanine::UI::Screen::CreateCheckBox ( const String &  Name, const UnifiedRect &  RendRect  )

virtual

Creates a CheckBox.

Parameters

Name	The name of the CheckBox.
RendRect	The Rect representing the position and size of the CheckBox.

Returns

Returns a pointer to the created CheckBox.

Definition at line 639 of file screen.cpp.

HorizontalContainer * Mezzanine::UI::Screen::CreateHorizontalContainer ( const String &  RendName)

virtual

Creates a widget container aligned on the X axis.

Parameters

RendName

The name to be given to this renderable.

Returns

Returns a pointer to the created HorizontalContainer.

Definition at line 688 of file screen.cpp.

HorizontalContainer * Mezzanine::UI::Screen::CreateHorizontalContainer ( const String &  RendName, const UnifiedRect &  RendRect  )

virtual

Creates a widget container aligned on the X axis.

Parameters

RendName	The name to be given to this renderable.
RendRect	The rect describing this widget's transform relative to it's parent.

Returns

Returns a pointer to the created HorizontalContainer.

Definition at line 695 of file screen.cpp.

HorizontalScrollbar * Mezzanine::UI::Screen::CreateHorizontalScrollbar ( const String &  Name, const UI::ScrollbarStyle  Style  )

virtual

Creates a Scrollbar aligned on the X axis.

Parameters

Name	The name of the HorizontalScrollbar.
Style	The style of scrollbar you want to create, see Scrollbar documentation for more details.

Returns

Returns a pointer to the created HorizontalScrollbar.

Definition at line 646 of file screen.cpp.

HorizontalScrollbar * Mezzanine::UI::Screen::CreateHorizontalScrollbar ( const String &  Name, const UnifiedRect &  RendRect, const UI::ScrollbarStyle  Style  )

virtual

Creates a Scrollbar aligned on the X axis.

Parameters

Name	The name of the HorizontalScrollbar.
RendRect	The Rect representing the position and size of the HorizontalScrollbar.
Style	The style of scrollbar you want to create, see Scrollbar documentation for more details.

Returns

Returns a pointer to the created HorizontalScrollbar.

Definition at line 653 of file screen.cpp.

MenuButton * Mezzanine::UI::Screen::CreateMenuButton ( const String &  Name)

virtual

Creates a MenuButton.

Parameters

Name	The name to be given to this MenuButton.

Returns

Returns a pointer to the created MenuButton.

Definition at line 604 of file screen.cpp.

MenuButton * Mezzanine::UI::Screen::CreateMenuButton ( const String &  Name, const UnifiedRect &  RendRect  )

virtual

Creates a MenuButton.

Parameters

Name	The name to be given to this MenuButton.
RendRect	The rect describing this MenuButton's transform relative to it's parent.

Returns

Returns a pointer to the created MenuButton.

Definition at line 611 of file screen.cpp.

MenuEntry * Mezzanine::UI::Screen::CreateMenuEntry ( const String &  Name)

virtual

Creates a MenuEntry.

Parameters

Name	The name to be given to this MenuEntry.

Returns

Returns a pointer to the created MenuEntry.

Definition at line 674 of file screen.cpp.

MenuEntry * Mezzanine::UI::Screen::CreateMenuEntry ( const String &  Name, const UnifiedRect &  RendRect  )

virtual

Creates a MenuEntry.

Parameters

Name	The name to be given to this MenuEntry.
RendRect	The rect describing this MenuEntry's transform relative to it's parent.

Returns

Returns a pointer to the created MenuEntry.

Definition at line 681 of file screen.cpp.

RadioButton * Mezzanine::UI::Screen::CreateRadioButton ( const String &  Name)

virtual

Creates a RadioButton.

Parameters

Name	The name to be given to this RadioButton.

Returns

Returns a pointer to the created RadioButton.

Definition at line 618 of file screen.cpp.

RadioButton * Mezzanine::UI::Screen::CreateRadioButton ( const String &  Name, const UnifiedRect &  RendRect  )

virtual

Creates a RadioButton.

Parameters

Name	The name to be given to this RadioButton.
RendRect	The rect describing this RadioButton's transform relative to it's parent.

Returns

Returns a pointer to the created RadioButton.

Definition at line 625 of file screen.cpp.

void Mezzanine::UI::Screen::CreateVertexBuffer ( const Whole &  InitialSize)

protectedvirtual

Creates a new Vertex Buffer for vertices generated by the UI system.

Parameters

InitialSize

The amount of space to allocate for the initial buffer, in number of vertices.

Definition at line 305 of file screen.cpp.

VerticalContainer * Mezzanine::UI::Screen::CreateVerticalContainer ( const String &  RendName)

virtual

Creates a widget container aligned on the Y axis.

Parameters

RendName

The name to be given to this renderable.

Returns

Returns a pointer to the created VerticalContainer.

Definition at line 702 of file screen.cpp.

VerticalContainer * Mezzanine::UI::Screen::CreateVerticalContainer ( const String &  RendName, const UnifiedRect &  RendRect  )

virtual

Creates a widget container aligned on the Y axis.

Parameters

RendName	The name to be given to this renderable.
RendRect	The rect describing this widget's transform relative to it's parent.

Returns

Returns a pointer to the created VerticalContainer.

Definition at line 709 of file screen.cpp.

VerticalScrollbar * Mezzanine::UI::Screen::CreateVerticalScrollbar ( const String &  Name, const UI::ScrollbarStyle  Style  )

virtual

Creates a Scrollbar aligned on the Y axis.

Parameters

Name	The name of the VerticalScrollbar.
Style	The style of scrollbar you want to create, see Scrollbar documentation for more details.

Returns

Returns a pointer to the created VerticalScrollbar.

Definition at line 660 of file screen.cpp.

VerticalScrollbar * Mezzanine::UI::Screen::CreateVerticalScrollbar ( const String &  Name, const UnifiedRect &  RendRect, const UI::ScrollbarStyle  Style  )

virtual

Creates a Scrollbar aligned on the Y axis.

Parameters

Name	The name of the VerticalScrollbar.
RendRect	The Rect representing the position and size of the VerticalScrollbar.
Style	The style of scrollbar you want to create, see Scrollbar documentation for more details.

Returns

Returns a pointer to the created VerticalScrollbar.

Definition at line 667 of file screen.cpp.

Widget * Mezzanine::UI::Screen::CreateWidget ( const XML::Node &  WidgetNode)

virtual

Creates a widget from an XML::Node.

Exceptions

This	method will throw an exception if the WidgetNode is not named after a known widget.

Parameters

WidgetNode

The XML node populated with data needed to construct a widget.

Returns

Returns a pointer to the created widget.

Definition at line 523 of file screen.cpp.

Widget * Mezzanine::UI::Screen::CreateWidget ( const String &  Name)

virtual

Creates a generic widget.

Note

This is not a polymorphic create method. It will case an instance of the widget base class.

Parameters

Name	The name to be given to this Widget.

Returns

Returns a pointer to the created Widget.

Definition at line 576 of file screen.cpp.

Widget * Mezzanine::UI::Screen::CreateWidget ( const String &  Name, const UnifiedRect &  RendRect  )

virtual

Creates a generic widget.

Note

This is not a polymorphic create method. It will case an instance of the widget base class.

Parameters

Name	The name to be given to this Widget.
RendRect	The rect describing this Widget's transform relative to it's parent.

Returns

Returns a pointer to the created Widget.

Definition at line 583 of file screen.cpp.

void Mezzanine::UI::Screen::DestroyAllWidgetFactories

(

)

Destroys all widget factories in this Screen.

Warning

The destruction of widget factories should only be done after the corresponding managers have been destroyed, otherwise this will cause an exception.

Definition at line 474 of file screen.cpp.

void Mezzanine::UI::Screen::DestroyVertexBuffer ( )

protectedvirtual

Destroys the Vertex Buffer storing all the UI vertices generated by this screen.

Definition at line 335 of file screen.cpp.

void Mezzanine::UI::Screen::DestroyWidget ( Widget *  ToBeDestroyed)

virtual

Destroys a widget.

Parameters

ToBeDestroyed

Pointer to the widget you want destroyed.

Definition at line 546 of file screen.cpp.

void Mezzanine::UI::Screen::DestroyWidgetFactory

(

WidgetFactory *

ToBeDestroyed)

Removes and destroys a widget factory in this Screen.

Parameters

ToBeDestroyed

A pointer to the widget factory that is to be removed and destroyed.

Definition at line 460 of file screen.cpp.

void Mezzanine::UI::Screen::DestroyWidgetFactory

(

const String &

ImplName)

Removes and destroys a widget factory in this Screen.

Parameters

ImplName

The name of the widget implementation created by the factory to be removed and destroyed.

Definition at line 465 of file screen.cpp.

Widget * Mezzanine::UI::Screen::FindHoveredWidget ( const Vector2 &  MousePos)

virtual

Gets the quad the mouse is over if any.

Parameters

MousePos

The current mouse position.

Returns

Returns the Widget the mouse is over, or NULL if there are none.

Definition at line 425 of file screen.cpp.

TextureAtlas * Mezzanine::UI::Screen::GetAtlas

(

const String &

Atlas)

const

Gets an atlas that has been loaded.

Parameters

Atlas

The name of the Atlas to retrieve, usually stored as a filename.

Returns

Returns a pointer to the requested Texture Atlas.

Definition at line 773 of file screen.cpp.

String Mezzanine::UI::Screen::GetDerivedSerializableName ( ) const

virtual

Gets the most derived serializable name of this Renderable.

Note

When creating a new Renderable class verify this method has a valid return for it in order for serialization to work properly.

Returns

Returns the name of the XML tag from the most derived class of "this".

Reimplemented from Mezzanine::UI::QuadRenderable.

Definition at line 876 of file screen.cpp.

FontData * Mezzanine::UI::Screen::GetFont	(	const String &	FontName,
		const String &	Atlas
	)		const

Gets the specified FontData from an Atlas.

Parameters

FontName	The name of the Font to retrieve.
Atlas	The name of the atlas to check the specified FontData for.

Returns

Returns a pointer to the requested FontData.

Definition at line 767 of file screen.cpp.

UIManager * Mezzanine::UI::Screen::GetManager ( ) const

virtual

Gets the UIManager this screen belongs to.

Returns

Returns a pointer to the UI manager that owns this screen.

Definition at line 404 of file screen.cpp.

MarkupParser * Mezzanine::UI::Screen::GetMarkupParser

(

const String &

ParserName)

const

Gets a MarkupParser by it's registered name.

Parameters

ParserName

The name of the MarkupParser to retrieve.

Returns

Returns a pointer to the requested MarkupParser, or NULL if none are registered under the specified name.

Definition at line 788 of file screen.cpp.

const Vector2 & Mezzanine::UI::Screen::GetMouseHitPosition ( ) const

virtual

Gets the mouse position from the last call to "FindHoveredQuad(const Vector2&).

Note

Screens have a 1:1 ratio to viewports, not windows. The returned coordinates is in viewport space.

Warning

This will not perform any additional checks. Only returns the result of the last check. Verify the screen this is being called on is the one with the mouse over if prior to calling or you may get outdated information.

Returns

Returns a valid point on this screen if the last check was valid, or (-1,-1) if the check failed.

Definition at line 434 of file screen.cpp.

MouseHoverStrategy * Mezzanine::UI::Screen::GetMouseHoverStrategy ( ) const

virtual

Gets the MouseHoverStrategy currently being used by this screen.

Returns

Returns a pointer to the currently set MouseHoverStrategy.

Definition at line 420 of file screen.cpp.

Whole Mezzanine::UI::Screen::GetNumWidgets ( )

virtual

Gets the number of widgets being used in this screen.

Returns

Returns the number of widgets this screen is storing.

Definition at line 541 of file screen.cpp.

String Mezzanine::UI::Screen::GetPrimaryAtlas ( )

virtual

Gets the currently set primary atlas.

Returns

Returns a string containing the name of the primary atlas that is set.

Definition at line 758 of file screen.cpp.

Renderable::RenderableType Mezzanine::UI::Screen::GetRenderableType ( ) const

virtual

Gets the type of renderable this is.

Returns

Returns a RenderableType enum value coressponding the type of renderable this is.

Implements Mezzanine::UI::Renderable.

Definition at line 382 of file screen.cpp.

Graphics::SceneManager * Mezzanine::UI::Screen::GetSceneManager ( ) const

protectedvirtual

Gets a pointer to the SceneManager connected to this screens viewport.

Returns

Returns a pointer to the SceneManager that will be rendering this screen.

Todo:

This function exists (as opposed to storing a pointer that doesn't change) so that if changes in the viewport configuration occur this will pick up on that. However the render queue listener that is added in this class' constructor never gets re-assigned. This needs to be fixed. Until then if a change does occur the UI will be rendered at a different time then it needs to be, potentially overwritten by the scene render.

Definition at line 260 of file screen.cpp.

String Mezzanine::UI::Screen::GetSerializableName ( )

static

Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized.

Returns

A string containing the name of this class.

Definition at line 879 of file screen.cpp.

Sprite * Mezzanine::UI::Screen::GetSprite	(	const String &	SpriteName,
		const String &	Atlas
	)		const

Gets a sprite from an Atlas.

Parameters

SpriteName	The name of the sprite to retrieve.
Atlas	The name of the Atlas to get the sprite from.

Returns

Returns a pointer to the requested Sprite.

Definition at line 764 of file screen.cpp.

Real Mezzanine::UI::Screen::GetTexelOffsetX

(

)

const

Gets the X axis Texel Offset for the current rendersystem.

Returns

Retruns a real containing the texel offset to be applied to renderables on this screen.

Definition at line 776 of file screen.cpp.

Real Mezzanine::UI::Screen::GetTexelOffsetY

(

)

const

Gets the Y axis Texel Offset for the current rendersystem.

Returns

Retruns a real containing the texel offset to be applied to renderables on this screen.

Definition at line 779 of file screen.cpp.

Vector2 Mezzanine::UI::Screen::GetTextureSize

(

const String &

Atlas)

const

Gets the texture size of the specified Atlas.

Parameters

Atlas

The name of the atlas to get the texture size of.

Returns

Returns a Vector2 containing the size of the requested Atlas.

Definition at line 770 of file screen.cpp.

Graphics::Viewport * Mezzanine::UI::Screen::GetViewport ( ) const

virtual

Gets the Viewport this screen is currently rendering to.

Returns

Returns a pointer to the Viewport this screen is applied to.

Definition at line 401 of file screen.cpp.

const Vector2 & Mezzanine::UI::Screen::GetViewportDimensions ( ) const

virtual

Gets the current viewport dimensions.

Returns

Returns a Vector2 representing the current viewport dimensions.

Definition at line 385 of file screen.cpp.

Boolean Mezzanine::UI::Screen::GetVisible ( ) const

virtual

Gets the visibility setting of this renderable.

Returns

Returns a bool that is the current visibility setting of this renderable.

Implements Mezzanine::UI::Renderable.

Definition at line 370 of file screen.cpp.

Vector2 Mezzanine::UI::Screen::GetWhitePixel

(

const String &

Atlas)

const

Gets the position of the white pixel from an Atlas.

Parameters

Atlas

The name of the Atlas to get the white pixel from.

Returns

Returns a Vector2 with the location of white pixel on the Atlas.

Definition at line 761 of file screen.cpp.

Widget * Mezzanine::UI::Screen::GetWidget ( const String &  Name)

virtual

Gets a widget in this screen by name.

Parameters

Name	The name of the widget to get.

Returns

Returns a pointer to the widget of the specified name.

Definition at line 534 of file screen.cpp.

WidgetFactory * Mezzanine::UI::Screen::GetWidgetFactoryExcept ( const String &  WidgetTypeName)

protectedvirtual

Gets a registered WidgetFactory that creates the specified type of widget.

Exceptions

If	a widget factor of the specified widget type isn't registered then a II_IDENTITY_NOT_FOUND_EXCEPTION will be thrown.

Parameters

WidgetTypeName

The name of the widget type to retrieve the factory for.

Returns

Returns a pointer to the specified factory. This pointer will always be valid if an exception isn't thrown.

Definition at line 276 of file screen.cpp.

void Mezzanine::UI::Screen::Hide ( )

virtual

Forces this renderable to hide.

Implements Mezzanine::UI::Renderable.

Definition at line 379 of file screen.cpp.

bool Mezzanine::UI::Screen::IsMarkupParserRegistered

(

const String &

ParserName)

const

Checks to see if a MarkupParser has already been registsered under a specific name.

Parameters

ParserName

The name of the MarkupParser to check for.

Returns

Returns true if a MarkupParser is registered under the specified name.

Definition at line 785 of file screen.cpp.

Boolean Mezzanine::UI::Screen::IsVisible ( ) const

virtual

Gets whether or not this renderable is being drawn.

This function will check the visibility of all parent objects to see if it is being drawn. This will not tell you whether or not this renderable has it's own visibility setting enabled. For that see: GetVisible().

Returns

Returns a bool representing the visibility of this renderable.

Implements Mezzanine::UI::Renderable.

Definition at line 373 of file screen.cpp.

void Mezzanine::UI::Screen::PrepareRenderSystem ( )

protectedvirtual

Sets up all the necessary projection and world matrices for UI rendering.

Definition at line 295 of file screen.cpp.

void Mezzanine::UI::Screen::ProtoDeSerializeProperties ( const XML::Node &  SelfRoot)

virtual

Take the data stored in an XML Node and overwrite the properties of this object with it.

Parameters

SelfRoot

An XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::UI::QuadRenderable.

Definition at line 815 of file screen.cpp.

void Mezzanine::UI::Screen::ProtoSerializeProperties ( XML::Node &  SelfRoot) const

virtual

Convert the properties of this class to an XML::Node ready for serialization.

Parameters

SelfRoot

The root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::UI::QuadRenderable.

Definition at line 794 of file screen.cpp.

void Mezzanine::UI::Screen::RemoveWidgetFactory

(

WidgetFactory *

ToBeRemoved)

Removes a widget factory from this Screen.

Parameters

ToBeRemoved

A pointer to the widget factory that is to be removed.

Definition at line 447 of file screen.cpp.

void Mezzanine::UI::Screen::RemoveWidgetFactory

(

const String &

ImplName)

Removes a widget factory from this Screen.

Parameters

ImplName

The name of the widget implementation created by the factory to be removed.

Definition at line 452 of file screen.cpp.

void Mezzanine::UI::Screen::ResizeVertexBuffer ( const Whole &  RequestedSize)

protectedvirtual

Resizes the Vertex Buffer.

Note

The Vertex Buffer will not shrink, only grow. Passing in a smaller size will do nothing.

Parameters

RequestedSize

The new size for the existing buffer.

Definition at line 342 of file screen.cpp.

void Mezzanine::UI::Screen::SetMouseHoverStrategy ( MouseHoverStrategy *  Strategy)

virtual

Sets the strategy to use when detect which object the mouse is hovered over.

Note

This method will replace whatever method is currently set if one is set.

Parameters

Strategy

A pointer to the strategy to use.

Definition at line 410 of file screen.cpp.

void Mezzanine::UI::Screen::SetPrimaryAtlas ( const String &  Atlas)

virtual

Sets the Atlas to be assumed when one isn't provided for atlas related tasks.

Parameters

Atlas

The name of the atlas to be used.

Definition at line 755 of file screen.cpp.

void Mezzanine::UI::Screen::SetVisible ( Boolean  CanSee)

virtual

Implements Mezzanine::UI::Renderable.

Definition at line 367 of file screen.cpp.

void Mezzanine::UI::Screen::Show ( )

virtual

Forces this renderable to be shown.

Implements Mezzanine::UI::Renderable.

Definition at line 376 of file screen.cpp.

Member Data Documentation

Graphics::Viewport* Mezzanine::UI::Screen::GameViewport

protected

A pointer to the viewport this screen is bound to.

Definition at line 195 of file screen.h.

Vector2 Mezzanine::UI::Screen::InverseSize

protected

The inverse size (1/size) of the viewport this screen is bound to in pixels.

Definition at line 185 of file screen.h.

Vector2 Mezzanine::UI::Screen::MouseHitPosition

protected

The pixel position on this screen where the mouse clicked on a Widget.

Definition at line 182 of file screen.h.

MouseHoverStrategy* Mezzanine::UI::Screen::MouseStrat

protected

A pointer to the strategy to be used when detecting the hovered widget.

Definition at line 198 of file screen.h.

Mezzanine::OrientationMode Mezzanine::UI::Screen::Orientation

protected

The current orientation mode of this screen.

Definition at line 202 of file screen.h.

String Mezzanine::UI::Screen::PrimaryAtlas

protected

The name of the this screens primary atlas for texture lookups.

Definition at line 175 of file screen.h.

Vector3 Mezzanine::UI::Screen::Scale

protected

The scaling to be applied to all vertices that are generated by this screen.

Note

This member is set once and barely used, could be replaced with individual constructions where used.

Definition at line 179 of file screen.h.

ScreenInternalData* Mezzanine::UI::Screen::SID

protected

A pointer to the class storing all sensative internal data THAT IS NOT FOR YOUR EYES!

Definition at line 189 of file screen.h.

TextureVertexContainer Mezzanine::UI::Screen::TextureByVertex

protected

A container storing a mapping of the textures needed to render each section of vertices.

Definition at line 159 of file screen.h.

UIManager* Mezzanine::UI::Screen::UIMan

protected

A pointer to the UIManager that owns this screen.

Definition at line 192 of file screen.h.

ScreenRenderData Mezzanine::UI::Screen::VertexCache

protected

A container storing the actual vertices to be rendered.

Definition at line 162 of file screen.h.

Matrix4x4 Mezzanine::UI::Screen::VertexTransform

protected

The transformation matrix used to update vertex transforms if needed.

Definition at line 172 of file screen.h.

WidgetFactoryContainer Mezzanine::UI::Screen::WidgetFactories

protected

A container storing all the factories for the widgets supported by this screen.

Definition at line 165 of file screen.h.

WidgetContainer Mezzanine::UI::Screen::Widgets

protected

A container storing all the created Widgets owned by this screen.

Definition at line 168 of file screen.h.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/screen.h
• /home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/screen.cpp