Cocos2d-x  v4
PhysicsShapeCircle Class Reference

A circle shape. More...

Inherits PhysicsShape.

Public Member Functions

virtual float calculateDefaultMoment () override
 Calculate the moment for a circle. More...
 
float getRadius () const
 Get the circle's radius. More...
 
virtual Vec2 getOffset () override
 Get this circle's position offset. 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 PhysicsMaterial & getMaterial () const
 Get this shape's PhysicsMaterial object. More...
 
void setMaterial (const PhysicsMaterial &material)
 Set this shape's material. More...
 
virtual Vec2 getCenter ()
 Get this shape's center position. 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...
 
int getCategoryBitmask () const
 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 PhysicsShapeCirclecreate (float radius, const PhysicsMaterial &material=PHYSICSSHAPE_MATERIAL_DEFAULT, const Vec2 &offset=Vec2(0.0f, 0.0f))
 Creates a PhysicsShapeCircle with specified value. More...
 
static float calculateArea (float radius)
 Calculate the area of a circle with specified radius. More...
 
static float calculateMoment (float mass, float radius, const Vec2 &offset=Vec2::ZERO)
 Calculate the moment of a circle 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...
 
static Vec2 getPolygonCenter (const Vec2 *points, int count)
 Get center of the polygon points. More...
 

Additional Inherited Members

- Public Types inherited from PhysicsShape
enum  Type { , POLYGEN = POLYGON, EDGEPOLYGEN = EDGEPOLYGON }
 
- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 

Detailed Description

A circle shape.

Member Function Documentation

◆ create()

static PhysicsShapeCircle* create ( float  radius,
const PhysicsMaterial &  material = PHYSICSSHAPE_MATERIAL_DEFAULT,
const Vec2 offset = Vec2(0.0f, 0.0f) 
)
static

Creates a PhysicsShapeCircle with specified value.

Parameters
radiusA float number, it is the circle's radius.
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 PhysicsShapeCircle object pointer.

◆ calculateArea()

static float calculateArea ( float  radius)
static

Calculate the area of a circle with specified radius.

Parameters
radiusA float number
Returns
A float number

◆ calculateMoment()

static float calculateMoment ( float  mass,
float  radius,
const Vec2 offset = Vec2::ZERO 
)
static

Calculate the moment of a circle with specified value.

Parameters
massA float number
radiusA float number
offsetA Vec2 object, it is the offset from the body's center of gravity in body local coordinates.
Returns
A float number

◆ calculateDefaultMoment()

virtual float calculateDefaultMoment ( )
overridevirtual

Calculate the moment for a circle.

Returns
A float number.

Reimplemented from PhysicsShape.

◆ getRadius()

float getRadius ( ) const

Get the circle's radius.

Returns
A float number.

◆ getOffset()

virtual Vec2 getOffset ( )
overridevirtual

Get this circle's position offset.

Returns
A Vec2 object.

Reimplemented from PhysicsShape.


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