LayoutComponent Class Reference

A component class used for layout. More...

#include <UILayoutComponent.h>

Inheritance diagram for LayoutComponent:

Public Types
enum	HorizontalEdge { None, Left, Right, Center }
	Horizontal dock position type. More...
enum	VerticalEdge { None, Bottom, Top, Center }
	Vertical dock position type. More...

Public Member Functions
	LayoutComponent ()
	Default constructor. More...
	LayoutComponent ()
	Default constructor. More...
	LayoutComponent ()
	Default constructor. More...
	~LayoutComponent ()
	Default destructor. More...
	~LayoutComponent ()
	Default destructor. More...
virtual bool	init () override
local	init ()
	CREATE_FUNC (LayoutComponent)
	Create a LayoutComponent instance with default settings. More...
	CREATE_FUNC ( var LayoutComponent)
	Create a LayoutComponent instance with default settings. More...
	CREATE_FUNC ( local LayoutComponent)
	Create a LayoutComponent instance with default settings. More...
void	setUsingPercentContentSize (bool isUsed)
	Percent content size is used to adapt node's content size based on parent's content size. More...
bool	getUsingPercentContentSize () const
	Query whether use percent content size or not. More...
local	getUsingPercentContentSize ()
	Query whether use percent content size or not. More...
void	setPercentContentSize (const Vec2 &percent)
	Set percent content size. More...
local	setPercentContentSize ( local percent)
	Set percent content size. More...
Vec2	getPercentContentSize () const
	Query the percent content size value. More...
var	getPercentContentSize ()
	Query the percent content size value. More...
local	getPercentContentSize ()
	Query the percent content size value. More...
const Point &	getAnchorPosition () const
	Query the anchor position. More...
local	getAnchorPosition ()
	Query the anchor position. More...
void	setAnchorPosition (const Point &point)
	Change the anchor position to it's parent. More...
var	setAnchorPosition ( var point)
	Change the anchor position to it's parent. More...
local	setAnchorPosition ( local point)
	Change the anchor position to it's parent. More...
const Point &	getPosition () const
	Query the owner's position. More...
local	getPosition ()
	Query the owner's position. More...
void	setPosition (const Point &position)
	Change the position of component owner. More...
var	setPosition ( var position)
	Change the position of component owner. More...
local	setPosition ( local position)
	Change the position of component owner. More...
bool	isPositionPercentXEnabled () const
	Whether position percentX is enabled or not. More...
local	isPositionPercentXEnabled ()
	Whether position percentX is enabled or not. More...
void	setPositionPercentXEnabled (bool isUsed)
	Toggle position percentX enabled. More...
float	getPositionPercentX () const
	Query the position percent X value. More...
void	setPositionPercentX (float percentMargin)
	Change position percent X value. More...
var	setPositionPercentX ( var percentMargin)
	Change position percent X value. More...
local	setPositionPercentX ( local percentMargin)
	Change position percent X value. More...
bool	isPositionPercentYEnabled () const
	Whether position percentY is enabled or not. More...
void	setPositionPercentYEnabled (bool isUsed)
	Toggle position percentY enabled. More...
float	getPositionPercentY () const
	Query the position percentY Y value. More...
void	setPositionPercentY (float percentMargin)
	Change position percentY value. More...
local	setPositionPercentY ( local percentMargin)
	Change position percentY value. More...
HorizontalEdge	getHorizontalEdge () const
	Query element horizontal dock type. More...
local	getHorizontalEdge ()
	Query element horizontal dock type. More...
void	setHorizontalEdge (HorizontalEdge hEage)
	Change element's horizontal dock type. More...
var	setHorizontalEdge ( var hEage)
	Change element's horizontal dock type. More...
local	setHorizontalEdge ( local hEage)
	Change element's horizontal dock type. More...
VerticalEdge	getVerticalEdge () const
	Query element vertical dock type. More...
var	getVerticalEdge ()
	Query element vertical dock type. More...
local	getVerticalEdge ()
	Query element vertical dock type. More...
void	setVerticalEdge (VerticalEdge vEage)
	Change element's vertical dock type. More...
var	setVerticalEdge ( var vEage)
	Change element's vertical dock type. More...
local	setVerticalEdge ( local vEage)
	Change element's vertical dock type. More...
float	getLeftMargin () const
	Query left margin of owner relative to its parent. More...
var	getLeftMargin ()
	Query left margin of owner relative to its parent. More...
local	getLeftMargin ()
	Query left margin of owner relative to its parent. More...
void	setLeftMargin (float margin)
	Change left margin of owner relative to its parent. More...
local	setLeftMargin ( local margin)
	Change left margin of owner relative to its parent. More...
float	getRightMargin () const
	Query the right margin of owner relative to its parent. More...
local	getRightMargin ()
	Query the right margin of owner relative to its parent. More...
void	setRightMargin (float margin)
	Change right margin of owner relative to its parent. More...
local	setRightMargin ( local margin)
	Change right margin of owner relative to its parent. More...
float	getTopMargin () const
	Query the top margin of owner relative to its parent. More...
local	getTopMargin ()
	Query the top margin of owner relative to its parent. More...
void	setTopMargin (float margin)
	Change the top margin of owner relative to its parent. More...
local	setTopMargin ( local margin)
	Change the top margin of owner relative to its parent. More...
float	getBottomMargin () const
	Query the bottom margin of owner relative to its parent. More...
local	getBottomMargin ()
	Query the bottom margin of owner relative to its parent. More...
void	setBottomMargin (float margin)
	Change the bottom margin of owner relative to its parent. More...
local	setBottomMargin ( local margin)
	Change the bottom margin of owner relative to its parent. More...
const Size &	getSize () const
	Query owner's content size. More...
local	getSize ()
	Query owner's content size. More...
void	setSize (const Size &size)
	Change the content size of owner. More...
var	setSize ( var size)
	Change the content size of owner. More...
local	setSize ( local size)
	Change the content size of owner. More...
bool	isPercentWidthEnabled () const
	Query whether percent width is enabled or not. More...
local	isPercentWidthEnabled ()
	Query whether percent width is enabled or not. More...
void	setPercentWidthEnabled (bool isUsed)
	Toggle enable percent width. More...
float	getSizeWidth () const
	Query content size width of owner. More...
void	setSizeWidth (float width)
	Change content size width of owner. More...
var	setSizeWidth ( var width)
	Change content size width of owner. More...
local	setSizeWidth ( local width)
	Change content size width of owner. More...
float	getPercentWidth () const
	Query percent width of owner. More...
void	setPercentWidth (float percentWidth)
	Change percent width of owner. More...
var	setPercentWidth ( var percentWidth)
	Change percent width of owner. More...
local	setPercentWidth ( local percentWidth)
	Change percent width of owner. More...
bool	isPercentHeightEnabled () const
	Query whehter percent height is enabled or not. More...
local	isPercentHeightEnabled ()
	Query whehter percent height is enabled or not. More...
void	setPercentHeightEnabled (bool isUsed)
	Toggle enable percent height. More...
float	getSizeHeight () const
	Query size height of owner. More...
void	setSizeHeight (float height)
	Change size height of owner. More...
var	setSizeHeight ( var height)
	Change size height of owner. More...
local	setSizeHeight ( local height)
	Change size height of owner. More...
float	getPercentHeight () const
	Query percent hieght of owner. More...
local	getPercentHeight ()
	Query percent hieght of owner. More...
void	setPercentHeight (float percentHeight)
	Change percent height value of owner. More...
local	setPercentHeight ( local percentHeight)
	Change percent height value of owner. More...
bool	isStretchWidthEnabled () const
	Query whether stretch width is enabled or not. More...
local	isStretchWidthEnabled ()
	Query whether stretch width is enabled or not. More...
void	setStretchWidthEnabled (bool isUsed)
	Toggle enable stretch width. More...
local	setStretchWidthEnabled ( local isUsed)
	Toggle enable stretch width. More...
bool	isStretchHeightEnabled () const
	Query whether stretch height is enabled or not. More...
local	isStretchHeightEnabled ()
	Query whether stretch height is enabled or not. More...
void	setStretchHeightEnabled (bool isUsed)
	Toggle enable stretch height. More...
void	setPercentOnlyEnabled (bool enable)
	Toggle enable percent only. More...
void	setActiveEnabled (bool enable)
	Toggle active enabled of LayoutComponent's owner. More...
local	setActiveEnabled ( local enable)
	Toggle active enabled of LayoutComponent's owner. More...
void	refreshLayout ()
	Refresh layout of the owner. More...
var	refreshLayout ()
	Refresh layout of the owner. More...
local	refreshLayout ()
	Refresh layout of the owner. More...

Static Public Member Functions
static LayoutComponent *	bindLayoutComponent (Node *node)
	Bind a LayoutComponent to a specified node. More...
var	bindLayoutComponent ( var node)
	Bind a LayoutComponent to a specified node. More...
local	bindLayoutComponent ( local node)
	Bind a LayoutComponent to a specified node. More...

Protected Member Functions
Node *	getOwnerParent ()
var	getOwnerParent ()
local	getOwnerParent ()
void	refreshHorizontalMargin ()
local	refreshHorizontalMargin ()
void	refreshVerticalMargin ()
var	refreshVerticalMargin ()
local	refreshVerticalMargin ()

Protected Attributes
HorizontalEdge	_horizontalEdge
VerticalEdge	_verticalEdge
var	_verticalEdge
local	_verticalEdge
float	_leftMargin
var	_leftMargin
local	_leftMargin
float	_rightMargin
var	_rightMargin
local	_rightMargin
float	_bottomMargin
var	_bottomMargin
local	_bottomMargin
float	_topMargin
var	_topMargin
local	_topMargin
bool	_usingPositionPercentX
var	_usingPositionPercentX
local	_usingPositionPercentX
float	_positionPercentX
var	_positionPercentX
local	_positionPercentX
bool	_usingPositionPercentY
local	_usingPositionPercentY
float	_positionPercentY
var	_positionPercentY
local	_positionPercentY
bool	_usingStretchWidth
local	_usingStretchWidth
bool	_usingStretchHeight
local	_usingStretchHeight
float	_percentWidth
var	_percentWidth
local	_percentWidth
bool	_usingPercentWidth
var	_usingPercentWidth
local	_usingPercentWidth
float	_percentHeight
var	_percentHeight
local	_percentHeight
bool	_usingPercentHeight
var	_usingPercentHeight
local	_usingPercentHeight
bool	_actived
var	_actived
local	_actived
bool	_isPercentOnly
var	_isPercentOnly
local	_isPercentOnly

Detailed Description

A component class used for layout.

The LayoutComponent holds all the data for layouting.

Constructor & Destructor Documentation

LayoutComponent

(

)

Default constructor.

var LayoutComponent

(

)

Default constructor.

local LayoutComponent

(

)

Default constructor.

~LayoutComponent

(

)

Default destructor.

var ~LayoutComponent

(

)

Default destructor.

local ~LayoutComponent

(

)

Default destructor.

Member Function Documentation

static LayoutComponent* bindLayoutComponent ( Node *  node )

static

Bind a LayoutComponent to a specified node.

If the node has already binded a LayoutComponent named __LAYOUT_COMPONENT_NAME, just return the LayoutComponent. Otherwise, create a new LayoutComponent and bind the LayoutComponent to the node.

Parameters

node	A Node* instance pointer.

Returns

The binded LayoutComponent instance pointer.

var bindLayoutComponent ( var  node )

static

Bind a LayoutComponent to a specified node.

If the node has already binded a LayoutComponent named __LAYOUT_COMPONENT_NAME, just return the LayoutComponent. Otherwise, create a new LayoutComponent and bind the LayoutComponent to the node.

Parameters

node	A Node* instance pointer.

Returns

The binded LayoutComponent instance pointer.

local bindLayoutComponent ( local  node )

static

Bind a LayoutComponent to a specified node.

If the node has already binded a LayoutComponent named __LAYOUT_COMPONENT_NAME, just return the LayoutComponent. Otherwise, create a new LayoutComponent and bind the LayoutComponent to the node.

Parameters

node	A Node* instance pointer.

Returns

The binded LayoutComponent instance pointer.

CREATE_FUNC

(

LayoutComponent

)

Create a LayoutComponent instance with default settings.

var CREATE_FUNC

(

var

)

Create a LayoutComponent instance with default settings.

local CREATE_FUNC

(

local

)

Create a LayoutComponent instance with default settings.

const Point& getAnchorPosition

(

)

const

Query the anchor position.

Returns

Anchor position to it's parent

var getAnchorPosition

(

)

Query the anchor position.

Returns

Anchor position to it's parent

local getAnchorPosition

(

)

Query the anchor position.

Returns

Anchor position to it's parent

float getBottomMargin

(

)

const

Query the bottom margin of owner relative to its parent.

Returns

Bottom margin in float.

var getBottomMargin

(

)

Query the bottom margin of owner relative to its parent.

Returns

Bottom margin in float.

local getBottomMargin

(

)

Query the bottom margin of owner relative to its parent.

Returns

Bottom margin in float.

HorizontalEdge getHorizontalEdge

(

)

const

Query element horizontal dock type.

Returns

Horizontal dock type.

var getHorizontalEdge

(

)

Query element horizontal dock type.

Returns

Horizontal dock type.

local getHorizontalEdge

(

)

Query element horizontal dock type.

Returns

Horizontal dock type.

float getLeftMargin

(

)

const

Query left margin of owner relative to its parent.

Returns

Left margin in float.

var getLeftMargin

(

)

Query left margin of owner relative to its parent.

Returns

Left margin in float.

local getLeftMargin

(

)

Query left margin of owner relative to its parent.

Returns

Left margin in float.

Node* getOwnerParent ( )

protected

var getOwnerParent ( )

protected

local getOwnerParent ( )

protected

Vec2 getPercentContentSize

(

)

const

Query the percent content size value.

Returns

Percet (x,y) in Vec2.

var getPercentContentSize

(

)

Query the percent content size value.

Returns

Percet (x,y) in Vec2.

local getPercentContentSize

(

)

Query the percent content size value.

Returns

Percet (x,y) in Vec2.

float getPercentHeight

(

)

const

Query percent hieght of owner.

Returns

Percent height in float.

var getPercentHeight

(

)

Query percent hieght of owner.

Returns

Percent height in float.

local getPercentHeight

(

)

Query percent hieght of owner.

Returns

Percent height in float.

float getPercentWidth

(

)

const

Query percent width of owner.

Returns

percent width in float.

var getPercentWidth

(

)

Query percent width of owner.

Returns

percent width in float.

local getPercentWidth

(

)

Query percent width of owner.

Returns

percent width in float.

const Point& getPosition

(

)

const

Query the owner's position.

Returns

The owner's position.

var getPosition

(

)

Query the owner's position.

Returns

The owner's position.

local getPosition

(

)

Query the owner's position.

Returns

The owner's position.

float getPositionPercentX

(

)

const

Query the position percent X value.

Returns

Position percent X value in float.

var getPositionPercentX

(

)

Query the position percent X value.

Returns

Position percent X value in float.

local getPositionPercentX

(

)

Query the position percent X value.

Returns

Position percent X value in float.

float getPositionPercentY

(

)

const

Query the position percentY Y value.

Returns

Position percent Y value in float.

var getPositionPercentY

(

)

Query the position percentY Y value.

Returns

Position percent Y value in float.

local getPositionPercentY

(

)

Query the position percentY Y value.

Returns

Position percent Y value in float.

float getRightMargin

(

)

const

Query the right margin of owner relative to its parent.

Returns

Right margin in float.

var getRightMargin

(

)

Query the right margin of owner relative to its parent.

Returns

Right margin in float.

local getRightMargin

(

)

Query the right margin of owner relative to its parent.

Returns

Right margin in float.

const Size& getSize

(

)

const

Query owner's content size.

Returns

Owner's content size.

var getSize

(

)

Query owner's content size.

Returns

Owner's content size.

local getSize

(

)

Query owner's content size.

Returns

Owner's content size.

float getSizeHeight

(

)

const

Query size height of owner.

Returns

Size height in float.

var getSizeHeight

(

)

Query size height of owner.

Returns

Size height in float.

local getSizeHeight

(

)

Query size height of owner.

Returns

Size height in float.

float getSizeWidth

(

)

const

Query content size width of owner.

Returns

Content size width in float.

var getSizeWidth

(

)

Query content size width of owner.

Returns

Content size width in float.

local getSizeWidth

(

)

Query content size width of owner.

Returns

Content size width in float.

float getTopMargin

(

)

const

Query the top margin of owner relative to its parent.

Returns

Top margin in float.

var getTopMargin

(

)

Query the top margin of owner relative to its parent.

Returns

Top margin in float.

local getTopMargin

(

)

Query the top margin of owner relative to its parent.

Returns

Top margin in float.

bool getUsingPercentContentSize

(

)

const

Query whether use percent content size or not.

Returns

True if using percent content size, false otherwise.

var getUsingPercentContentSize

(

)

Query whether use percent content size or not.

Returns

True if using percent content size, false otherwise.

local getUsingPercentContentSize

(

)

Query whether use percent content size or not.

Returns

True if using percent content size, false otherwise.

VerticalEdge getVerticalEdge

(

)

const

Query element vertical dock type.

Returns

Vertical dock type.

var getVerticalEdge

(

)

Query element vertical dock type.

Returns

Vertical dock type.

local getVerticalEdge

(

)

Query element vertical dock type.

Returns

Vertical dock type.

virtual bool init ( )

overridevirtual

var init ( )

overridevirtual

local init ( )

overridevirtual

bool isPercentHeightEnabled

(

)

const

Query whehter percent height is enabled or not.

Returns

True if percent height is enabled, false otherwise.

var isPercentHeightEnabled

(

)

Query whehter percent height is enabled or not.

Returns

True if percent height is enabled, false otherwise.

local isPercentHeightEnabled

(

)

Query whehter percent height is enabled or not.

Returns

True if percent height is enabled, false otherwise.

bool isPercentWidthEnabled

(

)

const

Query whether percent width is enabled or not.

Returns

True if percent width is enabled, false, otherwise.

var isPercentWidthEnabled

(

)

Query whether percent width is enabled or not.

Returns

True if percent width is enabled, false, otherwise.

local isPercentWidthEnabled

(

)

Query whether percent width is enabled or not.

Returns

True if percent width is enabled, false, otherwise.

bool isPositionPercentXEnabled

(

)

const

Whether position percentX is enabled or not.

Returns

True if position percertX is enable, false otherwise.

var isPositionPercentXEnabled

(

)

Whether position percentX is enabled or not.

Returns

True if position percertX is enable, false otherwise.

local isPositionPercentXEnabled

(

)

Whether position percentX is enabled or not.

Returns

True if position percertX is enable, false otherwise.

bool isPositionPercentYEnabled

(

)

const

Whether position percentY is enabled or not.

See also

setPositionPercentYEnabled

Returns

True if position percentY is enabled, false otherwise.

var isPositionPercentYEnabled

(

)

Whether position percentY is enabled or not.

See also

setPositionPercentYEnabled

Returns

True if position percentY is enabled, false otherwise.

local isPositionPercentYEnabled

(

)

Whether position percentY is enabled or not.

See also

setPositionPercentYEnabled

Returns

True if position percentY is enabled, false otherwise.

bool isStretchHeightEnabled

(

)

const

Query whether stretch height is enabled or not.

Returns

True if stretch height is enabled, false otherwise.

var isStretchHeightEnabled

(

)

Query whether stretch height is enabled or not.

Returns

True if stretch height is enabled, false otherwise.

local isStretchHeightEnabled

(

)

Query whether stretch height is enabled or not.

Returns

True if stretch height is enabled, false otherwise.

bool isStretchWidthEnabled

(

)

const

Query whether stretch width is enabled or not.

Returns

True if stretch width is enabled, false otherwise.

var isStretchWidthEnabled

(

)

Query whether stretch width is enabled or not.

Returns

True if stretch width is enabled, false otherwise.

local isStretchWidthEnabled

(

)

Query whether stretch width is enabled or not.

Returns

True if stretch width is enabled, false otherwise.

void refreshHorizontalMargin ( )

protected

var refreshHorizontalMargin ( )

protected

local refreshHorizontalMargin ( )

protected

void refreshLayout

(

)

Refresh layout of the owner.

var refreshLayout

(

)

Refresh layout of the owner.

local refreshLayout

(

)

Refresh layout of the owner.

void refreshVerticalMargin ( )

protected

var refreshVerticalMargin ( )

protected

local refreshVerticalMargin ( )

protected

void setActiveEnabled

(

bool

enable

)

Toggle active enabled of LayoutComponent's owner.

Parameters

enable

True if active layout component, false otherwise.

var setActiveEnabled

(

var

enable

)

Toggle active enabled of LayoutComponent's owner.

Parameters

enable

True if active layout component, false otherwise.

local setActiveEnabled

(

local

enable

)

Toggle active enabled of LayoutComponent's owner.

Parameters

enable

True if active layout component, false otherwise.

void setAnchorPosition

(

const Point &

point

)

Change the anchor position to it's parent.

Parameters

point

A value in (x,y) format.

var setAnchorPosition

(

var

point

)

Change the anchor position to it's parent.

Parameters

point

A value in (x,y) format.

local setAnchorPosition

(

local

point

)

Change the anchor position to it's parent.

Parameters

point

A value in (x,y) format.

void setBottomMargin

(

float

margin

)

Change the bottom margin of owner relative to its parent.

Parameters

Margin

in float.

var setBottomMargin

(

var

margin

)

Change the bottom margin of owner relative to its parent.

Parameters

Margin

in float.

local setBottomMargin

(

local

margin

)

Change the bottom margin of owner relative to its parent.

Parameters

Margin

in float.

void setHorizontalEdge

(

HorizontalEdge

hEage

)

Change element's horizontal dock type.

Parameters

hEage

Horizontal dock type

See also

HorizontalEdge

var setHorizontalEdge

(

var

hEage

)

Change element's horizontal dock type.

Parameters

hEage

Horizontal dock type

See also

HorizontalEdge

local setHorizontalEdge

(

local

hEage

)

Change element's horizontal dock type.

Parameters

hEage

Horizontal dock type

See also

HorizontalEdge

void setLeftMargin

(

float

margin

)

Change left margin of owner relative to its parent.

Parameters

margin

Margin in float.

var setLeftMargin

(

var

margin

)

Change left margin of owner relative to its parent.

Parameters

margin

Margin in float.

local setLeftMargin

(

local

margin

)

Change left margin of owner relative to its parent.

Parameters

margin

Margin in float.

void setPercentContentSize

(

const Vec2 &

percent

)

Set percent content size.

The value should be [0-1], 0 means the child's content size will be 0 and 1 means the child's content size is the same as its parents.

Parameters

percent

The percent (x,y) of the node in [0-1] scope.

var setPercentContentSize

(

var

percent

)

Set percent content size.

The value should be [0-1], 0 means the child's content size will be 0 and 1 means the child's content size is the same as its parents.

Parameters

percent

The percent (x,y) of the node in [0-1] scope.

local setPercentContentSize

(

local

percent

)

Set percent content size.

The value should be [0-1], 0 means the child's content size will be 0 and 1 means the child's content size is the same as its parents.

Parameters

percent

The percent (x,y) of the node in [0-1] scope.

void setPercentHeight

(

float

percentHeight

)

Change percent height value of owner.

Parameters

percentHeight

Percent height in float.

var setPercentHeight

(

var

percentHeight

)

Change percent height value of owner.

Parameters

percentHeight

Percent height in float.

local setPercentHeight

(

local

percentHeight

)

Change percent height value of owner.

Parameters

percentHeight

Percent height in float.

void setPercentHeightEnabled

(

bool

isUsed

)

Toggle enable percent height.

Parameters

isUsed

True if percent height is enabled, false otherwise.

var setPercentHeightEnabled

(

var

isUsed

)

Toggle enable percent height.

Parameters

isUsed

True if percent height is enabled, false otherwise.

local setPercentHeightEnabled

(

local

isUsed

)

Toggle enable percent height.

Parameters

isUsed

True if percent height is enabled, false otherwise.

void setPercentOnlyEnabled

(

bool

enable

)

Toggle enable percent only.

Parameters

enable

True if percent only is enabled, false otherwise.

var setPercentOnlyEnabled

(

var

enable

)

Toggle enable percent only.

Parameters

enable

True if percent only is enabled, false otherwise.

local setPercentOnlyEnabled

(

local

enable

)

Toggle enable percent only.

Parameters

enable

True if percent only is enabled, false otherwise.

void setPercentWidth

(

float

percentWidth

)

Change percent width of owner.

Parameters

percentWidth

Percent Width in float.

var setPercentWidth

(

var

percentWidth

)

Change percent width of owner.

Parameters

percentWidth

Percent Width in float.

local setPercentWidth

(

local

percentWidth

)

Change percent width of owner.

Parameters

percentWidth

Percent Width in float.

void setPercentWidthEnabled

(

bool

isUsed

)

Toggle enable percent width.

Parameters

isUsed

True if percent width is enabled, false otherwise.

var setPercentWidthEnabled

(

var

isUsed

)

Toggle enable percent width.

Parameters

isUsed

True if percent width is enabled, false otherwise.

local setPercentWidthEnabled

(

local

isUsed

)

Toggle enable percent width.

Parameters

isUsed

True if percent width is enabled, false otherwise.

void setPosition

(

const Point &

position

)

Change the position of component owner.

Parameters

position

A position in (x,y)

var setPosition

(

var

position

)

Change the position of component owner.

Parameters

position

A position in (x,y)

local setPosition

(

local

position

)

Change the position of component owner.

Parameters

position

A position in (x,y)

void setPositionPercentX

(

float

percentMargin

)

Change position percent X value.

Parameters

percentMargin

Margin in float.

var setPositionPercentX

(

var

percentMargin

)

Change position percent X value.

Parameters

percentMargin

Margin in float.

local setPositionPercentX

(

local

percentMargin

)

Change position percent X value.

Parameters

percentMargin

Margin in float.

void setPositionPercentXEnabled

(

bool

isUsed

)

Toggle position percentX enabled.

Parameters

isUsed

True if enable position percentX, false otherwise.

var setPositionPercentXEnabled

(

var

isUsed

)

Toggle position percentX enabled.

Parameters

isUsed

True if enable position percentX, false otherwise.

local setPositionPercentXEnabled

(

local

isUsed

)

Toggle position percentX enabled.

Parameters

isUsed

True if enable position percentX, false otherwise.

void setPositionPercentY

(

float

percentMargin

)

Change position percentY value.

Parameters

percentMargin

Margin in float.

var setPositionPercentY

(

var

percentMargin

)

Change position percentY value.

Parameters

percentMargin

Margin in float.

local setPositionPercentY

(

local

percentMargin

)

Change position percentY value.

Parameters

percentMargin

Margin in float.

void setPositionPercentYEnabled

(

bool

isUsed

)

Toggle position percentY enabled.

Parameters

isUsed

True if position percentY is enabled, false otherwise.

var setPositionPercentYEnabled

(

var

isUsed

)

Toggle position percentY enabled.

Parameters

isUsed

True if position percentY is enabled, false otherwise.

local setPositionPercentYEnabled

(

local

isUsed

)

Toggle position percentY enabled.

Parameters

isUsed

True if position percentY is enabled, false otherwise.

void setRightMargin

(

float

margin

)

Change right margin of owner relative to its parent.

Parameters

margin

Margin in float.

var setRightMargin

(

var

margin

)

Change right margin of owner relative to its parent.

Parameters

margin

Margin in float.

local setRightMargin

(

local

margin

)

Change right margin of owner relative to its parent.

Parameters

margin

Margin in float.

void setSize

(

const Size &

size

)

Change the content size of owner.

Parameters

size	Content size in

See also

Size.

var setSize

(

var

size

)

Change the content size of owner.

Parameters

size	Content size in

See also

Size.

local setSize

(

local

size

)

Change the content size of owner.

Parameters

size	Content size in

See also

Size.

void setSizeHeight

(

float

height

)

Change size height of owner.

Parameters

height

Size height in float.

var setSizeHeight

(

var

height

)

Change size height of owner.

Parameters

height

Size height in float.

local setSizeHeight

(

local

height

)

Change size height of owner.

Parameters

height

Size height in float.

void setSizeWidth

(

float

width

)

Change content size width of owner.

Parameters

width

Content size width in float.

var setSizeWidth

(

var

width

)

Change content size width of owner.

Parameters

width

Content size width in float.

local setSizeWidth

(

local

width

)

Change content size width of owner.

Parameters

width

Content size width in float.

void setStretchHeightEnabled

(

bool

isUsed

)

Toggle enable stretch height.

Parameters

isUsed

True if stretch height is enabled, false otherwise.

var setStretchHeightEnabled

(

var

isUsed

)

Toggle enable stretch height.

Parameters

isUsed

True if stretch height is enabled, false otherwise.

local setStretchHeightEnabled

(

local

isUsed

)

Toggle enable stretch height.

Parameters

isUsed

True if stretch height is enabled, false otherwise.

void setStretchWidthEnabled

(

bool

isUsed

)

Toggle enable stretch width.

Parameters

isUsed

True if enable stretch width, false otherwise.

var setStretchWidthEnabled

(

var

isUsed

)

Toggle enable stretch width.

Parameters

isUsed

True if enable stretch width, false otherwise.

local setStretchWidthEnabled

(

local

isUsed

)

Toggle enable stretch width.

Parameters

isUsed

True if enable stretch width, false otherwise.

void setTopMargin

(

float

margin

)

Change the top margin of owner relative to its parent.

Parameters

margin

Margin in float.

var setTopMargin

(

var

margin

)

Change the top margin of owner relative to its parent.

Parameters

margin

Margin in float.

local setTopMargin

(

local

margin

)

Change the top margin of owner relative to its parent.

Parameters

margin

Margin in float.

void setUsingPercentContentSize

(

bool

isUsed

)

Percent content size is used to adapt node's content size based on parent's content size.

If set to true then node's content size will be changed based on the value setted by

Parameters

isUsed

True to enable percent content size, false otherwise.

var setUsingPercentContentSize

(

var

isUsed

)

Percent content size is used to adapt node's content size based on parent's content size.

If set to true then node's content size will be changed based on the value setted by

Parameters

isUsed

True to enable percent content size, false otherwise.

local setUsingPercentContentSize

(

local

isUsed

)

Percent content size is used to adapt node's content size based on parent's content size.

If set to true then node's content size will be changed based on the value setted by

Parameters

isUsed

True to enable percent content size, false otherwise.

void setVerticalEdge

(

VerticalEdge

vEage

)

Change element's vertical dock type.

Parameters

vEage

Vertical dock type

See also

VerticalEdge.

var setVerticalEdge

(

var

vEage

)

Change element's vertical dock type.

Parameters

vEage

Vertical dock type

See also

VerticalEdge.

local setVerticalEdge

(

local

vEage

)

Change element's vertical dock type.

Parameters

vEage

Vertical dock type

See also

VerticalEdge.

Member Data Documentation

bool _actived

protected

var _actived

protected

local _actived

protected

float _bottomMargin

protected

var _bottomMargin

protected

local _bottomMargin

protected

HorizontalEdge _horizontalEdge

protected

var _horizontalEdge

protected

local _horizontalEdge

protected

bool _isPercentOnly

protected

var _isPercentOnly

protected

local _isPercentOnly

protected

float _leftMargin

protected

var _leftMargin

protected

local _leftMargin

protected

float _percentHeight

protected

var _percentHeight

protected

local _percentHeight

protected

float _percentWidth

protected

var _percentWidth

protected

local _percentWidth

protected

float _positionPercentX

protected

var _positionPercentX

protected

local _positionPercentX

protected

float _positionPercentY

protected

var _positionPercentY

protected

local _positionPercentY

protected

float _rightMargin

protected

var _rightMargin

protected

local _rightMargin

protected

float _topMargin

protected

var _topMargin

protected

local _topMargin

protected

bool _usingPercentHeight

protected

var _usingPercentHeight

protected

local _usingPercentHeight

protected

bool _usingPercentWidth

protected

var _usingPercentWidth

protected

local _usingPercentWidth

protected

bool _usingPositionPercentX

protected

var _usingPositionPercentX

protected

local _usingPositionPercentX

protected

bool _usingPositionPercentY

protected

var _usingPositionPercentY

protected

local _usingPositionPercentY

protected

bool _usingStretchHeight

protected

var _usingStretchHeight

protected

local _usingStretchHeight

protected

bool _usingStretchWidth

protected

var _usingStretchWidth

protected

local _usingStretchWidth

protected

VerticalEdge _verticalEdge

protected

var _verticalEdge

protected

local _verticalEdge

protected

---

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

• /Users/minggo/SourceCode/cocos2d-x/cocos/ui/UILayoutComponent.h