- """Contact information of a collision between `ray` and `shape`"""
+ """Data structure to save the contact information of a collision
+ between :attr:`ray` and :attr:`shape`.
+ All attributes are read-only (set at initialization).
def __init__(self, ray=None, shape=None, pos=None, normal=None, depth=None):
- # -pos: point at which the ray intersects the surface of the other
- # -normal: surface normal of the other geom at the contact point.
- # -depth: distance from the start of the ray to the contact point.
+ :type ray: the type of :class:`Ray` subclass' ``inner_object``
+ :type shape: the type of :class:`Geom` subclass' ``inner_object``
+ :param pos: point at which the ray intersects the surface of the other
+ :type pos: 3-tuple of floats
+ :param normal: vector normal to the surface of the other geom
+ :type normal: 3-tuple of floats
+ :param depth: distance from the origin of the ray to the contact point