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

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2004 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_ACTORMOVE__
00021 #define __CEL_PF_ACTORMOVE__
00022 
00023 #include "cstypes.h"
00024 #include "csutil/scf.h"
00025 
00027 enum celAnimationName
00028 {
00029   CEL_ANIM_IDLE = 0, 
00030   CEL_ANIM_WALK,     
00031   CEL_ANIM_RUN,      
00032   CEL_ANIM_JUMP      
00033 };
00034 
00073 struct iPcActorMove : public virtual iBase
00074 {
00075   SCF_INTERFACE (iPcActorMove, 1, 0, 0);
00076 
00078   virtual void Forward (bool start) = 0;
00080   virtual bool IsMovingForward () = 0;
00082   virtual void Backward (bool start) = 0;
00084   virtual bool IsMovingBackward () = 0;
00086   virtual bool IsMoving () = 0;
00088   virtual void StrafeLeft (bool start) = 0;
00090   virtual bool IsStrafingLeft () = 0;
00092   virtual void StrafeRight (bool start) = 0;
00094   virtual bool IsStrafingRight () = 0;
00096   virtual void RotateLeft (bool start) = 0;
00098   virtual bool IsRotatingLeft () = 0;
00100   virtual void RotateRight (bool start) = 0;
00102   virtual bool IsRotatingRight () = 0;
00104   virtual void RotateTo (float yrot) = 0;
00106   virtual void Run (bool start) = 0;
00108   virtual bool IsRunning () = 0;
00110   virtual void AutoRun (bool start) = 0;
00112   virtual bool IsAutoRunning () = 0;
00119   virtual void MouseMove (float x, float y) = 0;
00121   virtual void Jump () = 0;
00123   virtual void ToggleCameraMode () = 0;
00124 
00129   virtual void EnableMouseMove (bool en) = 0;
00131   virtual bool IsMouseMoveEnabled () const = 0;
00132 
00139   virtual void SetMouseMoveAccelerated (bool en) = 0;
00141   virtual bool IsMouseMoveAccelerated () const = 0;
00142 
00147   virtual void SetMouseMoveInverted (bool en) = 0;
00149   virtual bool IsMouseMoveInverted () const = 0;
00150 
00154   virtual void SetMouseMoveSpeed (float xs, float ys) = 0;
00156   virtual float GetMouseMoveSpeedX () const = 0;
00158   virtual float GetMouseMoveSpeedY () const = 0;
00159 
00161   virtual void SetMovementSpeed (float speed) = 0;
00163   virtual float GetMovementSpeed () const = 0;
00164 
00166   virtual void SetRunningSpeed (float speed) = 0;
00168   virtual float GetRunningSpeed () const = 0;
00169 
00171   virtual void SetRotationSpeed (float speed) = 0;
00173   virtual float GetRotationSpeed () const = 0;
00174 
00176   virtual void SetJumpingVelocity (float speed) = 0;
00178   virtual float GetJumpingVelocity () const = 0;
00180   virtual void SetAnimation (const char *name, bool cycle = true) = 0;
00182   virtual void SetAnimationMapping (celAnimationName idx, const char *name) = 0;
00183 };
00184 
00185 #endif // __CEL_PF_ACTORMOVE__
00186