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

Margin of widget's in point. More...

Public Member Functions

 Margin ()
 Default constructor.
 
 Margin ()
 Default constructor.
 
 Margin (float l, float t, float r, float b)
 Construct a Margin instance with left, top, right and bottom margins. More...
 
 Margin ( var l, var t, var r, var b)
 Construct a Margin instance with left, top, right and bottom margins. More...
 
 Margin (const Margin &other)
 Copy constructor.
 
Marginoperator= (const Margin &other)
 Copy assignment operator.
 
void setMargin (float l, float t, float r, float b)
 Change margin with left, top, right and bottom margin. More...
 
var setMargin ( var l, var t, var r, var b)
 Change margin with left, top, right and bottom margin. More...
 
bool equals (const Margin &target) const
 Test equality of two margins. More...
 

Public Attributes

float left
 Left margin.
 
var left
 Left margin.
 
float top
 Top margin.
 
float right
 Right margin.
 
var right
 Right margin.
 
float bottom
 Bottom margin.
 
var bottom
 Bottom margin.
 

Static Public Attributes

static const Margin ZERO
 A margin constant with all margins equal zero.
 

Detailed Description

Margin of widget's in point.

Margin value should be positive.

Constructor & Destructor Documentation

Margin ( float  l,
float  t,
float  r,
float  b 
)

Construct a Margin instance with left, top, right and bottom margins.

Parameters
lLeft margin in float.
tTop margin in float.
rRight margin in float.
bBottom margin in float.
var Margin ( var  l,
var  t,
var  r,
var  b 
)

Construct a Margin instance with left, top, right and bottom margins.

Parameters
lLeft margin in float.
tTop margin in float.
rRight margin in float.
bBottom margin in float.

Member Function Documentation

void setMargin ( float  l,
float  t,
float  r,
float  b 
)

Change margin with left, top, right and bottom margin.

Parameters
lLeft margin in float.
tTop margin in float.
rRight margin in float.
bBottom margin in float.
var setMargin ( var  l,
var  t,
var  r,
var  b 
)

Change margin with left, top, right and bottom margin.

Parameters
lLeft margin in float.
tTop margin in float.
rRight margin in float.
bBottom margin in float.
bool equals ( const Margin target) const

Test equality of two margins.

Parameters
targetA Margin instance.
Returns
True if two margins are equal, false otherwise.
var equals ( var  target)

Test equality of two margins.

Parameters
targetA Margin instance.
Returns
True if two margins are equal, false otherwise.

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