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

This is a helper class designed to describe the behaviors of a quad when it needs to be repositioned. More...

#include <positioninginfo.h>

+ Collaboration diagram for Mezzanine::UI::PositioningInfo:

Public Member Functions

 PositioningInfo ()
 Class constructor.
 
 PositioningInfo (const Whole HRules, const Whole VRules)
 PositionFlags constructor. More...
 
 PositioningInfo (const UnifiedVec2 &Position)
 Position constructor. More...
 
 PositioningInfo (const Whole HRules, const Whole VRules, const UnifiedVec2 &Position)
 Descriptive constructor. More...
 
 PositioningInfo (const PositioningInfo &Other)
 Copy constructor. More...
 
 ~PositioningInfo ()
 Class destructor.
 
Boole operator!= (const PositioningInfo &Other) const
 Inequality comparison operator. More...
 
Boole operator== (const PositioningInfo &Other) const
 Equality comparison operator. More...
 
void ProtoDeSerialize (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite this object with it. More...
 
void ProtoSerialize (XML::Node &ParentNode) const
 Convert this class to an XML::Node ready for serialization. More...
 

Static Public Member Functions

static String GetSerializableName ()
 Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...
 

Public Attributes

Whole HorizontalRules
 Rules for determining the position of a quad on the X axis.
 
UnifiedVec2 UPosition
 Unified dimensions to be used if the resize rules permits it.
 
Whole VerticalRules
 Rules for determining the position of a quad on the Y axis.
 

Detailed Description

This is a helper class designed to describe the behaviors of a quad when it needs to be repositioned.

This struct contains all the information necessary to define complete behavior of positioning child quads within a quad.

Definition at line 56 of file positioninginfo.h.

Constructor & Destructor Documentation

Mezzanine::UI::PositioningInfo::PositioningInfo ( const Whole  HRules,
const Whole  VRules 
)
inline

PositionFlags constructor.

Parameters
HRulesThe rules for determining the position of an object on the X axis during a transform update.
VRulesThe rules for determining the position of an object on the Y axis during a transform update.

Definition at line 78 of file positioninginfo.h.

Mezzanine::UI::PositioningInfo::PositioningInfo ( const UnifiedVec2 Position)
inline

Position constructor.

Parameters
PositionThe unified position to use if the rules permit it.

Definition at line 82 of file positioninginfo.h.

Mezzanine::UI::PositioningInfo::PositioningInfo ( const Whole  HRules,
const Whole  VRules,
const UnifiedVec2 Position 
)
inline

Descriptive constructor.

Parameters
HRulesThe rules for determining the position of an object on the X axis during a transform update.
VRulesThe rules for determining the position of an object on the Y axis during a transform update.
PositionThe unified position to use if the rules permit it.

Definition at line 88 of file positioninginfo.h.

Mezzanine::UI::PositioningInfo::PositioningInfo ( const PositioningInfo Other)
inline

Copy constructor.

Parameters
OtherThe other PositioningInfo to copy from.

Definition at line 92 of file positioninginfo.h.

Member Function Documentation

static String Mezzanine::UI::PositioningInfo::GetSerializableName ( )
inlinestatic

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 162 of file positioninginfo.h.

Boole Mezzanine::UI::PositioningInfo::operator!= ( const PositioningInfo Other) const
inline

Inequality comparison operator.

Parameters
OtherThe other PositioningInfo to compare to.
Returns
Returns true if these PositioningInfo's are not equal, false otherwise.

Definition at line 111 of file positioninginfo.h.

Boole Mezzanine::UI::PositioningInfo::operator== ( const PositioningInfo Other) const
inline

Equality comparison operator.

Parameters
OtherThe other PositioningInfo to compare to.
Returns
Returns true if these PositioningInfo's are equal, false otherwise.

Definition at line 106 of file positioninginfo.h.

void Mezzanine::UI::PositioningInfo::ProtoDeSerialize ( const XML::Node SelfRoot)
inline

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

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

Definition at line 137 of file positioninginfo.h.

void Mezzanine::UI::PositioningInfo::ProtoSerialize ( XML::Node ParentNode) const
inline

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

Parameters
ParentNodeThe point in the XML hierarchy that all this renderable should be appended to.

Definition at line 119 of file positioninginfo.h.


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