CYIGridLayoutConfig Class Reference

Detailed Description

A class used to hold per-child layout configuration for CYIGridLayout layouts.

See also

CYIGridLayout

#include <layout/YiGridLayout.h>

Inheritance diagram for CYIGridLayoutConfig:

Public Member Functions
	CYIGridLayoutConfig ()
virtual	~CYIGridLayoutConfig ()
virtual void	ConfigureFrom (const IYIPropertiesSource *pSource) override
void	SetCellWidth (uint32_t uWidth)
uint32_t	GetCellWidth () const
void	SetCellHeight (uint32_t uHeight)
uint32_t	GetCellHeight () const
Public Member Functions inherited from CYIAnimatingLayoutConfig
	CYIAnimatingLayoutConfig ()
virtual	~CYIAnimatingLayoutConfig ()
void	SetAnimatePosition (bool bAnimatePosition)
	Sets whether position layout animations should be applied to this node. More...
bool	IsUsingAnimatedPosition () const
void	SetAnimateSize (bool bAnimateSize)
	Sets whether size position animations should be applied to this node. More...
bool	IsUsingAnimatedSize () const
Public Member Functions inherited from CYILayoutConfig
	CYILayoutConfig ()
virtual	~CYILayoutConfig ()
void	SetSizeConstraints (const SizeConstraints &sizeConstraints)
const SizeConstraints &	GetSizeConstraints () const
void	SetMargin (const Margin &margin)
const Margin &	GetMargin () const
void	SetLayoutable (bool bLayoutable)
bool	IsLayoutable () const
void	SetItemGravity (const glm::vec3 &vItemGravity)
void	SetItemGravity (GRAVITY eItemGravity)
const glm::vec3 &	GetItemGravity () const
void	SetIsBackground (bool bBackground)
bool	IsBackground () const
Public Member Functions inherited from CYIScriptableRTTIObject
	CYIScriptableRTTIObject ()
virtual	~CYIScriptableRTTIObject ()
virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const override
Public Member Functions inherited from CYIScriptableObject
	CYIScriptableObject ()
	CYIScriptableObject (const CYIScriptableObject &other)
CYIScriptableObject &	operator= (const CYIScriptableObject &other)
virtual	~CYIScriptableObject ()
CYIBindingImplementation *	GetBindingImplementation () const
void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)

Protected Attributes
uint32_t	m_uCellWidth
uint32_t	m_uCellHeight
Protected Attributes inherited from CYIAnimatingLayoutConfig
bool	m_bAnimatePosition
bool	m_bAnimateSize

Additional Inherited Members
Public Types inherited from CYILayoutConfig
enum	GRAVITY {   GRAVITY_NONE,   GRAVITY_CENTER,   GRAVITY_LEFT,   GRAVITY_RIGHT,   GRAVITY_TOP,   GRAVITY_BOTTOM,   GRAVITY_FRONT,   GRAVITY_BACK,   GRAVITY_TOP_LEFT,   GRAVITY_TOP_RIGHT,   GRAVITY_BOTTOM_LEFT,   GRAVITY_BOTTOM_RIGHT }
typedef CubeOffset	Margin
Static Public Member Functions inherited from CYILayoutConfig
static void	RemoveSuffixFromNumber (CYIString &inOutNumber, CYIString &outSuffix)
static bool	ParseBooleanValue (const CYIString &value)
static float	ParseFloatValue (const CYIString &value)
static uint32_t	ParseTimeValue (const CYIString &value)
static float	ParseLengthValue (const CYIString &length)
static glm::vec3	ReadGravityFrom (const CYIString &key, const IYIPropertiesSource *pSource, const glm::vec3 &vDefault)
static glm::vec3	GetGravityVectorFor (GRAVITY eGravity)
Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo *, const void * >	GetRuntimeTypeInfoWithObject () const =0

Constructor & Destructor Documentation

CYIGridLayoutConfig::CYIGridLayoutConfig

(

)

virtual CYIGridLayoutConfig::~CYIGridLayoutConfig ( )

virtual

Member Function Documentation

virtual void CYIGridLayoutConfig::ConfigureFrom ( const IYIPropertiesSource *  pSource )

overridevirtual

Extracts configuration properties from properties source pSource (typically a scene node) and assigns them to this object.

Note

Subclasses should override this method. Remember to call the parent ConfigureFrom function.

Reimplemented from CYIAnimatingLayoutConfig.

uint32_t CYIGridLayoutConfig::GetCellHeight

(

)

const

uint32_t CYIGridLayoutConfig::GetCellWidth

(

)

const

void CYIGridLayoutConfig::SetCellHeight

(

uint32_t

uHeight

)

Sets the cell height to uHeight. The cell height indicates how many cells that the associated node takes up, vertically, in the grid.

Note

A values of 0 is not supported and would be replaced by a value of 1.

void CYIGridLayoutConfig::SetCellWidth

(

uint32_t

uWidth

)

Sets the cell width to uWidth. The cell width indicates how many cells that the associated node takes up, horizontally, in the grid.

Note

A values of 0 is not supported and would be replaced by a value of 1.

Member Data Documentation

uint32_t CYIGridLayoutConfig::m_uCellHeight

protected

uint32_t CYIGridLayoutConfig::m_uCellWidth

protected

---

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

• layout/YiGridLayout.h