propclass/analogmotion.h Source File (CEL: Crystal Entity Layer 2.0 Public API Reference)

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2001 by Jorrit Tyberghein
00004   
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009   
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014   
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __CEL_PF_ANALOGMOTION__
00021 #define __CEL_PF_ANALOGMOTION__
00022 
00023 #include "cstypes.h"
00024 #include "csutil/scf.h"
00025 
00043 struct iPcAnalogMotion : public virtual iBase
00044 {
00045   SCF_INTERFACE (iPcAnalogMotion, 0, 0, 1);
00046 
00054   virtual void SetAxis (size_t axis, float value) = 0;
00055 
00062   virtual float GetAxis (size_t axis) const = 0;
00063 
00067   virtual void SetAxis (const csVector2 &axis) = 0;
00068 
00072   virtual const csVector2 &GetAxis () const = 0;
00073 
00082   virtual void AddAxis (size_t axis, float value) = 0;
00083 
00088   virtual void SetMovementSpeed (float movespeed) = 0;
00089 
00094   virtual float GetMovementSpeed () const = 0;
00095 
00100   virtual void SetMovementAcceleration (float moveaccel) = 0;
00101 
00106   virtual float GetMovementAcceleration () const = 0;
00107 
00112   virtual void SetMovementDeceleration (float movedecel) = 0;
00113 
00118   virtual float GetMovementDeceleration () const = 0;
00119 
00120   CS_DEPRECATED_METHOD_MSG("Use Set(Minimum|Maximum)TurningSpeed () instead")
00125   virtual void SetTurningSpeed (float turnspeed) = 0;
00126 
00127   CS_DEPRECATED_METHOD_MSG("Use Get(Minimum|Maximum)TurningSpeed () instead")
00132   virtual float GetTurningSpeed () const = 0;
00133 
00141   virtual void SetMinimumTurningSpeed (float turnspeed) = 0;
00142 
00150   virtual float GetMinimumTurningSpeed () const = 0;
00151 
00159   virtual void SetMaximumTurningSpeed (float turnspeed) = 0;
00160 
00168   virtual float GetMaximumTurningSpeed () const = 0;
00169 
00174   virtual void Enable (bool en = true) = 0;
00175 
00179   virtual bool IsEnabled () const = 0;
00180 };
00181 
00182 #endif // __CEL_PF_ANALOGMOTION__