Detailed Description

A CYILinearLayout that always uses a 'vertical' orientation.

See also: CYILinearLayout

#include <layout/YiColumnLayout.h>

Inheritance diagram for CYIColumnLayout:

[legend]

Public Member Functions
	CYIColumnLayout ()

virtual	~CYIColumnLayout ()

Public Member Functions inherited from CYILinearLayout
	CYILinearLayout ()

virtual	~CYILinearLayout ()

void	SetSpacing (float fSpacing)

float	GetSpacing () const

void	SetJustify (bool bJustify)

bool	IsUsingJustify () const

void	SetOrientation (ORIENTATION eOrientation)

ORIENTATION	GetOrientation () const

void	SetOverflowMode (OVERFLOW_MODE eMode)

OVERFLOW_MODE	GetOverflowMode () const

void	SetLineGravity (LINE_GRAVITY eLineGravity)

LINE_GRAVITY	GetLineGravity () const

Public Member Functions inherited from CYIAnimatingLayout
	CYIAnimatingLayout ()

virtual	~CYIAnimatingLayout ()

void	DisableAnimationsOnNextLayout (bool bDisable=true)

void	DisableAnimationsOnNextLayoutFor (CYISceneNode *pChild, bool bDisable=true)

virtual void	ChildAdded (CYISceneNode *pChild) override

virtual void	ChildRemoved (CYISceneNode *pChild) override

virtual void	ChildVisibilityChanged (CYISceneNode *pChild) override

void	SetMovingTime (uint32_t uMovingTimeMs)

uint32_t	GetMovingTimeMs () const

void	SetSizingTime (uint32_t uSizingTimeMs)

uint32_t	GetSizingTimeMs () const

void	SetTimeInterpolator (std::unique_ptr< CYITimeInterpolator > pInterpolator)

CYITimeInterpolator *	GetTimeInterpolator ()

const CYITimeInterpolator *	GetTimeInterpolator () const

Public Member Functions inherited from CYILayout
	CYILayout ()

virtual	~CYILayout ()

void	AttachTo (CYISceneView *pView)

void	ConfigureFromAttachedNode ()

void	DetachFromNode ()

CYISceneNode *	GetAssociatedSceneNode () const

void	Measure (const CYISceneNode::MeasureSpec &widthSpec, const CYISceneNode::MeasureSpec &heightSpec, const CYISceneNode::MeasureSpec &depthSpec)

void	ApplyMeasurements ()

void	SetPositioningMode (POSITIONING_MODE ePositioningMode)

POSITIONING_MODE	GetPositioningMode () const

void	SetPadding (const Padding &padding)

const Padding &	GetPadding () const

void	SetUseReverseChildrenOrder (bool bUseReverseChildrenOrder)

bool	IsUsingReverseChildrenOrder () const

void	SetGravity (const glm::vec3 &vLayoutGravity)

void	SetGravity (CYILayoutConfig::GRAVITY eGravity)

const glm::vec3 &	GetGravity () 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 Member Functions
virtual void	Configure () override

Protected Member Functions inherited from CYILinearLayout
virtual void	OnMeasure (const CYISceneNode::MeasureSpec &widthSpec, const CYISceneNode::MeasureSpec &heightSpec, const CYISceneNode::MeasureSpec &depthSpec) override

virtual void	OnApplyMeasurements () override

Protected Member Functions inherited from CYIAnimatingLayout
virtual void	OnMeasurementsApplied () override

virtual const CYIRuntimeTypeInfo &	GetLayoutConfigType () const override

virtual void	ApplyPosition (CYISceneNode *pChild, const glm::vec3 &vPosition) override

virtual void	ApplySize (CYISceneNode *pChild, const glm::vec3 &vSize) override

Protected Member Functions inherited from CYILayout
virtual void	OnSceneViewAttached ()

virtual void	OnMeasurementsCalculated (const CYISceneNode::MeasureSpec &widthSpec, const CYISceneNode::MeasureSpec &heightSpec, const CYISceneNode::MeasureSpec &depthSpec)

virtual std::unique_ptr< CYILayoutState >	CreateLayoutStateInstance () const

void	CreateLayoutObjectsFor (CYISceneNode *pNode) const

CYISceneNode *	GetChild (uint32_t uIndex) const

void	ApplyMeasurementsToBackgroundChildren ()

const Padding &	GetPaddingForChild (const CYISceneNode *pChild) const

Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo , const void >	GetRuntimeTypeInfoWithObject () const =0

Additional Inherited Members
Public Types inherited from CYILinearLayout
enum	ORIENTATION { ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, ORIENTATION_SHAFT }

enum	OVERFLOW_MODE { OVERFLOW_IGNORE, OVERFLOW_OFFSCREEN, OVERFLOW_WRAP, OVERFLOW_WRAP_AND_MOVE_OFFSCREEN }

enum	LINE_GRAVITY { LINE_GRAVITY_DEFAULT, LINE_GRAVITY_START, LINE_GRAVITY_MIDDLE, LINE_GRAVITY_END, LINE_GRAVITY_JUSTIFY }

Public Types inherited from CYILayout
enum	POSITIONING_MODE { SET_POSITION_DIRECTLY, DO_NOT_SET_POSITION_DIRECTLY }

typedef CYILayoutConfig::CubeOffset	Padding

Static Public Member Functions inherited from CYILayout
static void	RegisterAllLayouts ()

static bool	IsLayoutable (const CYISceneNode *pNode)

static glm::vec3	GetDefaultSize (const CYISceneNode *pNode, const CYISceneNode::MeasureSpec &widthSpec, const CYISceneNode::MeasureSpec &heightSpec, const CYISceneNode::MeasureSpec &depthSpec)

static void	UpdateMeasuredSizeForFitContent (const CYISceneNode pNode, glm::vec3 pMeasuredSize, const glm::vec3 &contentSize, const Padding &padding, const CYISceneNode::MeasureSpec &widthSpec, const CYISceneNode::MeasureSpec &heightSpec, const CYISceneNode::MeasureSpec &depthSpec)

static void	UnscaleMeasureSpecs (const glm::vec3 &vScale, CYISceneNode::MeasureSpec pWidthSpec, CYISceneNode::MeasureSpec pHeightSpec, CYISceneNode::MeasureSpec *pDepthSpec)

static float	CalculateDimension (const CYISceneNode::MeasureSpec &spec, const CYILayoutConfig::SizeConstraint &constraint, float fCurrentValue)

Protected Types inherited from CYILayout
enum	DIMENSIONS { DIMENSIONS_NONE = 0x0, DIMENSIONS_X = 0x1, DIMENSIONS_Y = 0x2, DIMENSIONS_Z = 0x4, DIMENSIONS_ALL_BUT_X = DIMENSIONS_Y \| DIMENSIONS_Z, DIMENSIONS_ALL_BUT_Y = DIMENSIONS_X \| DIMENSIONS_Z, DIMENSIONS_ALL_BUT_Z = DIMENSIONS_X \| DIMENSIONS_Y, DIMENSIONS_ALL = DIMENSIONS_X \| DIMENSIONS_Y \| DIMENSIONS_Z }

Static Protected Member Functions inherited from CYILayout
static void	MeasureChildWithMargins (CYISceneNode *pChild, const CYISceneNode::MeasureSpec &parentWidthSpec, const CYISceneNode::MeasureSpec &parentHeightSpec, const CYISceneNode::MeasureSpec &parentDepthSpec, const Padding &padding)

static void	MeasureChildWithMargins (CYISceneNode *pChild, const CYISceneNode::MeasureSpec &parentWidthSpec, const CYISceneNode::MeasureSpec &parentHeightSpec, const CYISceneNode::MeasureSpec &parentDepthSpec, const Padding &padding, const glm::vec3 &vChildScale)

static CYISceneNode::MeasureSpec	CalculateChildMeasureSpec (const CYISceneNode::MeasureSpec &parentMeasureSpec, float fPadding, const CYILayoutConfig::SizeConstraint &childConstraint, float fChildScale)

static bool	UpdateMeasureSpecsForFitContent (const CYISceneNode pNode, CYISceneNode::MeasureSpec widthSpec, CYISceneNode::MeasureSpec heightSpec, CYISceneNode::MeasureSpec depthSpec)

static void	RemeasureChildrenForFillParent (const CYISceneNode *pNode, const glm::vec3 &vParentMeasuredSize, const Padding &padding, DIMENSIONS eDimensionsToRemeasure)

static glm::vec3	GetAdjustedPosition (const glm::vec3 &vDesiredTopLeftPosition, const CYISceneNode *pChild)

static glm::vec3	GetUnadjustedPosition (const glm::vec3 &vCurrentTopLeftPosition, const CYISceneNode *pChild)

static glm::vec3	GetAdjustedMeasuredSize (const CYISceneNode *pChild)

static glm::vec3	GetTopLeftPositionWithGravity (const glm::vec3 &vLayoutGravity, const glm::vec3 &vChildGravity, const glm::vec3 &vContainerTopLeft, const glm::vec3 &vContainerSize, const CYILayout::Padding &padding, const glm::vec3 &vChildSize, const CYILayoutConfig::Margin &margin, const glm::vec3 &vCurrentChildPosition)

static void	MeasureBackgroundChildren (CYISceneNode *pNode, const glm::vec3 &vSize)

Protected Attributes inherited from CYILinearLayout
float	m_fSpacing

bool	m_bJustify

ORIENTATION	m_eOrientation

OVERFLOW_MODE	m_eOverflowMode

LINE_GRAVITY	m_eLineGravity

Protected Attributes inherited from CYILayout
CYISceneView *	m_pNode
	In most cases, this variable is used as a node (thus the name m_pNode ) More...

Padding	m_padding

bool	m_bReverseChildrenOrder

glm::vec3	m_vGravity

POSITIONING_MODE	m_ePositioningMode

Constructor & Destructor Documentation

CYIColumnLayout::CYIColumnLayout ( )

virtual CYIColumnLayout::~CYIColumnLayout ( )

virtual

Member Function Documentation

virtual void CYIColumnLayout::Configure ( )

overrideprotectedvirtual

Extracts relevant properties the associated scene node and configures this layout with said properties.

Note: Subclasses should override this method if they have custom configuration values. Remember to call the parent Configure function.

Reimplemented from CYILinearLayout.

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

layout/YiColumnLayout.h

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation