BlackTopp Studios inc
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 Boole( | 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::vector< 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::vector< RenderLayer * > | RenderLayerContainer |
| Basic container type for RenderLayer storage by this class. | |
| typedef std::vector< 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 > | |||
| Boole | _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 > | |||
| Boole | _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 &RendName) | ||
| Creates a Button. More... | |||
| virtual Button * | CreateButton (const String &RendName, const UnifiedRect &RendRect) | ||
| Creates a Button. More... | |||
| virtual CheckBox * | CreateCheckBox (const String &RendName) | ||
| Creates a CheckBox. More... | |||
| virtual CheckBox * | CreateCheckBox (const String &RendName, const UnifiedRect &RendRect) | ||
| Creates a CheckBox. More... | |||
| virtual DropDownList * | CreateDropDownList (const String &RendName, const UI::ScrollbarStyle Style) | ||
| Creates a DropDownList. More... | |||
| virtual DropDownList * | CreateDropDownList (const String &RendName, const UnifiedRect &RendRect, const UI::ScrollbarStyle Style) | ||
| Creates a DropDownList. More... | |||
| virtual EditBox * | CreateEditBox (const String &RendName, const RenderLayerType EditLayerType, FontData *EditFont) | ||
| Creates a EditBox. More... | |||
| virtual EditBox * | CreateEditBox (const String &RendName, const RenderLayerType EditLayerType, const String &EditFontName) | ||
| Creates a EditBox. More... | |||
| virtual EditBox * | CreateEditBox (const String &RendName, const UnifiedRect &RendRect, const RenderLayerType EditLayerType, FontData *EditFont) | ||
| Creates a EditBox. More... | |||
| virtual EditBox * | CreateEditBox (const String &RendName, const UnifiedRect &RendRect, const RenderLayerType EditLayerType, const String &EditFontName) | ||
| Creates a EditBox. More... | |||
| virtual GridContainer * | CreateGridContainer (const String &RendName) | ||
| Creates a widget container for the placement of widgets on a 2D grid. More... | |||
| virtual GridContainer * | CreateGridContainer (const String &RendName, const UnifiedRect &RendRect) | ||
| Creates a widget container for the placement of widgets on a 2D grid. 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 &RendName, const UI::ScrollbarStyle Style) | ||
| Creates a Scrollbar aligned on the X axis. More... | |||
| virtual HorizontalScrollbar * | CreateHorizontalScrollbar (const String &RendName, const UnifiedRect &RendRect, const UI::ScrollbarStyle Style) | ||
| Creates a Scrollbar aligned on the X axis. More... | |||
| virtual ListBox * | CreateListBox (const String &RendName, const UI::ScrollbarStyle Style) | ||
| Creates a ListBox. More... | |||
| virtual ListBox * | CreateListBox (const String &RendName, const UnifiedRect &RendRect, const UI::ScrollbarStyle Style) | ||
| Creates a ListBox. More... | |||
| virtual MenuEntry * | CreateMenuEntry (const String &RendName) | ||
| Creates a MenuEntry. More... | |||
| virtual MenuEntry * | CreateMenuEntry (const String &RendName, const UnifiedRect &RendRect) | ||
| Creates a MenuEntry. More... | |||
| virtual RadioButton * | CreateRadioButton (const String &RendName) | ||
| Creates a RadioButton. More... | |||
| virtual RadioButton * | CreateRadioButton (const String &RendName, const UnifiedRect &RendRect) | ||
| Creates a RadioButton. More... | |||
| virtual Spinner * | CreateSpinner (const String &RendName, const SpinnerStyle SpinStyle, FontData *EditFont) | ||
| Creates a Spinner. More... | |||
| virtual Spinner * | CreateSpinner (const String &RendName, const SpinnerStyle SpinStyle, const String &EditFontName) | ||
| Creates a Spinner. More... | |||
| virtual Spinner * | CreateSpinner (const String &RendName, const UnifiedRect &RendRect, const SpinnerStyle SpinStyle, FontData *EditFont) | ||
| Creates a Spinner. More... | |||
| virtual Spinner * | CreateSpinner (const String &RendName, const UnifiedRect &RendRect, const SpinnerStyle SpinStyle, const String &EditFontName) | ||
| Creates a Spinner. More... | |||
| virtual StackButton * | CreateStackButton (const String &RendName) | ||
| Creates a StackButton. More... | |||
| virtual StackButton * | CreateStackButton (const String &RendName, const UnifiedRect &RendRect) | ||
| Creates a MenuButton. More... | |||
| virtual TabSet * | CreateTabSet (const String &RendName) | ||
| Creates a TabSet. More... | |||
| virtual TabSet * | CreateTabSet (const String &RendName, const UnifiedRect &RendRect) | ||
| Creates a TabSet. 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 &RendName, const UI::ScrollbarStyle Style) | ||
| Creates a Scrollbar aligned on the Y axis. More... | |||
| virtual VerticalScrollbar * | CreateVerticalScrollbar (const String &RendName, 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. More... | |||
| virtual Widget * | CreateWidget (const String &TypeName, const String &RendName, const NameValuePairMap &Params) | ||
| Creates a widget based on the provided typename. More... | |||
| virtual Widget * | CreateWidget (const String &TypeName, const String &RendName, const UnifiedRect &RendRect, const NameValuePairMap &Params) | ||
| Creates a widget based on the provided typename. More... | |||
| virtual Widget * | CreateWidget (const String &RendName) | ||
| Creates a generic widget. More... | |||
| virtual Widget * | CreateWidget (const String &RendName, 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 Boole | 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 Boole | 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 (Boole CanSee) | ||
| Sets the visibility of this renderable. More... | |||
| virtual void | Show () | ||
| Forces this renderable to be shown. More... | |||
| Public 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... | |||
| 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 void | _Clean () | ||
| Refreshes the render data of this renderable. 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 | _SetLayoutStrat (LayoutStrategy *ToSet) | ||
| Sets a new LayoutStrategy for this quad to use. 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 | AddLayerToExistingGroup (RenderLayer *Layer, const UInt16 LayerZOrder, const UInt16 GroupID) | ||
| Adds a RenderLayer to the specified group. More... | |||
| void | AddLayerToGroup (RenderLayer *Layer, const UInt16 LayerZOrder, const UInt16 GroupID) | ||
| Adds a RenderLayer to the specified group. More... | |||
| void | AddLayerToGroup (RenderLayer *Layer, const GroupOrderEntry &GroupAndZ) | ||
| Adds a RenderLayer to the specified group. More... | |||
| void | AddLayerToGroups (RenderLayer *Layer, const GroupOrderEntryVector &Entrys) | ||
| Adds a RenderLayer to multiple groups. More... | |||
| virtual Boole | 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... | |||
| MultiImageLayer * | CreateMultiImageLayer () | ||
| Creates an MultiImageLayer for this renderable. More... | |||
| MultiImageLayer * | CreateMultiImageLayer (const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creates an MultiImageLayer for this renderable. More... | |||
| MultiImageLayer * | CreateMultiImageLayer (const GroupOrderEntry &GroupAndZ) | ||
| Creates an MultiImageLayer for this renderable and adds it to a RenderLayerGroup. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer () | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const GroupOrderEntry &GroupAndZ) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const String &FontName) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const String &FontName, const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const String &FontName, const GroupOrderEntry &GroupAndZ) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| RenderLayerGroup * | CreateOrRetrieveRenderLayerGroup (const UInt16 GroupID) | ||
| Gets the named RenderLayerGroup or creates one with the specified ID if it does not exist. More... | |||
| RenderLayerGroup * | CreateRenderLayerGroup (const UInt16 GroupID) | ||
Creates a new RenderLayerGroup that can have.
| |||
| SingleImageLayer * | CreateSingleImageLayer () | ||
| Creates a SingleImageLayer for this renderable. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creates a SingleImageLayer for this renderable. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const GroupOrderEntry &GroupAndZ) | ||
| Creates a SingleImageLayer for this renderable and adds it to a RenderLayerGroup. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const String &SpriteName) | ||
| Creates a SingleImageLayer for this renderable. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const String &SpriteName, const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creates a SingleImageLayer for this renderable. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const String &SpriteName, const GroupOrderEntry &GroupAndZ) | ||
| Creates a SingleImageLayer for this renderable and adds it to a RenderLayerGroup. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer () | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const GroupOrderEntry &GroupAndZ) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const String &FontName) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const String &FontName, const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const String &FontName, const GroupOrderEntry &GroupAndZ) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| virtual void | DestroyAllChildren () | ||
| Destroys all child Widgets currently inside this QuadRenderable. | |||
| void | DestroyAllRenderLayerGroups () | ||
| Destroy's all RenderLayerGroups being stored/managed by this QuadRenderable. | |||
| void | DestroyAllRenderLayers () | ||
| Destroys all RenderLayers being stored by this renderable. | |||
| virtual void | DestroyChild (Widget *ToBeDestroyed) | ||
| Destroys a child Widget currently inside this QuadRenderable. More... | |||
| void | DestroyRenderLayer (RenderLayer *ToBeDestroyed) | ||
| Destroys a RenderLayer being stored by this renderable. More... | |||
| void | DestroyRenderLayerGroup (const UInt16 GroupID) | ||
| Destroy's a RenderLayerGroup by ID. 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 UI::AspectRatioLock | GetAspectRationLock () const | ||
| Gets how (and if) the aspect ratio of this quad is locked. 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... | |||
| Widget * | GetClosestChild (Widget *Child) | ||
| Gets a pointer to the child of this QuadRenderable that is storing a child, or another quad that is. More... | |||
| virtual UInt16 | GetHighestChildZOrder () const | ||
| Gets the highest ZOrder among the children of this QuadRenderable. More... | |||
| virtual Whole | GetHorizontalPositioningRules () const | ||
| Gets the current behavior this quad will follow when it is positioned automatically on the X axis. More... | |||
| virtual Whole | 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 UInt16 | GetLowestChildZOrder () const | ||
| Gets the lowest ZOrder among the children of this QuadRenderable. More... | |||
| virtual Boole | 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 Boole | GetMousePassthrough () const | ||
| Gets whether or not Mouse Passthrough is enabled. More... | |||
| QuadRenderable * | GetNextSibling (Boole 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... | |||
| QuadRenderable * | GetPrevSibling (Boole 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... | |||
| RenderLayer * | GetRenderLayer (const Whole Which, const UI::RenderLayerType Type) | ||
| Gets a RenderLayer belonging to this QuadRenderable by it's type. More... | |||
| RenderLayerGroup * | GetRenderLayerGroup (const UInt16 GroupID) const | ||
| Gets a RenderLayerGroup by ID. More... | |||
| virtual const SizingInfo & | GetSizingPolicy () const | ||
| Gets the current behavior this QuadRenderable will use when it is sized. More... | |||
| 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 Whole | GetVerticalPositioningRules () const | ||
| Gets the current behavior this quad will follow when it is positioned automatically on the Y axis. More... | |||
| virtual Whole | 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 Boole | IsChildOfScreen () const | ||
| Gets whether or not this QuadRenderable is a direct child of it's screen. More... | |||
| virtual Boole | IsInside (const Vector2 &Point) const | ||
| Checks to see if a point in 2D space is inside this quad. More... | |||
| Boole | IsVertexCachingEnabled () const | ||
| Gets whether or not vertex caching is enabled for this Quad. More... | |||
| virtual void | PopulateTextLinesInLayers (const Real MaxWidth) | ||
| Populates all text lines in all text layers owned by 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. More... | |||
| virtual void | RemoveChild (Widget *ToBeRemoved) | ||
| Removes a child Widget from this quadrenderable. More... | |||
| void | RemoveLayerFromAllGroups (RenderLayer *Layer) | ||
| Removes a single RenderLayer from all RenderLayerGroups owned by this QuadRenderable. More... | |||
| void | RemoveLayerFromGroup (RenderLayer *Layer, const UInt16 GroupID) | ||
| 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... | |||
| Boole | RenderLayerGroupExists (const UInt16 GroupID) const | ||
| Checks to see if a RenderLayerGroup exists. More... | |||
| void | SetActiveGroup (const UInt16 GroupID) | ||
| 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 | SetAspectRatioLock (const UI::AspectRatioLock Lock) | ||
| Sets how (and if) the aspect ratio of this quad is locked. More... | |||
| virtual void | SetHorizontalPositioningRules (const Whole Rules) | ||
| Sets the behavior this quad will have when it is positioned automatically on the X axis. More... | |||
| virtual void | SetHorizontalSizingRules (const Whole Rules) | ||
| Sets the behavior this quad will have on the X axis when it is resized. More... | |||
| void | SetLocalVertexCaching (Boole Enable) | ||
| Enables or disables caching of vertex's belonging to this and all child renderables. More... | |||
| virtual void | SetManualTransformUpdates (Boole 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 (Boole 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 | 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 | SetVerticalPositioningRules (const Whole Rules) | ||
| Sets the behavior this quad will have when it is positioned automatically on the Y axis. More... | |||
| virtual void | SetVerticalSizingRules (const Whole 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 | UpdateChildOrder () | ||
| Updates the order of children in this QuadRenderable based on the ZOrder set on each child. | |||
| 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 | |||
| Boole | _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... | |||
| Boole | IsScreen () const | ||
| Gets whether or not this renderable is a Screen. More... | |||
| Boole | IsWidget () const | ||
| Gets whether or not this renderable is a Widget. More... | |||
Static Public Member Functions | |
| template<typename Callback > | |
| static Boole | _ProcessAllChildren (Widget *Wid, Callback *CB) |
| Processes all children of this screen by their zorder. More... | |
| template<typename Callback > | |
| static Boole | _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.
| |||
| 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.
| |||
| 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 | |||
| void | AppendLayerVertices (std::vector< VertexData > &Vertices) | ||
| Adds all the vertices belonging to all the layers of this renderable to the provided vector. More... | |||
| RenderLayerGroup * | CreateRenderLayerGroupNoCheck (const UInt16 ID) | ||
| Creates a new RenderLayerGroup with the provided ID, without checking if it is unique. 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... | |
| Boole | 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... | |
| Boole | ManualTransformUpdates |
| Controls whether or not this Quad and it's children will recieve automatic transform updates. More... | |
| Boole | 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... | |
| 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 | |
| Boole | 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... | |
| Boole | Visible |
| Stores whether this Renderable is to be rendered (also dependent on parent visibility). More... | |
Friends | |
| class | Mezzanine::UI::UIManager |
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.
|
protected |
Internal constructor.
| 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 191 of file screen.cpp.
XML constructor.
| XMLNode | The node of the xml document to construct from. |
| Manager | A pointer to the UI manager creating this screen. |
Definition at line 226 of file screen.cpp.
|
virtual |
Tells this QuadRenderable that all of it's layers are dirty.
Reimplemented from Mezzanine::UI::QuadRenderable.
Definition at line 1013 of file screen.cpp.
|
virtual |
Marks this renderable as dirty, and informs other renderables if needed.
Reimplemented from Mezzanine::UI::QuadRenderable.
Definition at line 1007 of file screen.cpp.
|
inline |
| void Mezzanine::UI::Screen::_RenderScreen | ( | ) |
Manually calls the UI system to render this screen.
Definition at line 1022 of file screen.cpp.
| void Mezzanine::UI::Screen::_RenderVertices | ( | bool | Force = false | ) |
Prepares all vertices for rendering to the screen.
| Force | Whether or not to force preparation regardless of if they need it. |
Definition at line 1094 of file screen.cpp.
|
inline |
| void Mezzanine::UI::Screen::_SetOrientation | ( | const Mezzanine::OrientationMode & | Mode | ) |
Forces an orientation mode change for this screen.
| Mode | The orientation mode to be applied to the UI on this screen. |
Definition at line 1068 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.
| 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 1077 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.
| ToBeAdded | The widget factory to be added. |
Definition at line 442 of file screen.cpp.
Verifies uniqueness of a widget and inserts it if it is.
| If | a widget with the same name already exists in this Screen, a II_DUPLICATE_IDENTITY_EXCEPTION will be thrown. |
| ToInsert | The widget to be verified and inserted. |
Definition at line 283 of file screen.cpp.
Creates a Button.
| RendName | The name to be given to this Button. |
Definition at line 630 of file screen.cpp.
|
virtual |
Creates a CheckBox.
| RendName | The name of the CheckBox. |
Definition at line 672 of file screen.cpp.
|
virtual |
|
virtual |
Creates a DropDownList.
| RendName | The name to be given to this DropDownList. |
| Style | An enum value representing how the scrollbar child of the ListBox will be constructed. See UI::ScrollbarStyle enum for more info. |
Definition at line 812 of file screen.cpp.
|
virtual |
Creates a DropDownList.
| RendName | The name to be given to this DropDownList. |
| RendRect | The rect describing this DropDownList's transform relative to it's parent. |
| Style | An enum value representing how the scrollbar child of the ListBox will be constructed. See UI::ScrollbarStyle enum for more info. |
Definition at line 819 of file screen.cpp.
|
virtual |
Creates a EditBox.
| RendName | The name of the EditBox. |
| EditLayerType | The type of text layer to be auto-created for editing. |
| EditFont | A pointer to the font to be used by the edit layer. |
Definition at line 686 of file screen.cpp.
|
virtual |
Creates a EditBox.
| RendName | The name of the EditBox. |
| EditLayerType | The type of text layer to be auto-created for editing. |
| EditFontName | The name of the font to be used by the edit layer. |
Definition at line 693 of file screen.cpp.
|
virtual |
Creates a EditBox.
| RendName | The name of the EditBox. |
| RendRect | The Rect representing the position and size of the EditBox. |
| EditLayerType | The type of text layer to be auto-created for editing. |
| EditFont | A pointer to the font to be used by the edit layer. |
Definition at line 700 of file screen.cpp.
|
virtual |
Creates a EditBox.
| RendName | The name of the EditBox. |
| RendRect | The Rect representing the position and size of the EditBox. |
| EditLayerType | The type of text layer to be auto-created for editing. |
| EditFontName | The name of the font to be used by the edit layer. |
Definition at line 707 of file screen.cpp.
|
virtual |
Creates a widget container for the placement of widgets on a 2D grid.
| RendName | The name to be given to this renderable. |
Definition at line 854 of file screen.cpp.
|
virtual |
Creates a widget container for the placement of widgets on a 2D grid.
| RendName | The name to be given to this renderable. |
| RendRect | The rect describing this widget's transform relative to it's parent. |
Definition at line 861 of file screen.cpp.
|
virtual |
Creates a widget container aligned on the X axis.
| RendName | The name to be given to this renderable. |
Definition at line 826 of file screen.cpp.
|
virtual |
Creates a widget container aligned on the X axis.
| RendName | The name to be given to this renderable. |
| RendRect | The rect describing this widget's transform relative to it's parent. |
Definition at line 833 of file screen.cpp.
|
virtual |
Creates a Scrollbar aligned on the X axis.
| RendName | The name of the HorizontalScrollbar. |
| Style | The style of scrollbar you want to create, see Scrollbar documentation for more details. |
Definition at line 714 of file screen.cpp.
|
virtual |
Creates a Scrollbar aligned on the X axis.
| RendName | 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. |
Definition at line 721 of file screen.cpp.
|
virtual |
|
virtual |
Creates a ListBox.
| RendName | The name to be given to this ListBox. |
| RendRect | The rect describing this ListBox's transform relative to it's parent. |
| Style | The style of scrollbar you want to create, see Scrollbar documentation for more details. |
Definition at line 805 of file screen.cpp.
Creates a MenuEntry.
| RendName | The name to be given to this MenuEntry. |
Definition at line 770 of file screen.cpp.
|
virtual |
|
virtual |
Creates a RadioButton.
| RendName | The name to be given to this RadioButton. |
Definition at line 658 of file screen.cpp.
|
virtual |
Creates a RadioButton.
| RendName | The name to be given to this RadioButton. |
| RendRect | The rect describing this RadioButton's transform relative to it's parent. |
Definition at line 665 of file screen.cpp.
|
virtual |
|
virtual |
|
virtual |
Creates a Spinner.
| RendName | The name of the Spinner. |
| RendRect | The Rect representing the position and size of the Spinner. |
| SpinStyle | The layout of buttons this Spinner will have. |
| EditFont | A pointer to the font to be used by the edit layer. |
Definition at line 756 of file screen.cpp.
|
virtual |
Creates a Spinner.
| RendName | The name of the Spinner. |
| RendRect | The Rect representing the position and size of the Spinner. |
| SpinStyle | The layout of buttons this Spinner will have. |
| EditFontName | The name of the font to be used by the edit layer. |
Definition at line 763 of file screen.cpp.
|
virtual |
Creates a StackButton.
| RendName | The name to be given to this StackButton. |
Definition at line 644 of file screen.cpp.
|
virtual |
Creates a MenuButton.
| RendName | The name to be given to this StackButton. |
| RendRect | The rect describing this StackButton's transform relative to it's parent. |
Definition at line 651 of file screen.cpp.
Creates a TabSet.
| RendName | The name to be given to this TabSet. |
Definition at line 784 of file screen.cpp.
|
virtual |
|
protectedvirtual |
Creates a new Vertex Buffer for vertices generated by the UI system.
| InitialSize | The amount of space to allocate for the initial buffer, in number of vertices. |
Definition at line 302 of file screen.cpp.
|
virtual |
Creates a widget container aligned on the Y axis.
| RendName | The name to be given to this renderable. |
Definition at line 840 of file screen.cpp.
|
virtual |
Creates a widget container aligned on the Y axis.
| RendName | The name to be given to this renderable. |
| RendRect | The rect describing this widget's transform relative to it's parent. |
Definition at line 847 of file screen.cpp.
|
virtual |
Creates a Scrollbar aligned on the Y axis.
| RendName | The name of the VerticalScrollbar. |
| Style | The style of scrollbar you want to create, see Scrollbar documentation for more details. |
Definition at line 728 of file screen.cpp.
|
virtual |
Creates a Scrollbar aligned on the Y axis.
| RendName | 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. |
Definition at line 735 of file screen.cpp.
Creates a widget from an XML::Node.
| This | method will throw an exception if the WidgetNode is not named after a known widget. |
| WidgetNode | The XML node populated with data needed to construct a widget. |
Definition at line 542 of file screen.cpp.
|
virtual |
Creates a widget based on the provided typename.
| TypeName | The class name of the widget to be created. |
| RendName | The unique instance name to be given to the widget. |
| Params | A NameValuePairMap containing the params to be applied during construction. |
Definition at line 553 of file screen.cpp.
|
virtual |
Creates a widget based on the provided typename.
| TypeName | The class name of the widget to be created. |
| RendName | The unique instance name to be given to the widget. |
| RendRect | The dimensions that will be assigned to the created Widget. |
| Params | A NameValuePairMap containing the params to be applied during construction. |
Definition at line 563 of file screen.cpp.
Creates a generic widget.
| RendName | The name to be given to this Widget. |
Definition at line 616 of file screen.cpp.
|
virtual |
Creates a generic widget.
| RendName | The name to be given to this Widget. |
| RendRect | The rect describing this Widget's transform relative to it's parent. |
Definition at line 623 of file screen.cpp.
| void Mezzanine::UI::Screen::DestroyAllWidgetFactories | ( | ) |
Destroys all widget factories in this Screen.
Definition at line 474 of file screen.cpp.
|
protectedvirtual |
Destroys the Vertex Buffer storing all the UI vertices generated by this screen.
Definition at line 332 of file screen.cpp.
|
virtual |
Destroys a widget.
| ToBeDestroyed | Pointer to the widget you want destroyed. |
Definition at line 585 of file screen.cpp.
| void Mezzanine::UI::Screen::DestroyWidgetFactory | ( | WidgetFactory * | ToBeDestroyed | ) |
Removes and destroys a widget factory in this Screen.
| 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.
| ImplName | The name of the widget implementation created by the factory to be removed and destroyed. |
Definition at line 465 of file screen.cpp.
Gets the quad the mouse is over if any.
| MousePos | The current mouse position. |
Definition at line 422 of file screen.cpp.
| TextureAtlas * Mezzanine::UI::Screen::GetAtlas | ( | const String & | Atlas | ) | const |
Gets an atlas that has been loaded.
| Atlas | The name of the Atlas to retrieve, usually stored as a filename. |
Definition at line 895 of file screen.cpp.
|
virtual |
Gets the most derived serializable name of this Renderable.
Reimplemented from Mezzanine::UI::QuadRenderable.
Definition at line 998 of file screen.cpp.
Gets the specified FontData from an Atlas.
| FontName | The name of the Font to retrieve. |
| Atlas | The name of the atlas to check the specified FontData for. |
Definition at line 889 of file screen.cpp.
|
virtual |
Gets the UIManager this screen belongs to.
Definition at line 401 of file screen.cpp.
| MarkupParser * Mezzanine::UI::Screen::GetMarkupParser | ( | const String & | ParserName | ) | const |
Gets a MarkupParser by it's registered name.
| ParserName | The name of the MarkupParser to retrieve. |
Definition at line 910 of file screen.cpp.
|
virtual |
Gets the mouse position from the last call to "FindHoveredQuad(const Vector2&).
Definition at line 434 of file screen.cpp.
|
virtual |
Gets the MouseHoverStrategy currently being used by this screen.
Definition at line 417 of file screen.cpp.
|
virtual |
Gets the number of widgets being used in this screen.
Definition at line 580 of file screen.cpp.
|
virtual |
Gets the currently set primary atlas.
Definition at line 880 of file screen.cpp.
|
virtual |
Gets the type of renderable this is.
Implements Mezzanine::UI::Renderable.
Definition at line 379 of file screen.cpp.
|
protectedvirtual |
Gets a pointer to the SceneManager connected to this screens viewport.
Definition at line 257 of file screen.cpp.
|
static |
Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized.
Definition at line 1001 of file screen.cpp.
Gets a sprite from an Atlas.
| SpriteName | The name of the sprite to retrieve. |
| Atlas | The name of the Atlas to get the sprite from. |
Definition at line 886 of file screen.cpp.
| Real Mezzanine::UI::Screen::GetTexelOffsetX | ( | ) | const |
Gets the X axis Texel Offset for the current rendersystem.
Definition at line 898 of file screen.cpp.
| Real Mezzanine::UI::Screen::GetTexelOffsetY | ( | ) | const |
Gets the Y axis Texel Offset for the current rendersystem.
Definition at line 901 of file screen.cpp.
Gets the texture size of the specified Atlas.
| Atlas | The name of the atlas to get the texture size of. |
Definition at line 892 of file screen.cpp.
|
virtual |
Gets the Viewport this screen is currently rendering to.
Definition at line 398 of file screen.cpp.
|
virtual |
Gets the current viewport dimensions.
Definition at line 382 of file screen.cpp.
|
virtual |
Gets the visibility setting of this renderable.
Implements Mezzanine::UI::Renderable.
Definition at line 367 of file screen.cpp.
Gets the position of the white pixel from an Atlas.
| Atlas | The name of the Atlas to get the white pixel from. |
Definition at line 883 of file screen.cpp.
Gets a widget in this screen by name.
| Name | The name of the widget to get. |
Definition at line 573 of file screen.cpp.
|
protectedvirtual |
Gets a registered WidgetFactory that creates the specified type of widget.
| If | a widget factor of the specified widget type isn't registered then a II_IDENTITY_NOT_FOUND_EXCEPTION will be thrown. |
| WidgetTypeName | The name of the widget type to retrieve the factory for. |
Definition at line 273 of file screen.cpp.
|
virtual |
Forces this renderable to hide.
Implements Mezzanine::UI::Renderable.
Definition at line 376 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.
| ParserName | The name of the MarkupParser to check for. |
Definition at line 907 of file screen.cpp.
|
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().
Implements Mezzanine::UI::Renderable.
Definition at line 370 of file screen.cpp.
|
protectedvirtual |
Sets up all the necessary projection and world matrices for UI rendering.
Definition at line 292 of file screen.cpp.
|
virtual |
Take the data stored in an XML Node and overwrite the properties of this object with it.
| SelfRoot | An XML::Node containing the data to populate this class with. |
Reimplemented from Mezzanine::UI::QuadRenderable.
Definition at line 937 of file screen.cpp.
|
virtual |
Convert the properties of this class to an XML::Node ready for serialization.
| SelfRoot | The root node containing all the serialized data for this instance. |
Reimplemented from Mezzanine::UI::QuadRenderable.
Definition at line 916 of file screen.cpp.
| void Mezzanine::UI::Screen::RemoveWidgetFactory | ( | WidgetFactory * | ToBeRemoved | ) |
Removes a widget factory from this Screen.
| 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.
| ImplName | The name of the widget implementation created by the factory to be removed. |
Definition at line 452 of file screen.cpp.
|
protectedvirtual |
Resizes the Vertex Buffer.
| RequestedSize | The new size for the existing buffer. |
Definition at line 339 of file screen.cpp.
|
virtual |
Sets the strategy to use when detect which object the mouse is hovered over.
| Strategy | A pointer to the strategy to use. |
Definition at line 407 of file screen.cpp.
|
virtual |
Sets the Atlas to be assumed when one isn't provided for atlas related tasks.
| Atlas | The name of the atlas to be used. |
Definition at line 877 of file screen.cpp.
|
virtual |
Sets the visibility of this renderable.
| CanSee | Boole determining whether or not this renderable should be visible. |
Implements Mezzanine::UI::Renderable.
Definition at line 364 of file screen.cpp.
|
virtual |
Forces this renderable to be shown.
Implements Mezzanine::UI::Renderable.
Definition at line 373 of file screen.cpp.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
1.8.9.1. Thanks to the
Open Icon Library
for help with some of the icons.
