AttractorMotor.h

Go to the documentation of this file.
00001 /*************************************************************************
00002  *                                                                       *
00003  * Open Physics Abstraction Layer                                        *
00004  * Copyright (C) 2004-2005                                               *
00005  * Alan Fischer  alan.fischer@gmail.com                                  *
00006  * Andres Reinot  andres@reinot.com                                      *
00007  * Tyler Streeter  tylerstreeter@gmail.com                               *
00008  * All rights reserved.                                                  *
00009  * Web: opal.sourceforge.net                                             *
00010  *                                                                       *
00011  * This library is free software; you can redistribute it and/or         *
00012  * modify it under the terms of EITHER:                                  *
00013  *   (1) The GNU Lesser General Public License as published by the Free  *
00014  *       Software Foundation; either version 2.1 of the License, or (at  *
00015  *       your option) any later version. The text of the GNU Lesser      *
00016  *       General Public License is included with this library in the     *
00017  *       file license-LGPL.txt.                                          *
00018  *   (2) The BSD-style license that is included with this library in     *
00019  *       the file license-BSD.txt.                                       *
00020  *                                                                       *
00021  * This library is distributed in the hope that it will be useful,       *
00022  * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00023  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the files    *
00024  * license-LGPL.txt and license-BSD.txt for more details.                *
00025  *                                                                       *
00026  *************************************************************************/
00027 
00028 #ifndef OPAL_ATTRACTOR_MOTOR_H
00029 #define OPAL_ATTRACTOR_MOTOR_H
00030 
00031 #include "Defines.h"
00032 #include "Motor.h"
00033 #include "AttractorMotorData.h"
00034 
00035 namespace opal
00036 {
00043         class AttractorMotor : public Motor
00044         {
00045         public:
00046                 AttractorMotor();
00047 
00048                 virtual ~AttractorMotor();
00049 
00052                 virtual void OPAL_CALL init(const AttractorMotorData& data);
00053 
00055                 virtual const AttractorMotorData& OPAL_CALL getData()const;
00056 
00057                 virtual MotorType OPAL_CALL getType()const;
00058 
00059                 virtual void OPAL_CALL setName(const std::string& name);
00060 
00061                 virtual const std::string& OPAL_CALL getName()const;
00062 
00063                 virtual bool OPAL_CALL isEnabled()const;
00064 
00065                 virtual void OPAL_CALL setEnabled(bool e);
00066 
00068                 virtual void OPAL_CALL setStrength(real s);
00069 
00071                 virtual real OPAL_CALL getStrength()const;
00072 
00074                 virtual void OPAL_CALL setExponent(real e);
00075 
00077                 virtual real OPAL_CALL getExponent()const;
00078 
00079                 virtual void OPAL_CALL internal_update();
00080 
00081                 virtual bool OPAL_CALL internal_dependsOnSolid(Solid* s);
00082 
00083         protected:
00085                 AttractorMotorData mData;
00086 
00088                 real mSolid0Mass;
00089 
00091                 real mSolid1Mass;
00092 
00094                 real mMassConstant;
00095 
00096         private:
00097 
00098         };
00099 }
00100 
00101 #endif

Generated on Tue May 16 17:49:50 2006 for OPAL by  doxygen 1.4.6-NO