Module ode :: Class GeomPlane
[show private | hide private]
[frames | no frames]

Type GeomPlane

object --+    
         |    
GeomObject --+
             |
            GeomPlane


Plane geometry.

This class represents an infinite plane. The plane equation is: n.x*x + n.y*y + n.z*z = dist

This object can't be attached to a body. If you call getBody() on this object it always returns ode.environment.

Constructor:
 GeomPlane(space=None, normal=(0,0,1), dist=0)

Method Summary
  __init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  getParams(...)
float pointDepth(p)
Return the depth of the point p in the plane.
  setParams(...)
    Inherited from GeomObject
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  disable()
Disable the geom.
  enable()
Enable the geom.
6-tuple getAABB()
Return an axis aligned bounding box that surrounds the geom.
Body getBody()
Get the body associated with this geom.
long getCategoryBits()
Return the "category" bitfields for this geom.
long getCollideBits()
Return the "collide" bitfields for this geom.
3-tuple getPosition()
Get the current position of the geom.
(w,x,y,z) getQuaternion()
Get the current orientation of the geom.
9-tuple getRotation()
Get the current orientation of the geom.
Space getSpace()
Return the space that the given geometry is contained in, or return None if it is not contained in any space.
bool isEnabled()
Return True if the geom is enabled.
bool isSpace()
Return 1 if the given geom is a space, or 0 if not.
bool placeable()
Returns True if the geom object is a placeable geom.
  setBody(body)
Set the body associated with a placeable geom.
  setCategoryBits(bits)
Set the "category" bitfields for this geom.
  setCollideBits(bits)
Set the "collide" bitfields for this geom.
  setPosition(pos)
Set the position of the geom.
  setQuaternion(q)
Set the orientation of the geom.
  setRotation(R)
Set the orientation of the geom.
    Inherited from object
  __hash__(x)
x.__hash__() <==> hash(x)
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __str__(x)
x.__str__() <==> str(x)

Method Details

__init__(...)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides:
ode.GeomObject.__init__

__new__(T, S, ...)

T.__new__(S, ...) -> a new object with type S, a subtype of T
Returns:
a new object with type S, a subtype of T
Overrides:
ode.GeomObject.__new__

pointDepth(p)

Return the depth of the point p in the plane. Points inside the geom will have positive depth, points outside it will have negative depth, and points on the surface will have zero depth.
Parameters:
p - Point
           (type=3-sequence of floats)
Returns:
float

Generated by Epydoc 2.1 on Sun Feb 4 17:54:12 2007 http://epydoc.sf.net