Pymunx/Documentation

pymunx

Physics API for easy usage of chipmunk physics engine in pygame (with pymunk)

pymunx.__init__	Init function: pymunk, get flags, get screen size, init space
pymunx.set_info	Set the Info-Text for the upper left corner
pymunx.update	Update the physics space
pymunx.draw	Call draw_shape for each element
pymunx.add_wall	Add a fixed wall
pymunx.add_ball	Add a ball
pymunx.add_square	Add a square
pymunx.add_poly	Add a polygon
pymunx.get_element_count	Returns the current element count
pymunx.autoset_screen_size	Get screensize from pygame. Call on resize
pymunx.set_color	Sets a fixed color instead of random
pymunx.reset_color	Use random colors
pymunx.get_color	Get either fixed or random color in rgb
pymunx.init_colors	Init the random color array
pymunx.flipy	Convert pygame y-coordinate to chipmunk's
pymunx.vec2df	Convert a pygame pos to a vec2d with flipped y coordinate
pymunx.draw_shape	Draw a given shape (circle, segment, poly) on the surface
pymunx.get_pymunk_flags	Check pymunk version and adjusts settings

(bold are the functions you'll likely want to use :)

pymunx.__init__

def __init__(self, gravity=(0.0,-900.0))

• Init function - pymunk, get flags, get screen size, init space
• Parameters: gravity = (int(x), int(y))
• Returns: class pymunx

pymunx.set_info

pymunx.set_info(self, txt)

• Set the Info-Text which will be blit at the upper left corner each update
• Parameters: txt = str (break lines with \n)
• Returns: -

pymunx.update

pymunx.update (self, fps=50.0, steps=5)

• Update thy physics. fps is optional and by default set to 50.0 - steps is substeps per update
• Returns: -

pymunx.draw

pymunx.draw (self, surface)

• Iterate through all elements and call draw_shape with each
• Parameters: surface = pygame.Surface
• Returns: -

pymunx.add_wall

pymunx.add_wall (self, p1, p2, friction=10.0)

• Add a fixed wall between points p1 and p2. friction is a optional parameter
• Parameters: p = (int(x), int(y))
• Returns: -

pymunx.add_ball

pymunx.add_ball (self, pos, radius=15, mass=10.0, inertia=1000, friction=0.5)

• Add a ball at pos. Other parameters are optional
• Parameters: pos = (int(x), int(y))
• Returns: -

pymunx.add_square

pymunx.add_square (self, pos, a=18, mass=5.0, friction=0.2)

• Add a square at pos.
• Parameters: pos = (int(x), int(y))
• Returns: -

pymunx.add_poly

pymunx.add_poly(self, points, mass=150.0, friction=10.0)

• Add a polygon from given a given pygame pointlist
• Parameters: points = [(int(x), int(y)), (int(x), int(y)), ...]
• Returns: -

pymunx.get_element_count

pymunx.get_element_count(self)

• Returns the current element count
• Returns: int(n)

pymunx.autoset_screen_size

pymunx.autoset_screen_size (self)

• Get screensize from pygame. Call this only on resize
• Returns: -

pymunx.set_color

pymunx.set_color(self, clr)

• Use a fixed color instead of a random one
• clr in either hex ("#123123") or rgb ((100), (100), (0))
• Returns: -

pymunx.reset_color

pymunx.reset_color(self)

• Use random colors instead of a fixed one
• Returns: -

pymunx.init_colors

pymunx.init_colors(self)

• Inits self.colors with a fix set of hex colors
• Returns: -

pymunx.get_color

pymunx.get_color(self)

• If a fixed color is specified, return that. Else, return a random one.
• Returns: clr = rgb ((100), (200), (0))

pymunx.flipy

pymunx.flipy (self, y)

1. Convert Chipmunk y-coordinate to pyGame (y = -y + self.display_height)
2. Parameters: y = int
3. Returns: int(y_new)

pymunx.vec2df

pymunx.vec2df(self, pos)

• Convert a pygame pos to a vec2d with flipped y coordinate
• Parameters: pos = (int(x), int(y))
• Returns: class vec2d((pos[0], self.flipy(pos[1])))

pymunx.draw_shape

pymunx.draw_shape (self, surface, shape)

• Draw a given shape (circle, segment, poly) on the surface
• Parameters: surface = pygame.Surface | shape = pymunk.Shape
• Returns: -

pymunx.get_pymunk_flags

pymunx.get_pymunk_flags (self)

• Check pymunk version, adjusts settings and returns new flagset
• Returns: class pymunk_flags