Package pymunk :: Class Circle
[frames] | no frames]

Class Circle

object --+    
         |    
     Shape --+
             |
            Circle

A circle shape defined by a radius

This is the fastest and simplest collision shape

Instance Methods
 
__init__(self, body, radius, offset=(0, 0))
body is the body attach the circle to, offset is the offset from the body's center of gravity in body local coordinates.
 
unsafe_set_radius(self, r)
Unsafe set the radius of the circle.
 
unsafe_set_offset(self, o)
Unsafe set the offset of the circle.
 
__del__(self) (Inherited from pymunk.Shape)
 
cache_bb(self)
Update and returns the bouding box of this shape (Inherited from pymunk.Shape)
 
point_query(self, p)
Check if the given point lies within the shape. (Inherited from pymunk.Shape)
 
segment_query(self, start, end)
Check if the line segment from start to end intersects the shape. (Inherited from pymunk.Shape)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
  radius
The Radius of the circle
  offset
Offset. (body space coordinates)
  body
The body this shape is attached to (Inherited from pymunk.Shape)
  collision_type
User defined collision type for the shape. See add_collisionpair_func function for more information on when to use this property (Inherited from pymunk.Shape)
  elasticity
Elasticity of the shape. A value of 0.0 gives no bounce, while a value of 1.0 will give a 'perfect' bounce. However due to inaccuracies in the simulation using 1.0 or greater is not recommended. (Inherited from pymunk.Shape)
  friction
Friction coefficient. pymunk uses the Coulomb friction model, a value of 0.0 is frictionless. (Inherited from pymunk.Shape)
  group
Shapes in the same non-zero group do not generate collisions. Useful when creating an object out of many shapes that you don't want to self collide. Defaults to 0 (Inherited from pymunk.Shape)
  layers
Shapes only collide if they are in the same bit-planes. i.e. (a.layers & b.layers) != 0. By default, a shape occupies all 32 bit-planes, i.e. layers == -1 (Inherited from pymunk.Shape)
  sensor
A boolean value if this shape is a sensor or not. Sensors only call collision callbacks, and never generate real collisions. (Inherited from pymunk.Shape)
  surface_velocity
The surface velocity of the object. Useful for creating conveyor belts or players that move around. This value is only used when calculating friction, not resolving the collision. (Inherited from pymunk.Shape)

Inherited from object: __class__

Method Details

__init__(self, body, radius, offset=(0, 0))
(Constructor)

 
body is the body attach the circle to, offset is the offset from the body's center of gravity in body local coordinates.
Overrides: object.__init__

unsafe_set_radius(self, r)

 

Unsafe set the radius of the circle.

WARNING: This change is only picked up as a change to the position of the shape's surface, but not it's velocity. Changing it will not result in realistic physical behavior. Only use if you know what you are doing!

unsafe_set_offset(self, o)

 

Unsafe set the offset of the circle.

WARNING: This change is only picked up as a change to the position of the shape's surface, but not it's velocity. Changing it will not result in realistic physical behavior. Only use if you know what you are doing!


Property Details

radius

The Radius of the circle
Get Method:
_get_radius(self)

offset

Offset. (body space coordinates)
Get Method:
_get_offset(self)