cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
PhysicsShapeBox Class Reference

A box shape. More...

#include <CCPhysicsShape.h>

Inheritance diagram for PhysicsShapeBox:
PhysicsShapePolygon PhysicsShape Ref

Public Member Functions

Size getSize () const
 Get this box's width and height. More...
 
virtual Vec2 getOffset () override
 Get this box's position offset. More...
 
- Public Member Functions inherited from PhysicsShapePolygon
float calculateDefaultMoment () override
 Calculate the moment for a polygon. More...
 
Vec2 getPoint (int i) const
 Get a point of this polygon's points array. More...
 
void getPoints (Vec2 *outPoints) const
 Get this polygon's points array. More...
 
int getPointsCount () const
 Get this polygon's points array count. More...
 
virtual Vec2 getCenter () override
 Get this polygon's center position. More...
 
- Public Member Functions inherited from PhysicsShape
PhysicsBodygetBody () const
 Get the body that this shape attaches. More...
 
Type getType () const
 Return this shape's type. More...
 
float getArea () const
 Return this shape's area. More...
 
float getMoment () const
 Get this shape's moment. More...
 
void setMoment (float moment)
 Set this shape's moment. More...
 
void setTag (int tag)
 Set this shape's tag. More...
 
int getTag () const
 Get this shape's tag. More...
 
float getMass () const
 Get the mass of this shape. More...
 
void setMass (float mass)
 Set this shape's mass. More...
 
float getDensity () const
 Get this shape's density. More...
 
void setDensity (float density)
 Set this shape's density. More...
 
float getRestitution () const
 Get this shape's restitution. More...
 
void setRestitution (float restitution)
 Set this shape's restitution. More...
 
float getFriction () const
 Get this shape's friction. More...
 
void setFriction (float friction)
 Set this shape's friction. More...
 
const PhysicsMaterialgetMaterial () const
 Get this shape's PhysicsMaterial object. More...
 
local getMaterial ()
 Get this shape's PhysicsMaterial object. More...
 
void setMaterial (const PhysicsMaterial &material)
 Set this shape's material. More...
 
local setMaterial ( local material)
 Set this shape's material. More...
 
bool containsPoint (const Vec2 &point) const
 Test point is inside this shape or not. More...
 
void setCategoryBitmask (int bitmask)
 Set a mask that defines which categories this physics body belongs to. More...
 
var setCategoryBitmask ( var bitmask)
 Set a mask that defines which categories this physics body belongs to. More...
 
local setCategoryBitmask ( local bitmask)
 Set a mask that defines which categories this physics body belongs to. More...
 
int getCategoryBitmask () const
 Get a mask that defines which categories this physics body belongs to. More...
 
var getCategoryBitmask ()
 Get a mask that defines which categories this physics body belongs to. More...
 
local getCategoryBitmask ()
 Get a mask that defines which categories this physics body belongs to. More...
 
void setContactTestBitmask (int bitmask)
 A mask that defines which categories of bodies cause intersection notifications with this physics body. More...
 
int getContactTestBitmask () const
 Get a mask that defines which categories of bodies cause intersection notifications with this physics body. More...
 
void setCollisionBitmask (int bitmask)
 A mask that defines which categories of physics bodies can collide with this physics body. More...
 
int getCollisionBitmask () const
 Get a mask that defines which categories of physics bodies can collide with this physics body. More...
 
void setGroup (int group)
 Set the group of body. More...
 
int getGroup ()
 Get the group of body. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Static Public Member Functions

static PhysicsShapeBoxcreate (const Size &size, const PhysicsMaterial &material=PHYSICSSHAPE_MATERIAL_DEFAULT, const Vec2 &offset=Vec2::ZERO)
 Creates a PhysicsShapeBox with specified value. More...
 
local create ( local size, local PHYSICSSHAPE_MATERIAL_DEFAULT, local ZERO)
 Creates a PhysicsShapeBox with specified value. More...
 
- Static Public Member Functions inherited from PhysicsShapePolygon
static PhysicsShapePolygoncreate (const Vec2 *points, int count, const PhysicsMaterial &material=PHYSICSSHAPE_MATERIAL_DEFAULT, const Vec2 &offset=Vec2::ZERO)
 Creates a PhysicsShapePolygon with specified value. More...
 
local create ( local points, local count, local PHYSICSSHAPE_MATERIAL_DEFAULT, local ZERO)
 Creates a PhysicsShapePolygon with specified value. More...
 
static float calculateArea (const Vec2 *points, int count)
 Calculate the area of a polygon with specified value. More...
 
static float calculateMoment (float mass, const Vec2 *points, int count, const Vec2 &offset=Vec2::ZERO)
 Calculate the moment of a polygon with specified value. More...
 
local calculateMoment ( local mass, local points, local count, local ZERO)
 Calculate the moment of a polygon with specified value. More...
 
- Static Public Member Functions inherited from PhysicsShape
static void recenterPoints (Vec2 *points, int count, const Vec2 &center=Vec2::ZERO)
 Move the points to the center. More...
 
local recenterPoints ( local points, local count, local ZERO)
 Move the points to the center. More...
 
static Vec2 getPolyonCenter (const Vec2 *points, int count)
 Get center of the polyon points. More...
 

Protected Member Functions

bool init (const Size &size, const PhysicsMaterial &material=PHYSICSSHAPE_MATERIAL_DEFAULT, const Vec2 &offset=Vec2::ZERO)
local init ( local size, local PHYSICSSHAPE_MATERIAL_DEFAULT, local ZERO)
 PhysicsShapeBox ()
virtual ~PhysicsShapeBox ()
- Protected Member Functions inherited from PhysicsShapePolygon
bool init (const Vec2 *points, int count, const PhysicsMaterial &material=PHYSICSSHAPE_MATERIAL_DEFAULT, const Vec2 &offset=Vec2::ZERO)
var init ( var points, var count, var PHYSICSSHAPE_MATERIAL_DEFAULT, var ZERO)
local init ( local points, local count, local PHYSICSSHAPE_MATERIAL_DEFAULT, local ZERO)
float calculateArea () override
 calculate the area of this shape More...
 
virtual void updateScale () override
 PhysicsShapePolygon ()
virtual ~PhysicsShapePolygon ()
- Protected Member Functions inherited from PhysicsShape
void setBody (PhysicsBody *body)
virtual void setScale (float scaleX, float scaleY)
local setScale ( local scaleX, local scaleY)
void addShape (cpShape *shape)
 PhysicsShape ()
virtual ~PhysicsShape ()=0
local ~PhysicsShape ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Additional Inherited Members

- Public Types inherited from PhysicsShape
enum  Type {
  UNKNOWN, CIRCLE, BOX, POLYGEN,
  EDGESEGMENT, EDGEBOX, EDGEPOLYGEN, EDGECHAIN
}
 
- Protected Attributes inherited from PhysicsShape
PhysicsBody_body
std::vector< cpShape * > _cpShapes
Type _type
float _area
float _mass
float _moment
float _scaleX
float _scaleY
float _newScaleX
float _newScaleY
PhysicsMaterial _material
int _tag
int _categoryBitmask
int _collisionBitmask
int _contactTestBitmask
int _group
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Detailed Description

A box shape.

Constructor & Destructor Documentation

PhysicsShapeBox ( )
protected
var PhysicsShapeBox ( )
protected
local PhysicsShapeBox ( )
protected
virtual ~PhysicsShapeBox ( )
protectedvirtual
var ~PhysicsShapeBox ( )
protectedvirtual
local ~PhysicsShapeBox ( )
protectedvirtual

Member Function Documentation

static PhysicsShapeBox* create ( const Size size,
const PhysicsMaterial material = PHYSICSSHAPE_MATERIAL_DEFAULT,
const Vec2 offset = Vec2::ZERO 
)
static

Creates a PhysicsShapeBox with specified value.

Parameters
sizeSize contains this box's width and height.
materialA PhysicsMaterial object, the default value is PHYSICSSHAPE_MATERIAL_DEFAULT.
offsetA Vec2 object, it is the offset from the body’s center of gravity in body local coordinates.
Returns
An autoreleased PhysicsShapeBox object pointer.
var create ( var  size,
var  material = PHYSICSSHAPE_MATERIAL_DEFAULT,
var  offset = Vec2::ZERO 
)
static

Creates a PhysicsShapeBox with specified value.

Parameters
sizeSize contains this box's width and height.
materialA PhysicsMaterial object, the default value is PHYSICSSHAPE_MATERIAL_DEFAULT.
offsetA Vec2 object, it is the offset from the body’s center of gravity in body local coordinates.
Returns
An autoreleased PhysicsShapeBox object pointer.
local create ( local  size,
local  material = PHYSICSSHAPE_MATERIAL_DEFAULT,
local  offset = Vec2::ZERO 
)
static

Creates a PhysicsShapeBox with specified value.

Parameters
sizeSize contains this box's width and height.
materialA PhysicsMaterial object, the default value is PHYSICSSHAPE_MATERIAL_DEFAULT.
offsetA Vec2 object, it is the offset from the body’s center of gravity in body local coordinates.
Returns
An autoreleased PhysicsShapeBox object pointer.
virtual Vec2 getOffset ( )
inlineoverridevirtual

Get this box's position offset.

Returns
A Vec2 object.

Reimplemented from PhysicsShape.

var getOffset ( )
inlineoverridevirtual

Get this box's position offset.

Returns
A Vec2 object.

Reimplemented from PhysicsShape.

local getOffset ( )
inlineoverridevirtual

Get this box's position offset.

Returns
A Vec2 object.

Reimplemented from PhysicsShape.

Size getSize ( ) const

Get this box's width and height.

An Size object.

var getSize ( )

Get this box's width and height.

An Size object.

local getSize ( )

Get this box's width and height.

An Size object.

bool init ( const Size size,
const PhysicsMaterial material = PHYSICSSHAPE_MATERIAL_DEFAULT,
const Vec2 offset = Vec2::ZERO 
)
protected
var init ( var  size,
var  material = PHYSICSSHAPE_MATERIAL_DEFAULT,
var  offset = Vec2::ZERO 
)
protected
local init ( local  size,
local  material = PHYSICSSHAPE_MATERIAL_DEFAULT,
local  offset = Vec2::ZERO 
)
protected

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