2023-01-10 15:14:30 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/* object.hpp */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
2021-08-18 14:03:52 +00:00
|
|
|
|
|
|
|
#ifndef GODOT_OBJECT_HPP
|
|
|
|
#define GODOT_OBJECT_HPP
|
|
|
|
|
|
|
|
#include <godot_cpp/core/defs.hpp>
|
2022-08-19 07:30:06 +00:00
|
|
|
|
|
|
|
#include <godot_cpp/core/property_info.hpp>
|
|
|
|
|
2021-08-18 14:03:52 +00:00
|
|
|
#include <godot_cpp/variant/variant.hpp>
|
|
|
|
|
|
|
|
#include <godot_cpp/classes/object.hpp>
|
|
|
|
|
|
|
|
#include <godot_cpp/godot.hpp>
|
|
|
|
|
2022-12-13 23:40:17 +00:00
|
|
|
#include <gdextension_interface.h>
|
2021-08-18 14:03:52 +00:00
|
|
|
|
|
|
|
#include <vector>
|
|
|
|
|
2024-03-08 19:42:07 +00:00
|
|
|
#define ADD_SIGNAL(m_signal) ::godot::ClassDB::add_signal(get_class_static(), m_signal)
|
|
|
|
#define ADD_GROUP(m_name, m_prefix) ::godot::ClassDB::add_property_group(get_class_static(), m_name, m_prefix)
|
|
|
|
#define ADD_SUBGROUP(m_name, m_prefix) ::godot::ClassDB::add_property_subgroup(get_class_static(), m_name, m_prefix)
|
|
|
|
#define ADD_PROPERTY(m_property, m_setter, m_getter) ::godot::ClassDB::add_property(get_class_static(), m_property, m_setter, m_getter)
|
2021-08-18 14:03:52 +00:00
|
|
|
|
|
|
|
namespace godot {
|
|
|
|
|
2023-02-17 16:49:09 +00:00
|
|
|
namespace internal {
|
|
|
|
|
|
|
|
Object *get_object_instance_binding(GodotObject *);
|
|
|
|
|
|
|
|
} // namespace internal
|
|
|
|
|
2021-08-18 14:03:52 +00:00
|
|
|
struct MethodInfo {
|
2022-10-22 17:42:48 +00:00
|
|
|
StringName name;
|
2021-08-18 14:03:52 +00:00
|
|
|
PropertyInfo return_val;
|
|
|
|
uint32_t flags;
|
|
|
|
int id = 0;
|
|
|
|
std::vector<PropertyInfo> arguments;
|
|
|
|
std::vector<Variant> default_arguments;
|
|
|
|
|
|
|
|
inline bool operator==(const MethodInfo &p_method) const { return id == p_method.id; }
|
|
|
|
inline bool operator<(const MethodInfo &p_method) const { return id == p_method.id ? (name < p_method.name) : (id < p_method.id); }
|
|
|
|
|
|
|
|
operator Dictionary() const;
|
|
|
|
|
|
|
|
static MethodInfo from_dict(const Dictionary &p_dict);
|
|
|
|
|
|
|
|
MethodInfo();
|
2022-10-22 17:42:48 +00:00
|
|
|
MethodInfo(StringName p_name);
|
2021-08-18 14:03:52 +00:00
|
|
|
template <class... Args>
|
2022-10-22 17:42:48 +00:00
|
|
|
MethodInfo(StringName p_name, const Args &...args);
|
2021-08-18 14:03:52 +00:00
|
|
|
MethodInfo(Variant::Type ret);
|
2022-10-22 17:42:48 +00:00
|
|
|
MethodInfo(Variant::Type ret, StringName p_name);
|
2021-08-18 14:03:52 +00:00
|
|
|
template <class... Args>
|
2022-10-22 17:42:48 +00:00
|
|
|
MethodInfo(Variant::Type ret, StringName p_name, const Args &...args);
|
|
|
|
MethodInfo(const PropertyInfo &p_ret, StringName p_name);
|
2021-08-18 14:03:52 +00:00
|
|
|
template <class... Args>
|
2022-10-22 17:42:48 +00:00
|
|
|
MethodInfo(const PropertyInfo &p_ret, StringName p_name, const Args &...);
|
2021-08-18 14:03:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
template <class... Args>
|
2022-10-22 17:42:48 +00:00
|
|
|
MethodInfo::MethodInfo(StringName p_name, const Args &...args) :
|
2022-12-07 13:11:44 +00:00
|
|
|
name(p_name), flags(GDEXTENSION_METHOD_FLAG_NORMAL) {
|
2021-08-18 14:03:52 +00:00
|
|
|
arguments = { args... };
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class... Args>
|
2022-10-22 17:42:48 +00:00
|
|
|
MethodInfo::MethodInfo(Variant::Type ret, StringName p_name, const Args &...args) :
|
2022-12-07 13:11:44 +00:00
|
|
|
name(p_name), flags(GDEXTENSION_METHOD_FLAG_NORMAL) {
|
2021-08-18 14:03:52 +00:00
|
|
|
return_val.type = ret;
|
|
|
|
arguments = { args... };
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class... Args>
|
2022-10-22 17:42:48 +00:00
|
|
|
MethodInfo::MethodInfo(const PropertyInfo &p_ret, StringName p_name, const Args &...args) :
|
2022-12-07 13:11:44 +00:00
|
|
|
name(p_name), return_val(p_ret), flags(GDEXTENSION_METHOD_FLAG_NORMAL) {
|
2021-08-18 14:03:52 +00:00
|
|
|
arguments = { args... };
|
|
|
|
}
|
|
|
|
|
2022-03-16 18:33:06 +00:00
|
|
|
class ObjectID {
|
|
|
|
uint64_t id = 0;
|
|
|
|
|
|
|
|
public:
|
|
|
|
_FORCE_INLINE_ bool is_ref_counted() const { return (id & (uint64_t(1) << 63)) != 0; }
|
|
|
|
_FORCE_INLINE_ bool is_valid() const { return id != 0; }
|
|
|
|
_FORCE_INLINE_ bool is_null() const { return id == 0; }
|
|
|
|
_FORCE_INLINE_ operator uint64_t() const { return id; }
|
|
|
|
_FORCE_INLINE_ operator int64_t() const { return id; }
|
|
|
|
|
|
|
|
_FORCE_INLINE_ bool operator==(const ObjectID &p_id) const { return id == p_id.id; }
|
|
|
|
_FORCE_INLINE_ bool operator!=(const ObjectID &p_id) const { return id != p_id.id; }
|
|
|
|
_FORCE_INLINE_ bool operator<(const ObjectID &p_id) const { return id < p_id.id; }
|
|
|
|
|
|
|
|
_FORCE_INLINE_ void operator=(int64_t p_int64) { id = p_int64; }
|
|
|
|
_FORCE_INLINE_ void operator=(uint64_t p_uint64) { id = p_uint64; }
|
|
|
|
|
|
|
|
_FORCE_INLINE_ ObjectID() {}
|
|
|
|
_FORCE_INLINE_ explicit ObjectID(const uint64_t p_id) { id = p_id; }
|
|
|
|
_FORCE_INLINE_ explicit ObjectID(const int64_t p_id) { id = p_id; }
|
|
|
|
};
|
|
|
|
|
2022-03-08 08:11:34 +00:00
|
|
|
class ObjectDB {
|
|
|
|
public:
|
|
|
|
static Object *get_instance(uint64_t p_object_id) {
|
2023-04-24 16:45:45 +00:00
|
|
|
GDExtensionObjectPtr obj = internal::gdextension_interface_object_get_instance_from_id(p_object_id);
|
2022-03-08 08:11:34 +00:00
|
|
|
if (obj == nullptr) {
|
|
|
|
return nullptr;
|
|
|
|
}
|
2023-02-17 16:49:09 +00:00
|
|
|
return internal::get_object_instance_binding(obj);
|
2022-03-08 08:11:34 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2021-08-18 14:03:52 +00:00
|
|
|
template <class T>
|
|
|
|
T *Object::cast_to(Object *p_object) {
|
2022-07-25 22:41:57 +00:00
|
|
|
if (p_object == nullptr) {
|
|
|
|
return nullptr;
|
|
|
|
}
|
2022-10-22 17:42:48 +00:00
|
|
|
StringName class_name = T::get_class_static();
|
2023-04-24 16:45:45 +00:00
|
|
|
GDExtensionObjectPtr casted = internal::gdextension_interface_object_cast_to(p_object->_owner, internal::gdextension_interface_classdb_get_class_tag(class_name._native_ptr()));
|
2021-08-18 14:03:52 +00:00
|
|
|
if (casted == nullptr) {
|
|
|
|
return nullptr;
|
|
|
|
}
|
2023-02-17 16:49:09 +00:00
|
|
|
return dynamic_cast<T *>(internal::get_object_instance_binding(casted));
|
2021-08-18 14:03:52 +00:00
|
|
|
}
|
|
|
|
|
2022-09-18 21:23:49 +00:00
|
|
|
template <class T>
|
|
|
|
const T *Object::cast_to(const Object *p_object) {
|
|
|
|
if (p_object == nullptr) {
|
|
|
|
return nullptr;
|
|
|
|
}
|
2022-10-22 17:42:48 +00:00
|
|
|
StringName class_name = T::get_class_static();
|
2023-04-24 16:45:45 +00:00
|
|
|
GDExtensionObjectPtr casted = internal::gdextension_interface_object_cast_to(p_object->_owner, internal::gdextension_interface_classdb_get_class_tag(class_name._native_ptr()));
|
2022-09-18 21:23:49 +00:00
|
|
|
if (casted == nullptr) {
|
|
|
|
return nullptr;
|
|
|
|
}
|
2023-02-17 16:49:09 +00:00
|
|
|
return dynamic_cast<const T *>(internal::get_object_instance_binding(casted));
|
2022-09-18 21:23:49 +00:00
|
|
|
}
|
|
|
|
|
2021-08-18 14:03:52 +00:00
|
|
|
} // namespace godot
|
|
|
|
|
2022-10-09 06:47:07 +00:00
|
|
|
#endif // GODOT_OBJECT_HPP
|