Unit.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   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.
 
 */
 
#pragma once
#ifndef DVD_UNIT_H_
#define DVD_UNIT_H_
 
#include "Core/Headers/FrameListener.h"
 
namespace Divide {
 
class UnitComponent;
namespace Attorney {
    class UnitComponent;
}
 
FWD_DECLARE_MANAGED_CLASS(SceneGraphNode);
 
enum class UnitType : U8 {
    UNIT_TYPE_CHARACTER,
    UNIT_TYPE_VEHICLE,
    COUNT
};
namespace Names {
    static const char* unitType[] = {
          "CHARACTER", "VEHICLE", "UNKOWN"
    };
}
 
namespace TypeUtil {
    [[nodiscard]] const char* UnitTypeToString(UnitType unitType) noexcept;
    [[nodiscard]] UnitType StringToUnitType(const string& name);
}
 
class Unit : public GUIDWrapper {
   public:
    using AttributeMap = hashMap<U32, I32>;
    friend class Attorney::UnitComponent;
 
   public:
 
    explicit Unit(UnitType type);
 
    [[nodiscard]] virtual bool moveTo(const vec3<F32>& targetPosition, const U64 deltaTimeUS );
    [[nodiscard]] virtual bool moveToX(F32 targetPosition, const U64 deltaTimeUS );
    [[nodiscard]] virtual bool moveToY(F32 targetPosition, const U64 deltaTimeUS );
    [[nodiscard]] virtual bool moveToZ(F32 targetPosition, const U64 deltaTimeUS );
    [[nodiscard]] virtual bool teleportTo(const vec3<F32>& targetPosition);
 
    [[nodiscard]] const vec3<F32>& getCurrentPosition() const {
        return _currentPosition;
    }
    [[nodiscard]] const vec3<F32>& getTargetPosition() const {
        return _currentTargetPosition;
    }
    virtual void setMovementSpeed(const F32 movementSpeed) {
        _moveSpeed = movementSpeed;
        CLAMP<F32>(_moveSpeed, 0.0f, 100.0f);
    }
    virtual void setAcceleration(const F32 acceleration) {
        _acceleration = acceleration;
        CLAMP<F32>(_moveSpeed, 0.0f, 100.0f);
    }
    [[nodiscard]] virtual F32 getMovementSpeed() const { return _moveSpeed; }
    [[nodiscard]] virtual F32 getAcceleration() const { return _acceleration; }
    void setMovementTolerance(const F32 movementTolerance) {
        _moveTolerance = std::max(0.1f, movementTolerance);
    }
    [[nodiscard]] F32 getMovementTolerance() const { return _moveTolerance; }
    [[nodiscard]] SceneGraphNode* getBoundNode() const { return _node; }
 
    virtual void setAttribute(U32 attributeID, I32 initialValue);
    [[nodiscard]] virtual I32 getAttribute(U32 attributeID) const;
 
    PROPERTY_RW(UnitType, type, UnitType::COUNT);
 
   protected:
    virtual void setParentNode(SceneGraphNode* node);
 
   protected:
    F32 _moveSpeed;
    F32 _acceleration;
    F32 _moveTolerance;
    vec3<F32> _currentPosition;
    vec3<F32> _currentTargetPosition;
    SceneGraphNode* _node;
    AttributeMap _attributes;
    mutable SharedMutex _unitUpdateMutex;
};
 
namespace Attorney {
    class UnitComponent {
    private:
        static void setParentNode(Unit* unit, SceneGraphNode* node) {
            unit->setParentNode(node);
        }
        friend class Divide::UnitComponent;
    };
}
}  // namespace Divide
 
#endif //DVD_UNIT_H_