1. German Larrain
  2. ars

Commits

German Larrain  committed 44d230d

collision.base: added docstring for Engine, Space, Geom.

  • Participants
  • Parent commits e8b724b
  • Branches dev

Comments (0)

Files changed (1)

File ars/model/collision/base.py

View file
 
 
 class Engine(object):
+
+	"""Collision engine abstract base class.
+
+	"""
+
 	__metaclass__ = ABCMeta
 
 #	@abstractmethod
 
 
 class Space(object):
+
+	"""Collision space abstract base class.
+
+	This class wraps the corresponding "native" object the
+	adapted-to library (e.g. ODE) uses, assigned to
+	:attr:`_inner_object`.
+
+	Subclasses must implement these methods:
+
+	* :meth:`__init__`
+	* :meth:`collide`
+
+	"""
+
 	__metaclass__ = ABCMeta
 
 	@abstractmethod
 
 
 class Geom(object):
-	"""Encapsules a geometry object"""
+
+	"""Geometry object encapsulation.
+
+	This class wraps the corresponding "native" object the
+	adapted-to library (e.g. ODE) uses, assigned to
+	:attr:`_inner_object`.
+
+	Subclasses must implement these methods:
+
+	* :meth:`__init__`
+	* :meth:`attach_body`
+	* :meth:`get_position`, :meth:`set_position`
+	* :meth:`get_rotation`, :meth:`set_rotation`
+
+	"""
+
 	__metaclass__ = ABCMeta
 
 	@abstractmethod