Detailed Description

A linear layout that switches between horizontal and vertical orientations based on a configurable condition.

Instances of this layout implement a linear layout that switches between horizontal and vertical orientations based on a condition. The available conditions are detailed in the Condition section.

By default, the x and y components of the configured gravity value are flipped when the condition is detected as having changed. For example, if the original 'gravity' value of the layout is 'left' and the orientation changes to vertical, the gravity value will be modified to 'top'. If this is undesirable, the SetFlipGravityOnConditionChange() function can be used to disable automatic modification of the gravity value.

In some cases, it may be desirable to use the 'opposite' orientation than what the selected condition prescribes. For example, the condition may imply a 'vertical' orientation but a 'horizontal' orientation is preferred. In those cases, the SetUseInvertCondition() function can be used to cause the opposite orientation to be used.

This layout respects the padding layout configuration option and the margin per-node layout configuration option.

Container View Template Comments Specification

These values are applied to the comment field of the container composition. All properties are optional.

Label	Default value	Accepted values	Description
condition	surface	special*	The condition which determines which orientation the linear layout should use. See the Condition section for details.
flip-gravity	true	true, false	If true, the gravity layout value is flipped when the condition is detected as having changed. If false, the gravity layout value remains unchanged.
invert-condition	false	true, false	If true, conditions that would normally result in a horizontal orientation will instead result in a vertical orientation (and vice-versa).

The parent layout class may define more properties that can be used.

See also: CYILinearLayout

Children View Template Comments Specification

This class has no configurable per-child properties, except for those of the parent class.

See also: CYILinearLayout

Condition

The condition configured on this layout is used to determine which orientation the layout should be in. The following table lists the available conditions, along with a short description of each.

Enum Value	Template Comment Values	Description
CYIAutoLinearLayout::SURFACE	surface	The current surface determines the orientation.
CYIAutoLinearLayout::MEASURE_SPEC	measure-spec	The measure specs received through the CYILayout::Measure function determines the orientation.
CYIAutoLinearLayout::PROGRAMMATIC	programmatic	The orientation is specified manually through the CYILinearLayout::SetOrientation function.

Surface Condition

When the CYIAutoLinearLayout::SURFACE condition is selected, the current surface is used to determine the layout orientation. If the surface's height is larger than its width, the CYILinearLayout::ORIENTATION_VERTICAL orientation is used. Otherwise, the CYILinearLayout::ORIENTATION_HORIZONTAL is used.

Measure Spec Condition

When the CYIAutoLinearLayout::MEASURE_SPEC condition is selected, the measure specs received through the CYILayout::Measure function are used to determine the orientation. The measure specs received by the CYILayout::Measure function may be fixed (e.g. if the parent of the associated scene node does not have a layout applied to it), or may be dynamic. The measure specs may also be CYISceneNode::MEASURE_UNSPECIFIED (in the case where the parent of the associated scene node has a layout and is configured to 'fit content').

When neither the width nor the height measure specs are CYISceneNode::MEASURE_UNSPECIFIED, the two measure spec sizes are compared to determine the layout orientation. If the height is larger than the width, the CYILinearLayout::ORIENTATION_VERTICAL orientation is used. Otherwise, the CYILinearLayout::ORIENTATION_HORIZONTAL is used.

Note: The layout constraints set on the associated scene view may affect the width and height used to determine the layout orientation. For example, if a width measure spec of 100.0f is received and a height measure spec of 200.0f is received but the associated scene view has a configured maximum height constraint of 50.0f set, then the resulting layout orientation will be CYILinearLayout::ORIENTATION_HORIZONTAL.

If the width measure spec is CYISceneNode::MEASURE_UNSPECIFIED and the height measure spec is not, the CYILinearLayout::ORIENTATION_HORIZONTAL is used. If the height measure spec is CYISceneNode::MEASURE_UNSPECIFIED and the width measure spec is not, the CYILinearLayout::ORIENTATION_VERTICAL is used. If both the width measure spec and the height measure spec are CYISceneNode::MEASURE_UNSPECIFIED, the size constraints are used to determine the orientation. When no constraints are set, the resulting orientation is CYILinearLayout::ORIENTATION_HORIZONTAL.

Note: When both the width measure spec and the height measure spec are CYISceneNode::MEASURE_UNSPECIFIED but the depth measure spec is not CYISceneNode::MEASURE_UNSPECIFIED, the resulting orientation is CYILinearLayout::ORIENTATION_SHAFT. This is the only case where the shaft orientation is used.

Programmatic Condition

When the CYIAutoLinearLayout::PROGRAMMATIC condition is selected, the orientation of the layout is not modified by the layout itself. Users can use the CYILinearLayout::SetOrientation() function to set the layout to a specific orientation.

Note: Calling CYILinearLayout::SetOrientation() does not cause the layout to be dirtied. The CYISceneNode::RequestLayout() function should be called on the associated scene view when the CYILinearLayout::SetOrientation() function is called with a new orientation.; When the CYIAutoLinearLayout::PROGRAMMATIC condition is used, the configured 'use inverted condition' flag (as set through the SetUseInvertCondition() function) is ignored.

See also: CYILinearLayout

#include <layout/YiAutoLinearLayout.h>

Inheritance diagram for CYIAutoLinearLayout:

[legend]

Public Types
enum	CONDITION { SURFACE, MEASURE_SPEC, PROGRAMMATIC }

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

Public Member Functions
	CYIAutoLinearLayout ()

virtual	~CYIAutoLinearLayout ()

void	SetCondition (CONDITION eCondition)

CONDITION	GetCondition () const

void	SetFlipGravityOnConditionChange (bool bFlipGravity)

bool	IsFlippingGravityOnConditionChange () const

void	SetUseInvertedCondition (bool bUseInvertedCondition)

bool	IsUsingInvertedCondition () const

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)

Public Member Functions inherited from CYISignalHandler
	CYISignalHandler ()

	CYISignalHandler (const CYISignalHandler &rSignalHandler)

virtual	~CYISignalHandler ()

CYISignalHandler &	operator= (const CYISignalHandler &rSignalHandler)

void	MoveToThread (CYIThread *pThread)
	This function allows the user to override the default thread affinity to any CYIThread that may or may not be running. More...

CYIThreadHandle	GetThreadAffinity () const

void	SetThreadAffinity (const CYIThreadHandle &rThreadAffinity)

virtual bool	IsConnected () const

virtual bool	IsConnected (const CYISignalBase &rSignal) const

void	Disconnect (CYISignalBase &rSignal)

void	DisconnectFromAllSignals ()

Public Member Functions inherited from CYIThread::Listener
	Listener ()

virtual	~Listener ()

virtual void	OnThreadStarted (CYIThread *)

virtual void	OnThreadTerminated (CYIThread *)

virtual void	OnThreadFinished (CYIThread *)

Protected Member Functions
virtual void	Configure () override

virtual void	OnSceneViewAttached () override

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

Protected Member Functions inherited from CYILinearLayout
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	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

Protected Attributes
CONDITION	m_eCondition

bool	m_bFlipGravityOnConditionChange

bool	m_bInvertCondition

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

Additional Inherited Members
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)

Member Enumeration Documentation

enum CYIAutoLinearLayout::CONDITION

A condition used to determine the orientation used by a CYIAutoLinearLayout.

Enumerator
SURFACE	Use the current surface's dimensions to determine the orientation.
MEASURE_SPEC	Use the measure specs received by the layout to determine the orientation.
PROGRAMMATIC	Use the user-specified orientation value.

Constructor & Destructor Documentation

CYIAutoLinearLayout::CYIAutoLinearLayout ( )

virtual CYIAutoLinearLayout::~CYIAutoLinearLayout ( )

virtual

Member Function Documentation

virtual void CYIAutoLinearLayout::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.

CONDITION CYIAutoLinearLayout::GetCondition ( ) const

See also: SetCondition

bool CYIAutoLinearLayout::IsFlippingGravityOnConditionChange ( ) const

See also: SetFlipGravityOnConditionChange

bool CYIAutoLinearLayout::IsUsingInvertedCondition ( ) const

See also: SetUseInvertedCondition

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

overrideprotectedvirtual

Measures the associated scene node, considering its layout configuration constraints (if available) and the provided measure specifications.

Warning: Implementations of this function are required to ensure that the Measure function of each child scene node is called at least once, even if those children are hidden or are non-laid-out.

Note: Typically, if OnMeasure is overridden then OnApplyMeasurements must also be overridden.

See also: CYILayout::Measure

Reimplemented from CYILinearLayout.

virtual void CYIAutoLinearLayout::OnSceneViewAttached ( )

overrideprotectedvirtual

A function called after a scene view has been attached to this layout.

Reimplemented from CYILayout.

void CYIAutoLinearLayout::SetCondition ( CONDITION eCondition )

Sets the condition used by this layout to determine its orientation to eCondition. By default, the condition is CYIAutoLinearLayout::SURFACE.

void CYIAutoLinearLayout::SetFlipGravityOnConditionChange ( bool bFlipGravity )

When bFlipGravity is true, the components of this layout's gravity are flipped when the condition is detected as having changed. When bFlipGravity is false, the gravity value is left unmodified. By default, the components of this layout's gravity are flipped when the condition is detected as having changed.

See also: SetCondition

void CYIAutoLinearLayout::SetUseInvertedCondition ( bool bUseInvertedCondition )

When bUseInvertedCondition is true, the condition values that would normally result in an CYILinearLayout::ORIENTATION_HORIZONTAL orientation instead result in an CYILinearLayout::ORIENTATION_VERTICAL orientation, and vice versa. By default, the condition values are not inverted.

Note: This flag has no effect when the condition is CYIAutoLinearLayout::PROGRAMMATIC.

Member Data Documentation

bool CYIAutoLinearLayout::m_bFlipGravityOnConditionChange

protected

bool CYIAutoLinearLayout::m_bInvertCondition

protected

CONDITION CYIAutoLinearLayout::m_eCondition

protected

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

layout/YiAutoLinearLayout.h

Detailed Description

Container View Template Comments Specification

Children View Template Comments Specification

Condition

Surface Condition

Measure Spec Condition

Programmatic Condition

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation