Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::UI::VerticalLayoutStrategy Class Reference

This is a specialization of a layout strategy where a group of quads are sized and placed in a linear sequence along the Y axis. More...

#include <verticallayoutstrategy.h>

+ Inheritance diagram for Mezzanine::UI::VerticalLayoutStrategy:
+ Collaboration diagram for Mezzanine::UI::VerticalLayoutStrategy:

Public Member Functions

 VerticalLayoutStrategy ()
 Class constructor.
 
virtual ~VerticalLayoutStrategy ()
 Class destructor.
 
virtual void Layout (const Rect &OldSelfRect, const Rect &NewSelfRect, const ChildContainer &ChildQuads)
 Updates the dimensions of a collection of QuadRenderables. More...
 
- Public Member Functions inherited from Mezzanine::UI::LayoutStrategy
 LayoutStrategy ()
 Class constructor.
 
virtual ~LayoutStrategy ()
 Class destructor.
 
virtual void CheckChildAspectRatio (const Vector2 &OldChildSize, Vector2 &NewChildSize, QuadRenderable *Child)
 Preserves a child's aspect ratio if it is configured to do so. More...
 
virtual void ClampChildToMaxSize (const Rect &NewSelfRect, Vector2 &NewChildSize, QuadRenderable *Child)
 Clamps the updated size to the set maximum size for the child quad. More...
 
virtual void ClampChildToMinSize (const Rect &NewSelfRect, Vector2 &NewChildSize, QuadRenderable *Child)
 Clamps the updated size to the set minimum size for the child quad. More...
 
virtual Real HandleChildHorizontalPositioning (const Rect &OldSelfRect, const Rect &NewSelfRect, const Vector2 &NewChildSize, QuadRenderable *Child)
 Handles the positioning of a child on the X axis. More...
 
virtual Real HandleChildHorizontalSizing (const Rect &OldSelfRect, const Rect &NewSelfRect, const Real PrevAxisResult, QuadRenderable *Child)
 Handles the sizing of a child on the X axis. More...
 
virtual Vector2 HandleChildPositioning (const Rect &OldSelfRect, const Rect &NewSelfRect, const Vector2 &NewChildSize, QuadRenderable *Child)
 Handles the positioning of a child that needs it's dimensions updated. More...
 
virtual Vector2 HandleChildSizing (const Rect &OldSelfRect, const Rect &NewSelfRect, QuadRenderable *Child)
 Handles the sizing of a child that needs it's dimensions updated. More...
 
virtual Real HandleChildVerticalPositioning (const Rect &OldSelfRect, const Rect &NewSelfRect, const Vector2 &NewChildSize, QuadRenderable *Child)
 Handles the positioning of a child on the Y axis. More...
 
virtual Real HandleChildVerticalSizing (const Rect &OldSelfRect, const Rect &NewSelfRect, const Real PrevAxisResult, QuadRenderable *Child)
 Handles the sizing of a child on the Y axis. More...
 

Additional Inherited Members

- Public Types inherited from Mezzanine::UI::LayoutStrategy
typedef std::vector< Widget * > ChildContainer
 Basic container type for QuadRenderable storage by this class.
 
typedef ChildContainer::iterator ChildIterator
 Iterator type for QuadRenderable instances stored by this class.
 
typedef ChildContainer::const_iterator ConstChildIterator
 Const Iterator type for QuadRenderable instances stored by this class.
 

Detailed Description

This is a specialization of a layout strategy where a group of quads are sized and placed in a linear sequence along the Y axis.

Definition at line 53 of file verticallayoutstrategy.h.

Member Function Documentation

void Mezzanine::UI::VerticalLayoutStrategy::Layout ( const Rect OldSelfRect,
const Rect NewSelfRect,
const ChildContainer ChildQuads 
)
virtual

Updates the dimensions of a collection of QuadRenderables.

Parameters
OldSelfRectThe pre-update dimensions of the calling quad.
NewSelfRectThe post-update dimensions of the calling quad.
ChildQuadsA container of all the Quads to be updated by this strategy.

Reimplemented from Mezzanine::UI::LayoutStrategy.

Definition at line 63 of file verticallayoutstrategy.cpp.


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