org.ode4j.cpp.OdeCpp Maven / Gradle / Ivy
/** ***********************************************************************
* *
* Open Dynamics Engine, Copyright (C) 2001,2002 Russell L. Smith. *
* All rights reserved. Email: [email protected] Web: www.q12.org *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of EITHER: *
* (1) The GNU Lesser General Public License as published by the Free *
* Software Foundation; either version 2.1 of the License, or (at *
* your option) any later version. The text of the GNU Lesser *
* General Public License is included with this library in the *
* file LICENSE.TXT. *
* (2) The BSD-style license that is included with this library in *
* the file LICENSE-BSD.TXT. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the files *
* LICENSE.TXT and LICENSE-BSD.TXT for more details. *
* *
************************************************************************ */
package org.ode4j.cpp;
import org.ode4j.cpp.internal.ApiCppWorld;
/**
* This class represents the static API of the C/C++ version of ODE.
* It is very close to the actual documentation.
*
* There are two ways of using this class:
* a) Using import static org.ode4j.cpp.ODE_API.* gives direct
* access to all methods, for example one can simply call
* dWorld wId = dWorldCreate(); .
*
* b) Using extends ODE_API gives direct access to all methods,
* for example one can simply call dWorld wId = dWorldCreate(); .
*
* c) Using private static final Ode ODE = Ode.getInstance(); in a class
* allows extending other classes instead. The above example then looks like:
* dWorld wId = ODE.dWorldCreate(); .
*
*
* These approaches are not quit object oriented, but they are close to the
* existing documentation and they simplify porting code from C/C++ to Java.
*
* For new applications it is recommended to use the object oriented API and avoid
* this class altogether.
*
* @author Tilmann Zaeschke, based on ODE for C/C++
*/
public class OdeCpp extends ApiCppWorld {
protected OdeCpp() {
//protected
super();
}
}