activeobject.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
#pragma once
 
#include "irr_aabb3d.h"
#include "irr_v3d.h"
#include <quaternion.h>
#include <string>
#include <string_view>
#include <unordered_map>
 
 
enum ActiveObjectType {
        ACTIVEOBJECT_TYPE_INVALID = 0,
        ACTIVEOBJECT_TYPE_TEST = 1,
// Obsolete stuff
// ACTIVEOBJECT_TYPE_ITEM = 2,
// ACTIVEOBJECT_TYPE_RAT = 3,
// ACTIVEOBJECT_TYPE_OERKKI1 = 4,
// ACTIVEOBJECT_TYPE_FIREFLY = 5,
// ACTIVEOBJECT_TYPE_MOBV2 = 6,
// End obsolete stuff
        ACTIVEOBJECT_TYPE_LUAENTITY = 7,
// Special type, not stored as a static object
        ACTIVEOBJECT_TYPE_PLAYER = 100,
// Special type, only exists as CAO
        ACTIVEOBJECT_TYPE_GENERIC = 101,
};
// Other types are defined in content_object.h
 
struct ActiveObjectMessage
{
        ActiveObjectMessage(u16 id_, bool reliable_=true, std::string_view data_ = "") :
                id(id_),
                reliable(reliable_),
                datastring(data_)
        {}
 
        void appendTo(std::string &data) const;
 
        u16 id;
        bool reliable;
        std::string datastring;
};
 
enum ActiveObjectCommand : u8 {
        AO_CMD_SET_PROPERTIES,
        AO_CMD_UPDATE_POSITION,
        AO_CMD_SET_TEXTURE_MOD,
        AO_CMD_SET_SPRITE,
        AO_CMD_PUNCHED,
        AO_CMD_UPDATE_ARMOR_GROUPS,
        AO_CMD_SET_ANIMATION,
        AO_CMD_SET_BONE_POSITION,
        AO_CMD_ATTACH_TO,
        AO_CMD_SET_PHYSICS_OVERRIDE,
        AO_CMD_OBSOLETE1,
        // ^ UPDATE_NAMETAG_ATTRIBUTES deprecated since 0.4.14, removed in 5.3.0
        AO_CMD_SPAWN_INFANT,
        AO_CMD_SET_ANIMATION_SPEED,
        // >= 5.17.0-dev
        AO_CMD_STOP_ANIMATION,
        // When adding new commands, update Server::AsyncRunStep()
        // to drop newer commands for older clients
};
 
struct BoneOverride
{
        struct PositionProperty
        {
                v3f previous;
                v3f vector;
                bool absolute = false;
                f32 interp_duration = 0.0f;
        } position;
 
        v3f getPosition(v3f anim_pos) const {
                f32 progress = dtime_passed / position.interp_duration;
                if (progress > 1.0f || position.interp_duration == 0.0f)
                        progress = 1.0f;
                return position.vector.getInterpolated(position.previous, progress)
                                + (position.absolute ? v3f() : anim_pos);
        }
 
        struct RotationProperty
        {
                core::quaternion previous;
                core::quaternion next;
                // Redundantly store the euler angles serverside
                // so that we can return them in the appropriate getters
                v3f next_radians;
                bool absolute = false;
                f32 interp_duration = 0.0f;
        } rotation;
 
        v3f getRotationEulerDeg(v3f anim_rot_euler) const {
                core::quaternion rot;
 
                f32 progress = dtime_passed / rotation.interp_duration;
                if (progress > 1.0f || rotation.interp_duration == 0.0f)
                        progress = 1.0f;
                rot.slerp(rotation.previous, rotation.next, progress);
                if (!rotation.absolute) {
                        core::quaternion anim_rot(anim_rot_euler * core::DEGTORAD);
                        rot = rot * anim_rot; // first rotate by anim. bone rot., then rot.
                }
 
                v3f rot_euler;
                rot.toEuler(rot_euler);
                return rot_euler * core::RADTODEG;
        }
 
        struct ScaleProperty
        {
                v3f previous = v3f(1.0f);
                v3f vector = v3f(1.0f);
                bool absolute = false;
                f32 interp_duration = 0.0f;
        } scale;
 
        v3f getScale(v3f anim_scale) const {
                f32 progress = dtime_passed / scale.interp_duration;
                if (progress > 1.0f || scale.interp_duration == 0.0f)
                        progress = 1.0f;
                return scale.vector.getInterpolated(scale.previous, progress)
                                * (scale.absolute ? v3f(1.0f) : anim_scale);
        }
 
        f32 dtime_passed = 0.0f;
 
        bool finishedInterpolation() const
        {
                return dtime_passed >= std::max(std::max(
                                position.interp_duration, rotation.interp_duration),
                                scale.interp_duration);
        }
 
        bool isIdentity() const
        {
                return finishedInterpolation()
                                && !position.absolute && position.vector == v3f()
                                && !rotation.absolute && rotation.next == core::quaternion()
                                && !scale.absolute && scale.vector == v3f(1.0f);
        }
};
 
typedef std::unordered_map<std::string, BoneOverride> BoneOverrideMap;
 
 
/*
        Parent class for ServerActiveObject and ClientActiveObject
*/
class ActiveObject
{
public:
        typedef u16 object_t;
 
        ActiveObject(object_t id):
                m_id(id)
        {
        }
 
        object_t getId() const
        {
                return m_id;
        }
 
        void setId(object_t id)
        {
                m_id = id;
        }
 
        virtual ActiveObjectType getType() const = 0;
 

        virtual bool getCollisionBox(aabb3f *toset) const = 0;
 

        virtual bool getSelectionBox(aabb3f *toset) const = 0;
 
 
        virtual bool collideWithObjects() const = 0;
 
 
        virtual void setAttachment(object_t parent_id, const std::string &bone, v3f position,
                        v3f rotation, bool force_visible) {}
        virtual void getAttachment(object_t *parent_id, std::string *bone, v3f *position,
                        v3f *rotation, bool *force_visible) const {}
        // Detach all children
        virtual void clearChildAttachments() {}
        // Detach from parent
        virtual void clearParentAttachment()
        {
                setAttachment(0, "", v3f(), v3f(), false);
        }
 
        // To be called from setAttachment() and descendants, but not manually!
        virtual void addAttachmentChild(object_t child_id) {}
        virtual void removeAttachmentChild(object_t child_id) {}
 
protected:
        object_t m_id; // 0 is invalid, "no id"
};