Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
LayoutComponent Class Reference

A component class used for layout. More...

Inherits Component.

Public Types

enum  HorizontalEdge
 Horizontal dock position type.
 
enum  VerticalEdge
 Vertical dock position type.
 

Public Member Functions

 LayoutComponent ()
 Default constructor. More...
 
 ~LayoutComponent ()
 Default destructor. More...
 
 CREATE_FUNC (LayoutComponent)
 Create a LayoutComponent instance with default settings.
 
 CREATE_FUNC ( var LayoutComponent)
 Create a LayoutComponent instance with default settings.
 
 CREATE_FUNC ( local LayoutComponent)
 Create a LayoutComponent instance with default settings.
 
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 PointgetAnchorPosition () 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 PointgetPosition () 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...
 
var isPositionPercentXEnabled ()
 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...
 
var getPositionPercentX ()
 Query the position percent X value. More...
 
local getPositionPercentX ()
 Query the position percent X value. More...
 
void setPositionPercentX (float 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...
 
local setPositionPercentYEnabled ( local 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...
 
var isPercentWidthEnabled ()
 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...
 
local getPercentWidth ()
 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 whether percent height is enabled or not. More...
 
local isPercentHeightEnabled ()
 Query whether 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 height 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.
 
local refreshLayout ()
 Refresh layout of the owner.
 

Static Public Member Functions

static LayoutComponentbindLayoutComponent (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...
 

Detailed Description

A component class used for layout.

The LayoutComponent holds all the data for layouting.

Constructor & Destructor Documentation

Default constructor.

var LayoutComponent ( )

Default constructor.

local new ( )

Default constructor.

Default destructor.

var ~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
nodeA 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
nodeA 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
nodeA Node* instance pointer.
Returns
The binded LayoutComponent instance pointer.
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 set by

See also
setPercentContentSize
Parameters
isUsedTrue 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 set by

See also
setPercentContentSize
Parameters
isUsedTrue 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 set by

See also
setPercentContentSize
Parameters
isUsedTrue to enable percent content size, false otherwise.
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.
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
percentThe 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
percentThe 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
percentThe percent (x,y) of the node in [0-1] scope.
Vec2 getPercentContentSize ( ) const

Query the percent content size value.

Returns
Percent (x,y) in Vec2.
var getPercentContentSize ( )

Query the percent content size value.

Returns
Percent (x,y) in Vec2.
local getPercentContentSize ( )

Query the percent content size value.

Returns
Percent (x,y) in Vec2.
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
void setAnchorPosition ( const Point point)

Change the anchor position to it's parent.

Parameters
pointA value in (x,y) format.
var setAnchorPosition ( var  point)

Change the anchor position to it's parent.

Parameters
pointA value in (x,y) format.
local setAnchorPosition ( local  point)

Change the anchor position to it's parent.

Parameters
pointA value in (x,y) format.
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.
void setPosition ( const Point position)

Change the position of component owner.

Parameters
positionA position in (x,y)
var setPosition ( var  position)

Change the position of component owner.

Parameters
positionA position in (x,y)
local setPosition ( local  position)

Change the position of component owner.

Parameters
positionA position in (x,y)
bool isPositionPercentXEnabled ( ) const

Whether position percentX is enabled or not.

Returns
True if position percentX is enable, false otherwise.
var isPositionPercentXEnabled ( )

Whether position percentX is enabled or not.

Returns
True if position percentX is enable, false otherwise.
local isPositionPercentXEnabled ( )

Whether position percentX is enabled or not.

Returns
True if position percentX is enable, false otherwise.
void setPositionPercentXEnabled ( bool  isUsed)

Toggle position percentX enabled.

Parameters
isUsedTrue if enable position percentX, false otherwise.
var setPositionPercentXEnabled ( var  isUsed)

Toggle position percentX enabled.

Parameters
isUsedTrue if enable position percentX, false otherwise.
local setPositionPercentXEnabled ( local  isUsed)

Toggle position percentX enabled.

Parameters
isUsedTrue if enable position percentX, false otherwise.
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.
void setPositionPercentX ( float  percentMargin)

Change position percent X value.

Parameters
percentMarginMargin in float.
var setPositionPercentX ( var  percentMargin)

Change position percent X value.

Parameters
percentMarginMargin in float.
local setPositionPercentX ( local  percentMargin)

Change position percent X value.

Parameters
percentMarginMargin in float.
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.
void setPositionPercentYEnabled ( bool  isUsed)

Toggle position percentY enabled.

Parameters
isUsedTrue if position percentY is enabled, false otherwise.
var setPositionPercentYEnabled ( var  isUsed)

Toggle position percentY enabled.

Parameters
isUsedTrue if position percentY is enabled, false otherwise.
local setPositionPercentYEnabled ( local  isUsed)

Toggle position percentY enabled.

Parameters
isUsedTrue if position percentY is enabled, false otherwise.
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.
void setPositionPercentY ( float  percentMargin)

Change position percentY value.

Parameters
percentMarginMargin in float.
var setPositionPercentY ( var  percentMargin)

Change position percentY value.

Parameters
percentMarginMargin in float.
local setPositionPercentY ( local  percentMargin)

Change position percentY value.

Parameters
percentMarginMargin 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.
void setHorizontalEdge ( HorizontalEdge  hEage)

Change element's horizontal dock type.

Parameters
hEageHorizontal dock type
See also
HorizontalEdge
var setHorizontalEdge ( var  hEage)

Change element's horizontal dock type.

Parameters
hEageHorizontal dock type
See also
HorizontalEdge
local setHorizontalEdge ( local  hEage)

Change element's horizontal dock type.

Parameters
hEageHorizontal dock type
See also
HorizontalEdge
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.
void setVerticalEdge ( VerticalEdge  vEage)

Change element's vertical dock type.

Parameters
vEageVertical dock type
See also
VerticalEdge.
var setVerticalEdge ( var  vEage)

Change element's vertical dock type.

Parameters
vEageVertical dock type
See also
VerticalEdge.
local setVerticalEdge ( local  vEage)

Change element's vertical dock type.

Parameters
vEageVertical dock type
See also
VerticalEdge.
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.
void setLeftMargin ( float  margin)

Change left margin of owner relative to its parent.

Parameters
marginMargin in float.
var setLeftMargin ( var  margin)

Change left margin of owner relative to its parent.

Parameters
marginMargin in float.
local setLeftMargin ( local  margin)

Change left margin of owner relative to its parent.

Parameters
marginMargin 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.
void setRightMargin ( float  margin)

Change right margin of owner relative to its parent.

Parameters
marginMargin in float.
var setRightMargin ( var  margin)

Change right margin of owner relative to its parent.

Parameters
marginMargin in float.
local setRightMargin ( local  margin)

Change right margin of owner relative to its parent.

Parameters
marginMargin 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.
void setTopMargin ( float  margin)

Change the top margin of owner relative to its parent.

Parameters
marginMargin in float.
var setTopMargin ( var  margin)

Change the top margin of owner relative to its parent.

Parameters
marginMargin in float.
local setTopMargin ( local  margin)

Change the top margin of owner relative to its parent.

Parameters
marginMargin in float.
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.
void setBottomMargin ( float  margin)

Change the bottom margin of owner relative to its parent.

Parameters
marginin float.
var setBottomMargin ( var  margin)

Change the bottom margin of owner relative to its parent.

Parameters
marginin float.
local setBottomMargin ( local  margin)

Change the bottom margin of owner relative to its parent.

Parameters
marginin 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.
void setSize ( const Size &  size)

Change the content size of owner.

Parameters
sizeContent size in
See also
Size.
var setSize ( var  size)

Change the content size of owner.

Parameters
sizeContent size in
See also
Size.
local setSize ( local  size)

Change the content size of owner.

Parameters
sizeContent size in
See also
Size.
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.
void setPercentWidthEnabled ( bool  isUsed)

Toggle enable percent width.

Parameters
isUsedTrue if percent width is enabled, false otherwise.
var setPercentWidthEnabled ( var  isUsed)

Toggle enable percent width.

Parameters
isUsedTrue if percent width is enabled, false otherwise.
local setPercentWidthEnabled ( local  isUsed)

Toggle enable percent width.

Parameters
isUsedTrue if percent width is enabled, false otherwise.
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.
void setSizeWidth ( float  width)

Change content size width of owner.

Parameters
widthContent size width in float.
var setSizeWidth ( var  width)

Change content size width of owner.

Parameters
widthContent size width in float.
local setSizeWidth ( local  width)

Change content size width of owner.

Parameters
widthContent size width 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.
void setPercentWidth ( float  percentWidth)

Change percent width of owner.

Parameters
percentWidthPercent Width in float.
var setPercentWidth ( var  percentWidth)

Change percent width of owner.

Parameters
percentWidthPercent Width in float.
local setPercentWidth ( local  percentWidth)

Change percent width of owner.

Parameters
percentWidthPercent Width in float.
bool isPercentHeightEnabled ( ) const

Query whether percent height is enabled or not.

Returns
True if percent height is enabled, false otherwise.
var isPercentHeightEnabled ( )

Query whether percent height is enabled or not.

Returns
True if percent height is enabled, false otherwise.
local isPercentHeightEnabled ( )

Query whether percent height is enabled or not.

Returns
True if percent height is enabled, false otherwise.
void setPercentHeightEnabled ( bool  isUsed)

Toggle enable percent height.

Parameters
isUsedTrue if percent height is enabled, false otherwise.
var setPercentHeightEnabled ( var  isUsed)

Toggle enable percent height.

Parameters
isUsedTrue if percent height is enabled, false otherwise.
local setPercentHeightEnabled ( local  isUsed)

Toggle enable percent height.

Parameters
isUsedTrue if percent height is enabled, false otherwise.
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.
void setSizeHeight ( float  height)

Change size height of owner.

Parameters
heightSize height in float.
var setSizeHeight ( var  height)

Change size height of owner.

Parameters
heightSize height in float.
local setSizeHeight ( local  height)

Change size height of owner.

Parameters
heightSize height in float.
float getPercentHeight ( ) const

Query percent height of owner.

Returns
Percent height in float.
var getPercentHeight ( )

Query percent height of owner.

Returns
Percent height in float.
local getPercentHeight ( )

Query percent height of owner.

Returns
Percent height in float.
void setPercentHeight ( float  percentHeight)

Change percent height value of owner.

Parameters
percentHeightPercent height in float.
var setPercentHeight ( var  percentHeight)

Change percent height value of owner.

Parameters
percentHeightPercent height in float.
local setPercentHeight ( local  percentHeight)

Change percent height value of owner.

Parameters
percentHeightPercent height in float.
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 setStretchWidthEnabled ( bool  isUsed)

Toggle enable stretch width.

Parameters
isUsedTrue if enable stretch width, false otherwise.
var setStretchWidthEnabled ( var  isUsed)

Toggle enable stretch width.

Parameters
isUsedTrue if enable stretch width, false otherwise.
local setStretchWidthEnabled ( local  isUsed)

Toggle enable stretch width.

Parameters
isUsedTrue if enable stretch width, 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.
void setStretchHeightEnabled ( bool  isUsed)

Toggle enable stretch height.

Parameters
isUsedTrue if stretch height is enabled, false otherwise.
var setStretchHeightEnabled ( var  isUsed)

Toggle enable stretch height.

Parameters
isUsedTrue if stretch height is enabled, false otherwise.
local setStretchHeightEnabled ( local  isUsed)

Toggle enable stretch height.

Parameters
isUsedTrue if stretch height is enabled, false otherwise.
void setPercentOnlyEnabled ( bool  enable)

Toggle enable percent only.

Parameters
enableTrue if percent only is enabled, false otherwise.
var setPercentOnlyEnabled ( var  enable)

Toggle enable percent only.

Parameters
enableTrue if percent only is enabled, false otherwise.
local setPercentOnlyEnabled ( local  enable)

Toggle enable percent only.

Parameters
enableTrue if percent only is enabled, false otherwise.
void setActiveEnabled ( bool  enable)

Toggle active enabled of LayoutComponent's owner.

Parameters
enableTrue if active layout component, false otherwise.
var setActiveEnabled ( var  enable)

Toggle active enabled of LayoutComponent's owner.

Parameters
enableTrue if active layout component, false otherwise.
local setActiveEnabled ( local  enable)

Toggle active enabled of LayoutComponent's owner.

Parameters
enableTrue if active layout component, false otherwise.

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