org.ode4j.cpp.internal
Class ApiCppOdeInit

java.lang.Object
  org.ode4j.cpp.internal.ApiCppTimer
      org.ode4j.cpp.internal.ApiCppCollisionTrimesh
          org.ode4j.cpp.internal.ApiCppCollisionSpace
              org.ode4j.cpp.internal.ApiCppCollision
                  org.ode4j.cpp.internal.ApiCppExportDIF
                      org.ode4j.cpp.internal.ApiCppOdeInit

Direct Known Subclasses:

ApiCppMass

public abstract class ApiCppOdeInit
extends ApiCppExportDIF

Nested Class Summary

Nested classes/interfaces inherited from class org.ode4j.cpp.internal.ApiCppCollision

ApiCppCollision.dAABBTestFn, ApiCppCollision.dGeomClass, ApiCppCollision.dGeomDtorFn, ApiCppCollision.dGetAABBFn, ApiCppCollision.dGetColliderFnFn

Field Summary

Fields inherited from class org.ode4j.cpp.internal.ApiCppCollisionSpace

dSAP_AXES_XYZ, dSAP_AXES_XZY, dSAP_AXES_YXZ, dSAP_AXES_YZX, dSAP_AXES_ZXY, dSAP_AXES_ZYX

Constructor Summary

ApiCppOdeInit()

Method Summary

static int	dAllocateODEDataForThread(int uiAllocateFlags) Deprecated. TZ I guess this can be removed?
static void	dCloseODE()
static void	dInitODE() Deprecated. Please use dInitOde2() instead.
static int	dInitODE2(int uiInitFlags)

Methods inherited from class org.ode4j.cpp.internal.ApiCppExportDIF

dWorldExportDIF

Methods inherited from class org.ode4j.cpp.internal.ApiCppCollision

dBoxBox, dBoxTouchesBox, dCollide, dCreateBox, dCreateCapsule, dCreateConvex, dCreateCylinder, dCreateGeomTransform, dCreateHeightfield, dCreatePlane, dCreateRay, dCreateSphere, dGeomBoxGetLengths, dGeomBoxPointDepth, dGeomBoxSetLengths, dGeomCapsuleGetParams, dGeomCapsulePointDepth, dGeomCapsuleSetParams, dGeomClearOffset, dGeomCopyOffsetPosition, dGeomCopyOffsetRotation, dGeomCopyPosition, dGeomCopyRotation, dGeomCylinderGetParams, dGeomCylinderSetParams, dGeomDestroy, dGeomDisable, dGeomEnable, dGeomGetAABB, dGeomGetBody, dGeomGetCategoryBits, dGeomGetClass, dGeomGetCollideBits, dGeomGetData, dGeomGetOffsetPosition, dGeomGetOffsetQuaternion, dGeomGetOffsetRotation, dGeomGetPosition, dGeomGetQuaternion, dGeomGetRotation, dGeomGetSpace, dGeomHeightfieldDataBuildByte, dGeomHeightfieldDataBuildCallback, dGeomHeightfieldDataCreate, dGeomHeightfieldDataDestroy, dGeomHeightfieldDataSetBounds, dGeomHeightfieldGetHeightfieldData, dGeomHeightfieldSetHeightfieldData, dGeomIsEnabled, dGeomIsOffset, dGeomIsSpace, dGeomPlaneGetParams, dGeomPlanePointDepth, dGeomPlaneSetParams, dGeomRayGet, dGeomRayGetClosestHit, dGeomRayGetLength, dGeomRayGetParams, dGeomRaySet, dGeomRaySetClosestHit, dGeomRaySetLength, dGeomRaySetParams, dGeomSetBody, dGeomSetCategoryBits, dGeomSetCollideBits, dGeomSetConvex, dGeomSetData, dGeomSetOffsetPosition, dGeomSetOffsetQuaternion, dGeomSetOffsetRotation, dGeomSetOffsetWorldPosition, dGeomSetOffsetWorldQuaternion, dGeomSetOffsetWorldRotation, dGeomSetPosition, dGeomSetQuaternion, dGeomSetRotation, dGeomSphereGetRadius, dGeomSpherePointDepth, dGeomSphereSetRadius, dGeomTransformGetGeom, dGeomTransformSetCleanup, dGeomTransformSetGeom, dSetColliderOverride, dSpaceCollide, dSpaceCollide2

Methods inherited from class org.ode4j.cpp.internal.ApiCppCollisionSpace

dHashSpaceCreate, dHashSpaceGetLevels, dHashSpaceSetLevels, dQuadTreeSpaceCreate, dSimpleSpaceCreate, dSpaceAdd, dSpaceClean, dSpaceDestroy, dSpaceGetCleanup, dSpaceGetGeom, dSpaceGetManualCleanup, dSpaceGetNumGeoms, dSpaceGetSublevel, dSpaceQuery, dSpaceRemove, dSpaceSetCleanup, dSpaceSetManualCleanup, dSpaceSetSublevel, dSweepAndPruneSpaceCreate

Methods inherited from class org.ode4j.cpp.internal.ApiCppCollisionTrimesh

dCreateTriMesh, dGeomTriMeshDataBuildSingle, dGeomTriMeshDataCreate, dGeomTriMeshDataDestroy, dGeomTriMeshSetLastTransform

Methods inherited from class org.ode4j.cpp.internal.ApiCppTimer

dTimerEnd, dTimerNow, dTimerReport, dTimerStart

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiCppOdeInit

public ApiCppOdeInit()

Method Detail

dInitODE

public static void dInitODE()

Deprecated. Please use dInitOde2() instead.

See Also:

dInitODE2(int), dAllocateODEDataForThread(int)

Brief:

Initializes ODE library. dInitODE is obsolete. dInitODE2 is to be used for library initialization. A call to dInitODE is equal to the following initialization sequence

dInitODE2(0);
dAllocateODEDataForThread(dAllocateMaskAll);


dInitODE2

public static int dInitODE2(int uiInitFlags)

Parameters:

uiInitFlags - Initialization options bitmask

Returns:

A nonzero if initialization succeeded and zero otherwise. This function must be called to initialize ODE library before first use. If initialization succeeds the function may not be called again until library is closed with a call to @c dCloseODE. The @a uiInitFlags parameter specifies initialization options to be used. These can be combination of zero or more @c dInitODEFlags flags.

See Also:

#dInitODEFlags, dCloseODE()

Brief:

Initializes ODE library.

dAllocateODEDataForThread

public static int dAllocateODEDataForThread(int uiAllocateFlags)

Deprecated. TZ I guess this can be removed?

Parameters:

uiAllocateFlags - Allocation options bitmask.

Returns:

A nonzero if allocation succeeded and zero otherwise. The function is required to be called for every thread that is going to use ODE. This function allocates the data that is required for accessing ODE from current thread along with optional data required for particular ODE subsystems. uiAllocateFlags parameter can contain zero or more flags from dAllocateODEDataFlags enumerated type. Multiple calls with different allocation flags are allowed. The flags that are already allocated are ignored in subsequent calls. If zero is passed as the parameter, it means to only allocate the set of most important data the library can not operate without. If the function returns failure status it means that none of the requested data has been allocated. The client may retry allocation attempt with the same flags when more system resources are available.

See Also:

#dAllocateODEDataFlags, #dCleanupODEAllDataForThread

Brief:

Allocate thread local data to allow the thread calling ODE.

dCloseODE

public static void dCloseODE()

See Also:

dInitODE2(int), #dCleanupODEAllDataForThread

Brief:

Close ODE after it is not needed any more. The function is required to be called when program does not need ODE features any more. The call to dCloseODE releases all the resources allocated for library including all the thread local data that might be allocated for all the threads that were using ODE. dCloseODE is a paired function for dInitODE2 and must only be called after successful library initialization.

Note:

Important! Make sure that all the threads that were using ODE have already terminated before calling dCloseODE. In particular it is not allowed to call dCleanupODEAllDataForThread after dCloseODE.