Commits

German Larrain committed 8909b2d

physics.ode_objects_factories: completed docstrings of functions.

Comments (0)

Files changed (1)

ars/model/physics/ode_objects_factories.py

 
 def create_ode_world(gravity=G_VECTOR, ERP=0.8, CFM=1E-10):
 	"""Create an ODE world object.
-	
+
+	:param gravity: gravity acceleration vector
+	:type gravity: 3-sequence of floats
+	:param ERP: Error Reduction Parameter
+	:type ERP: float
+	:param CFM: Constraint Force Mixing
+	:type CFM: float
 	:return: world
 	:rtype: :class:`ode.World`
 
 def create_ode_capsule(world, length, radius, mass=None, density=None):
 	"""Create an ODE capsule body.
 
+	:param world:
+	:type world: :class:`.adapters.OdeWorld`
+	:param length:
+	:type length: float
+	:param radius:
+	:type radius: float
+	:param mass:
+	:type mass: float or None
+	:param density:
+	:type density: float or None
 	:return: capsule body
 	:rtype: :class:`ode.Body`
 
 def create_ode_cylinder(world, length, radius, mass=None, density=None):
 	"""Create an ODE cylinder body.
 
+	:param world:
+	:type world: :class:`.adapters.OdeWorld`
+	:param length:
+	:type length: float
+	:param radius:
+	:type radius: float
+	:param mass:
+	:type mass: float or None
+	:param density:
+	:type density: float or None
 	:return: cylinder body
 	:rtype: :class:`ode.Body`
 
 def create_ode_box(world, size, mass=None, density=None):
 	"""Create an ODE box body.
 
+	:param world:
+	:type world: :class:`.adapters.OdeWorld`
+	:param size:
+	:type size: 3-sequence of floats
+	:param mass:
+	:type mass: float or None
+	:param density:
+	:type density: float or None
 	:return: box body
 	:rtype: :class:`ode.Body`
 
 def create_ode_sphere(world, radius, mass=None, density=None):
 	"""Create an ODE sphere body.
 
+	:param world:
+	:type world: :class:`.adapters.OdeWorld`
+	:param radius:
+	:type radius: float
+	:param mass:
+	:type mass: float or None
+	:param density:
+	:type density: float or None
 	:return: sphere body
 	:rtype: :class:`ode.Body`