CCharacterController.h

/*
!@
MIT License
 
Copyright (c) 2024 Skylicht Technology CO., LTD
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
This file is part of the "Skylicht Engine".
https://github.com/skylicht-lab/skylicht-engine
!#
*/
 
#pragma once
 
#include "PhysicsEngine/ICollisionObject.h"
 
#ifdef USE_BULLET_PHYSIC_ENGINE
#include <btBulletDynamicsCommon.h>
#include <BulletDynamics/Character/btKinematicCharacterController.h>
#include <BulletCollision/CollisionDispatch/btGhostObject.h>
#endif
 
namespace Skylicht
{
    namespace Physics
    {
        class CCharacterController : public ICollisionObject
        {
            friend class CPhysicsEngine;
        protected:
#ifdef USE_BULLET_PHYSIC_ENGINE
            btPairCachingGhostObject* m_ghostObject;
            btKinematicCharacterController* m_controller;
            btConvexShape* m_shape;
#endif
        public:
            CCharacterController();
 
            virtual ~CCharacterController();
 
            virtual void initComponent();
 
            virtual void startComponent();
 
            virtual void updateComponent();
 
            virtual void setCollisionGroupAndFilter(int group, int filter);

            bool initCharacter(float stepHeight);

            void releaseCharacter();

            core::vector3df getPosition();

            void setPosition(const core::vector3df& pos);

            core::vector3df getRotationEuler();

            core::quaternion getRotation();

            void setRotation(const core::vector3df& eulerDeg);

            void setRotation(const core::quaternion& q);

            void syncTransform();

            void setWalkDirection(const core::vector3df& walk);

            bool canJump();

            bool onGround();

            void setMaxSlope(float slopeRadians);

            float getMaxSlope() const;

            void setMaxPenetrationDepth(float d);

            float getMaxPenetrationDepth() const;

            void reset();

            void setStepHeight(float h);

            float getStepHeight() const;

            void setFallSpeed(float fallSpeed);

            float getFallSpeed() const;

            void setJumpSpeed(float jumpSpeed);

            float getJumpSpeed() const;

            void setMaxJumpHeight(float maxJumpHeight);

            void jump(const core::vector3df& v);

            void setGravity(const core::vector3df& gravity);

            core::vector3df getGravity() const;

            inline void applyImpulse(const core::vector3df& v)
            {
                jump(v);
            }

            void setAngularVelocity(const core::vector3df& velocity);

            core::vector3df getAngularVelocity() const;

            void setLinearVelocity(const core::vector3df& velocity);

            core::vector3df getLinearVelocity() const;

            void setLinearDamping(float d);

            float getLinearDamping() const;

            void setAngularDamping(float d);

            float getAngularDamping() const;

            void setUp(const core::vector3df& up);

            core::vector3df getUp();
 
        protected:
 
#ifdef USE_BULLET_PHYSIC_ENGINE
            btKinematicCharacterController* getCharacterController()
            {
                return m_controller;
            }
 
            btPairCachingGhostObject* getGhostObject()
            {
                return m_ghostObject;
            }
#endif
        };
    }
}