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

Type GeomObject

object --+
         |
        GeomObject

Known Subclasses:
GeomBox, GeomCapsule, GeomCylinder, GeomPlane, GeomRay, GeomSphere, GeomTransform, GeomTriMesh, SpaceBase

This is the abstract base class for all geom objects.
Method Summary
  __init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __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.
int _id()
Return the internal id of the geom (dGeomID) as returned by the dCreateXyz() functions.
    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:
__builtin__.object.__init__

__delattr__(...)

x.__delattr__('name') <==> del x.name
Overrides:
__builtin__.object.__delattr__

__getattribute__(...)

x.__getattribute__('name') <==> x.name
Overrides:
__builtin__.object.__getattribute__

__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:
__builtin__.object.__new__

__setattr__(...)

x.__setattr__('name', value) <==> x.name = value
Overrides:
__builtin__.object.__setattr__

disable()

Disable the geom.

enable()

Enable the geom.

getAABB()

Return an axis aligned bounding box that surrounds the geom. The return value is a 6-tuple (minx, maxx, miny, maxy, minz, maxz).
Returns:
6-tuple

getBody()

Get the body associated with this geom.
Returns:
Body

getCategoryBits()

Return the "category" bitfields for this geom.
Returns:
long

getCollideBits()

Return the "collide" bitfields for this geom.
Returns:
long

getPosition()

Get the current position of the geom. If the geom is attached to a body the returned value is the body's position.
Returns:
3-tuple

getQuaternion()

Get the current orientation of the geom. If the geom is attached to a body the returned value is the body's orientation.
Returns:
(w,x,y,z)

getRotation()

Get the current orientation of the geom. If the geom is attached to a body the returned value is the body's orientation.
Returns:
9-tuple

getSpace()

Return the space that the given geometry is contained in, or return None if it is not contained in any space.
Returns:
Space

isEnabled()

Return True if the geom is enabled.
Returns:
bool

isSpace()

Return 1 if the given geom is a space, or 0 if not.
Returns:
bool

placeable()

Returns True if the geom object is a placeable geom.

This method has to be overwritten in derived methods.
Returns:
bool

setBody(body)

Set the body associated with a placeable geom.
Parameters:
body - The Body object or None.
           (type=Body)

setCategoryBits(bits)

Set the "category" bitfields for this geom.
Parameters:
bits - Category bit field
           (type=int/long)

setCollideBits(bits)

Set the "collide" bitfields for this geom.
Parameters:
bits - Collide bit field
           (type=int/long)

setPosition(pos)

Set the position of the geom. If the geom is attached to a body, the body's position will also be changed.
Parameters:
pos - Position
           (type=3-sequence of floats)

setQuaternion(q)

Set the orientation of the geom. If the geom is attached to a body, the body's orientation will also be changed.
Parameters:
q - Quaternion (w,x,y,z)
           (type=4-sequence of floats)

setRotation(R)

Set the orientation of the geom. If the geom is attached to a body, the body's orientation will also be changed.
Parameters:
R - Rotation matrix
           (type=9-sequence of floats)

_id()

Return the internal id of the geom (dGeomID) as returned by the dCreateXyz() functions.

This method has to be overwritten in derived methods.
Returns:
int

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