| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241 |
- //********************************** Banshee Engine (www.banshee3d.com) **************************************************//
- //**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
- #pragma once
- #include <string>
- #include <algorithm>
- #include <unordered_map>
- #include "Prerequisites/BsPrerequisitesUtil.h"
- #include "Reflection/BsRTTIField.h"
- #include "Reflection/BsRTTIPlainField.h"
- #include "Reflection/BsRTTIReflectableField.h"
- #include "Reflection/BsRTTIReflectablePtrField.h"
- #include "Reflection/BsRTTIManagedDataBlockField.h"
- #include "Reflection/BsIReflectable.h"
- #include "Serialization/BsBinaryDiff.h"
- namespace bs
- {
- /** @addtogroup RTTI
- * @{
- */
- /**
- * Starts definitions for member fields within a RTTI type. Follow this with calls to BS_RTTI_MEMBER* calls, and finish by
- * calling BS_END_RTTI_MEMBERS. You must also initialize mInitMembers field in the parent class' constructor.
- */
- #define BS_BEGIN_RTTI_MEMBERS \
- struct META_FirstEntry {}; \
- void META_InitPrevEntry(META_FirstEntry typeId) { } \
- \
- typedef META_FirstEntry
- /**
- * Registers a new member field in the RTTI type. The field references the @p name member in the owner class.
- * The type of the member must be a valid plain type. Each field must specify a unique ID for @p id.
- */
- #define BS_RTTI_MEMBER_PLAIN(name, id) \
- META_Entry_##name; \
- \
- decltype(OwnerType::name)& get##name(OwnerType* obj) { return obj->name; } \
- void set##name(OwnerType* obj, decltype(OwnerType::name)& val) { obj->name = val; } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addPlainField(#name, id, &MyType::get##name, &MyType::set##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /** Same as BS_RTTI_MEMBER_PLAIN, but allows you to specify separate names for the field name and the member variable. */
- #define BS_RTTI_MEMBER_PLAIN_NAMED(name, field, id) \
- META_Entry_##name; \
- \
- decltype(OwnerType::field)& get##name(OwnerType* obj) { return obj->field; } \
- void set##name(OwnerType* obj, decltype(OwnerType::field)& val) { obj->field = val; } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addPlainField(#name, id, &MyType::get##name, &MyType::set##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /**
- * Registers a new member field in the RTTI type. The field references the @p name member in the owner class.
- * The type of the member must be an array of valid plain types. Each field must specify a unique ID for @p id.
- */
- #define BS_RTTI_MEMBER_PLAIN_ARRAY(name, id) \
- META_Entry_##name; \
- \
- std::common_type<decltype(OwnerType::name)>::type::value_type& get##name(OwnerType* obj, UINT32 idx) { return obj->name[idx]; } \
- void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::name)>::type::value_type& val) { obj->name[idx] = val; } \
- UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->name.size(); } \
- void setSize##name(OwnerType* obj, UINT32 val) { obj->name.resize(val); } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addPlainArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, &MyType::set##name, &MyType::setSize##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /**
- * Same as BS_RTTI_MEMBER_PLAIN_ARRAY, but allows you to specify separate names for the field name and the member variable.
- */
- #define BS_RTTI_MEMBER_PLAIN_ARRAY_NAMED(name, field, id) \
- META_Entry_##name; \
- \
- std::common_type<decltype(OwnerType::field)>::type::value_type& get##name(OwnerType* obj, UINT32 idx) { return obj->field[idx]; } \
- void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::field)>::type::value_type& val) { obj->field[idx] = val; } \
- UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->field.size(); } \
- void setSize##name(OwnerType* obj, UINT32 val) { obj->field.resize(val); } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addPlainArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, &MyType::set##name, &MyType::setSize##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /**
- * Registers a new member field in the RTTI type. The field references the @p name member in the owner class.
- * The type of the member must be a valid reflectable (non-pointer) type. Each field must specify a unique ID for @p id.
- */
- #define BS_RTTI_MEMBER_REFL(name, id) \
- META_Entry_##name; \
- \
- decltype(OwnerType::name)& get##name(OwnerType* obj) { return obj->name; } \
- void set##name(OwnerType* obj, decltype(OwnerType::name)& val) { obj->name = val; } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addReflectableField(#name, id, &MyType::get##name, &MyType::set##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /** Same as BS_RTTI_MEMBER_REFL, but allows you to specify separate names for the field name and the member variable. */
- #define BS_RTTI_MEMBER_REFL_NAMED(name, field, id) \
- META_Entry_##name; \
- \
- decltype(OwnerType::field)& get##name(OwnerType* obj) { return obj->field; } \
- void set##name(OwnerType* obj, decltype(OwnerType::field)& val) { obj->field = val; } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addReflectableField(#name, id, &MyType::get##name, &MyType::set##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /**
- * Registers a new member field in the RTTI type. The field references the @p name member in the owner class.
- * The type of the member must be an array of valid reflectable (non-pointer) types. Each field must specify a unique ID for
- * @p id.
- */
- #define BS_RTTI_MEMBER_REFL_ARRAY(name, id) \
- META_Entry_##name; \
- \
- std::common_type<decltype(OwnerType::name)>::type::value_type& get##name(OwnerType* obj, UINT32 idx) { return obj->name[idx]; } \
- void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::name)>::type::value_type& val) { obj->name[idx] = val; } \
- UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->name.size(); } \
- void setSize##name(OwnerType* obj, UINT32 val) { obj->name.resize(val); } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addReflectableArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, &MyType::set##name, &MyType::setSize##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /**
- * Same as BS_RTTI_MEMBER_REFL_ARRAY, but allows you to specify separate names for the field name and the member variable.
- */
- #define BS_RTTI_MEMBER_REFL_ARRAY_NAMED(name, field, id) \
- META_Entry_##name; \
- \
- std::common_type<decltype(OwnerType::field)>::type::value_type& get##name(OwnerType* obj, UINT32 idx) { return obj->field[idx]; } \
- void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::field)>::type::value_type& val) { obj->field[idx] = val; } \
- UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->field.size(); } \
- void setSize##name(OwnerType* obj, UINT32 val) { obj->field.resize(val); } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addReflectableArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, &MyType::set##name, &MyType::setSize##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /**
- * Registers a new member field in the RTTI type. The field references the @p name member in the owner class.
- * The type of the member must be a valid reflectable pointer type. Each field must specify a unique ID for @p id.
- */
- #define BS_RTTI_MEMBER_REFLPTR(name, id) \
- META_Entry_##name; \
- \
- decltype(OwnerType::name) get##name(OwnerType* obj) { return obj->name; } \
- void set##name(OwnerType* obj, decltype(OwnerType::name) val) { obj->name = val; } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addReflectablePtrField(#name, id, &MyType::get##name, &MyType::set##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /** Same as BS_RTTI_MEMBER_REFLPTR, but allows you to specify separate names for the field name and the member variable. */
- #define BS_RTTI_MEMBER_REFLPTR_NAMED(name, field, id) \
- META_Entry_##name; \
- \
- decltype(OwnerType::field) get##name(OwnerType* obj) { return obj->field; } \
- void set##name(OwnerType* obj, decltype(OwnerType::field) val) { obj->field = val; } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addReflectablePtrField(#name, id, &MyType::get##name, &MyType::set##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /**
- * Registers a new member field in the RTTI type. The field references the @p name member in the owner class.
- * The type of the member must be a valid reflectable pointer type. Each field must specify a unique ID for @p id.
- */
- #define BS_RTTI_MEMBER_REFLPTR_ARRAY(name, id) \
- META_Entry_##name; \
- \
- std::common_type<decltype(OwnerType::name)>::type::value_type get##name(OwnerType* obj, UINT32 idx) { return obj->name[idx]; } \
- void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::name)>::type::value_type val) { obj->name[idx] = val; } \
- UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->name.size(); } \
- void setSize##name(OwnerType* obj, UINT32 val) { obj->name.resize(val); } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addReflectablePtrArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, &MyType::set##name, &MyType::setSize##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /**
- * Same as BS_RTTI_MEMBER_REFLPTR_ARRAY, but allows you to specify separate names for the field name and the member
- * variable.
- */
- #define BS_RTTI_MEMBER_REFLPTR_ARRAY_NAMED(name, field, id) \
- META_Entry_##name; \
- \
- std::common_type<decltype(OwnerType::field)>::type::value_type get##name(OwnerType* obj, UINT32 idx) { return obj->field[idx]; } \
- void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::field)>::type::value_type val) { obj->field[idx] = val; } \
- UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->field.size(); } \
- void setSize##name(OwnerType* obj, UINT32 val) { obj->field.resize(val); } \
- \
- struct META_NextEntry_##name{}; \
- void META_InitPrevEntry(META_NextEntry_##name typeId) \
- { \
- addReflectablePtrArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, &MyType::set##name, &MyType::setSize##name); \
- META_InitPrevEntry(META_Entry_##name()); \
- } \
- \
- typedef META_NextEntry_##name
- /** Ends definitions for member fields with a RTTI type. Must follow BS_BEGIN_RTTI_MEMBERS. */
- #define BS_END_RTTI_MEMBERS \
- META_LastEntry; \
- \
- struct META_InitAllMembers \
- { \
- META_InitAllMembers(MyType* owner) \
- { \
- owner->META_InitPrevEntry(META_LastEntry()); \
- } \
- }; \
- \
- META_InitAllMembers mInitMembers;
- /** @} */
- /** @addtogroup Internal-Utility
- * @{
- */
- /** @addtogroup RTTI-Internal
- * @{
- */
- /**
- * Provides an interface for accessing fields of a certain class.
- * Data can be easily accessed by getter and setter methods.
- *
- * Supported data types:
- * - Plain types - All types defined in BsRTTIField.h, mostly native types and POD (plain old data) structs. Data is parsed byte by byte.
- * No pointers to plain types are supported. Data is passed around by value.
- * - Reflectable types - Any class deriving from IReflectable. Data is parsed based on fields in its RTTI class. Can be pointer or value type.
- * - Arrays of both plain and reflectable types are supported
- * - Data blocks - A managed or unmanaged block of data. See ManagedDataBlock.
- */
- class BS_UTILITY_EXPORT RTTITypeBase
- {
- public:
- RTTITypeBase();
- virtual ~RTTITypeBase();
- /** Returns RTTI type information for all classes that derive from the class that owns this RTTI type. */
- virtual Vector<RTTITypeBase*>& getDerivedClasses() = 0;
- /**
- * Returns RTTI type information for the class that owns this RTTI type. If the class has not base type, null is
- * returned instead.
- */
- virtual RTTITypeBase* getBaseClass() = 0;
- /** Returns true if current RTTI class is derived from @p base. (Or if it is the same type as base) */
- virtual bool isDerivedFrom(RTTITypeBase* base) = 0;
- /** Creates a new instance of the class owning this RTTI type. */
- virtual SPtr<IReflectable> newRTTIObject() = 0;
- /** Returns the name of the class owning this RTTI type. */
- virtual const String& getRTTIName() = 0;
- /** Returns an RTTI id that uniquely represents each class in the RTTI system. */
- virtual UINT32 getRTTIId() = 0;
- /**
- * Called by the serializers when serialization for this object has started. Use this to do any preprocessing on
- * data you might need during serialization itself.
- */
- virtual void onSerializationStarted(IReflectable* obj, const UnorderedMap<String, UINT64>& params) {}
- /**
- * Called by the serializers when serialization for this object has ended. After serialization has ended you can
- * be sure that the type has been fully serialized, and you may clean up any temporary data.
- */
- virtual void onSerializationEnded(IReflectable* obj, const UnorderedMap<String, UINT64>& params) {}
- /**
- * Called by the serializers when deserialization for this object has started. Use this to do any preprocessing
- * on data you might need during deserialization itself.
- */
- virtual void onDeserializationStarted(IReflectable* obj, const UnorderedMap<String, UINT64>& params) {}
- /**
- * Called by the serializers when deserialization for this object has ended. At this point you can be sure the
- * instance has been fully deserialized and you may safely use it.
- *
- * One exception being are fields you marked with RTTI_Flag_WeakRef, as they might be resolved only after
- * deserialization has fully completed for all objects.
- */
- virtual void onDeserializationEnded(IReflectable* obj, const UnorderedMap<String, UINT64>& params) {}
- /**
- * Returns a handler that determines how are "diffs" generated and applied when it comes to objects of this RTTI
- * type. A "diff" is a list of differences between two objects that may be saved, viewed or applied to another
- * object to transform it.
- */
- virtual IDiff& getDiffHandler() const
- {
- static BinaryDiff diffHandler;
- return diffHandler;
- }
- /**
- * Allows you to assign a value to a plain field with the specified name on the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType, class DataType>
- void setPlainValue(ObjectType* object, const String& name, DataType& value)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsPlain(false);
- RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
- UINT32 typeSize = 0;
- if(RTTIPlainType<DataType>::hasDynamicSize)
- typeSize = RTTIPlainType<DataType>::getDynamicSize(value);
- else
- typeSize = sizeof(DataType);
- UINT8* tempBuffer = (UINT8*)bs_stack_alloc(typeSize);
- RTTIPlainType<DataType>::toMemory(value, (char*)tempBuffer);
-
- field->fromBuffer(object, tempBuffer);
- bs_stack_free(tempBuffer);
- }
- /**
- * Allows you to assign a value to a plain field array element with the specified name and index on the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType, class DataType>
- void setPlainArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsPlain(true);
- RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
- UINT32 typeSize = 0;
- if(RTTIPlainType<DataType>::hasDynamicSize)
- typeSize = RTTIPlainType<DataType>::getDynamicSize(value);
- else
- typeSize = sizeof(DataType);
- UINT8* tempBuffer = (UINT8*)bs_stack_alloc(typeSize);
- RTTIPlainType<DataType>::toMemory(value, (char*)tempBuffer);
- field->arrayElemFromBuffer(object, index, tempBuffer);
- bs_stack_free(tempBuffer);
- }
- /**
- * Allows you to assign a value to a reflectable field with the specified name on the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType, class DataType>
- void setReflectableValue(ObjectType* object, const String& name, DataType& value)
- {
- static_assert((std::is_base_of<bs::IReflectable, DataType>::value),
- "Invalid data type for complex field. It needs to derive from bs::IReflectable.");
- RTTIField* genericField = findField(name);
- genericField->checkIsComplex(false);
- RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
- field->setValue(object, value);
- }
- /**
- * Allows you to assign a value to a reflectable field array element with the specified name and index on the
- * provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType, class DataType>
- void setReflectableArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
- {
- static_assert((std::is_base_of<bs::IReflectable, DataType>::value),
- "Invalid data type for complex field. It needs to derive from bs::IReflectable.");
- RTTIField* genericField = findField(name);
- genericField->checkIsComplex(true);
- RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
- field->setArrayValue(object, index, value);
- }
- /**
- * Allows you to assign a value to a managed data block field with the specified name on the provided instance.
- *
- * @note Caller must ensure instance type is valid for this field.
- */
- template <class ObjectType>
- void setDataBlockValue(ObjectType* object, const String& name, const SPtr<DataStream>& value, UINT32 size)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsDataBlock();
- RTTIManagedDataBlockFieldBase* field = static_cast<RTTIManagedDataBlockFieldBase*>(genericField);
- field->setValue(object, value, size);
- }
- /**
- * Allows you to assign a value to a reflectable pointer field with the specified name on the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType, class DataType>
- void setReflectablePtrValue(ObjectType* object, const String& name, SPtr<DataType> value)
- {
- static_assert((std::is_base_of<bs::IReflectable, DataType>::value),
- "Invalid data type for complex field. It needs to derive from bs::IReflectable.");
- RTTIField* genericField = findField(name);
- genericField->checkIsComplexPtr(false);
- RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
- field->setValue(object, value);
- }
- /**
- * Allows you to assign a value to a reflectable pointer field array element with the specified name and index on
- * the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType, class DataType>
- void setReflectablePtrArrayValue(ObjectType* object, const String& name, UINT32 index, SPtr<DataType> value)
- {
- static_assert((std::is_base_of<bs::IReflectable, DataType>::value),
- "Invalid data type for complex field. It needs to derive from bs::IReflectable.");
- RTTIField* genericField = findField(name);
- genericField->checkIsComplexPtr(true);
- RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
- field->setArrayValue(object, index, value);
- }
- /**
- * Reads a value from a plain field with the specified name from the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType, class DataType>
- void getPlainValue(ObjectType* object, const String& name, DataType& value)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsPlain(false);
- RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
- UINT32 typeSize = 0;
- if(field->hasDynamicSize())
- typeSize = field->getDynamicSize(object);
- else
- typeSize = field->getTypeSize();
- UINT8* tempBuffer = (UINT8*)bs_stack_alloc(typeSize);
- field->toBuffer(object, tempBuffer);
- RTTIPlainType<DataType>::fromMemory(value, (char*)tempBuffer);
- bs_stack_free(tempBuffer);
- }
- /**
- * Reads a value from a plain array field with the specified name and index from the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType, class DataType>
- void getPlainArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsPlain(true);
- RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
- UINT32 typeSize = 0;
- if(field->hasDynamicSize())
- typeSize = field->getArrayElemDynamicSize(object, index);
- else
- typeSize = field->getTypeSize();
- UINT8* tempBuffer = (UINT8*)bs_stack_alloc(typeSize);
- field->arrayElemToBuffer(object, index, tempBuffer);
- RTTIPlainType<DataType>::fromMemory(value, (char*)tempBuffer);
- bs_stack_free(tempBuffer);
- }
- /**
- * Reads a value from a reflectable object field with the specified name from the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType>
- IReflectable& getReflectableValue(ObjectType* object, const String& name)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsComplex(false);
- RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
- return field->getValue(object);
- }
- /**
- * Reads a value from a reflectable object array field with the specified name and index from the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType>
- IReflectable& getReflectableArrayValue(ObjectType* object, const String& name, UINT32 index)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsComplex(true);
- RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
- return field->getArrayValue(object, index);
- }
- /**
- * Reads a managed data block field with the specified name from the provided instance.
- *
- * @note Caller must ensure instance type is valid for this field.
- */
- template <class ObjectType>
- SPtr<DataStream> getDataBlockValue(ObjectType* object, const String& name, UINT32& size)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsDataBlock();
- RTTIManagedDataBlockFieldBase* field = static_cast<RTTIManagedDataBlockFieldBase*>(genericField);
- return field->getValue(object, size);
- }
- /**
- * Reads a value from a reflectable object pointer field with the specified name from the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType>
- SPtr<IReflectable> getReflectablePtrValue(ObjectType* object, const String& name)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsComplexPtr(false);
- RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
- return field->getValue(object);
- }
- /**
- * Reads a value from a reflectable pointer array field with the specified name and index from the provided instance.
- *
- * @note Caller must ensure instance and value types are valid for this field.
- */
- template <class ObjectType>
- SPtr<IReflectable> getReflectablePtrArrayValue(ObjectType* object, const String& name, UINT32 index)
- {
- RTTIField* genericField = findField(name);
- genericField->checkIsComplexPtr(true);
- RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
- return field->getArrayValue(object, index);
- }
- /**
- * Returns the size of the array of the field with the specified name on the provided instance.
- *
- * @note Caller must ensure instance type is valid and that the field as an array.
- */
- template <class ObjectType>
- UINT32 getArraySize(ObjectType* object, const String& name)
- {
- RTTIField* field = findField(name);
- return field->getArraySize(object);
- }
- /**
- * Sets the size of the array of the field with the specified name on the provided instance.
- *
- * @note
- * Caller must ensure instance type is valid and that the field as an array. This might clear any existing data
- * from the array.
- */
- template <class ObjectType>
- void setArraySize(ObjectType* object, const String& name, UINT32 size)
- {
- RTTIField* field = findField(name);
- field->setArraySize(object, size);
- }
- /** Returns the total number of fields in this RTTI type. */
- UINT32 getNumFields() const { return (UINT32)mFields.size(); }
- /** Returns a field based on the field index. Use getNumFields() to get total number of fields available. */
- RTTIField* getField(UINT32 idx) { return mFields.at(idx); }
- /**
- * Tries to find a field with the specified name. Throws an exception if it can't.
- *
- * @param name The name of the field.
- */
- RTTIField* findField(const String& name);
- /**
- * Tries to find a field with the specified unique ID. Doesn't throw an exception if it can't find the field
- * (Unlike findField(const String&)).
- *
- * @param uniqueFieldId Unique identifier for the field.
- *
- * @return nullptr if it can't find the field.
- */
- RTTIField* findField(int uniqueFieldId);
- /** @name Internal
- * @{
- */
- /** Called by the RTTI system when a class is first found in order to form child/parent class hierarchy. */
- virtual void _registerDerivedClass(RTTITypeBase* derivedClass) = 0;
- /** @} */
- protected:
- /**
- * Tries to add a new field to the fields array, and throws an exception if a field with the same name or id
- * already exists.
- *
- * @param[in] field Field, must be non-null.
- */
- void addNewField(RTTIField* field);
- private:
- Vector<RTTIField*> mFields;
- };
- /** Used for initializing a certain type as soon as the program is loaded. */
- template<typename Type, typename BaseType>
- struct InitRTTIOnStart
- {
- public:
- InitRTTIOnStart()
- {
- BaseType::getRTTIStatic()->_registerDerivedClass(Type::getRTTIStatic());
- }
- void makeSureIAmInstantiated() { }
- };
- /** Specialization for root class of RTTI hierarchy - IReflectable */
- template<typename Type>
- struct InitRTTIOnStart<Type, IReflectable>
- {
- public:
- InitRTTIOnStart()
- {
- IReflectable::_registerDerivedClass(Type::getRTTIStatic());
- }
- void makeSureIAmInstantiated() { }
- };
- /**
- * Template that returns RTTI type of the specified type, unless the specified type is IReflectable in which case it
- * returns a null.
- */
- template<typename Type>
- struct GetRTTIType
- {
- RTTITypeBase* operator()() { return Type::getRTTIStatic(); }
- };
- /** Specialization for root class of RTTI hierarchy - IReflectable. */
- template<>
- struct GetRTTIType<IReflectable>
- {
- RTTITypeBase* operator()() { return nullptr; }
- };
- /** @} */
- /** @} */
- /** @addtogroup RTTI
- * @{
- */
- /**
- * Allows you to provide a run-time type information for a specific class, along with support for
- * serialization/deserialization.
- *
- * Derive from this class and return the that class from IReflectable::getRTTI. This way you can separate serialization
- * logic from the actual class you're serializing.
- *
- * This class will provide a way to register individual fields in the class, together with ways to read and write them,
- * as well a providing information about class hierarchy, and run-time type checking.
- */
- template <typename Type, typename BaseType, typename MyRTTIType>
- class RTTIType : public RTTITypeBase
- {
- protected:
- /************************************************************************/
- /* RTTI CLASS META DATA */
- /************************************************************************/
- static InitRTTIOnStart<Type, BaseType> initOnStart;
- public:
- RTTIType()
- {
- // Compiler will only generate code for stuff that is directly used, including static data members,
- // so we fool it here like we're using the class directly. Otherwise compiler won't generate the code for the member
- // and our type won't get initialized on start (Actual behavior is a bit more random)
- initOnStart.makeSureIAmInstantiated();
- }
- virtual ~RTTIType() {}
- /** Returns a singleton of this RTTI type. */
- static MyRTTIType* instance()
- {
- static MyRTTIType inst;
- return &inst;
- }
- /** @copydoc RTTITypeBase::getDerivedClasses */
- Vector<RTTITypeBase*>& getDerivedClasses() override
- {
- static Vector<RTTITypeBase*> mRTTIDerivedClasses;
- return mRTTIDerivedClasses;
- }
- /** @copydoc RTTITypeBase::getBaseClass */
- RTTITypeBase* getBaseClass() override
- {
- return GetRTTIType<BaseType>()();
- }
- /** @copydoc RTTITypeBase::isDerivedFrom */
- bool isDerivedFrom(RTTITypeBase* base) override
- {
- assert(base != nullptr);
- Stack<RTTITypeBase*> todo;
- todo.push(base);
- while (!todo.empty())
- {
- RTTITypeBase* currentType = todo.top();
- todo.pop();
- if (currentType->getRTTIId() == getRTTIId())
- return true;
- const Vector<RTTITypeBase*>& derivedClasses = currentType->getDerivedClasses();
- for (auto iter = derivedClasses.begin(); iter != derivedClasses.end(); ++iter)
- todo.push(*iter);
- }
- return false;
- }
- /** @copydoc RTTITypeBase::_registerDerivedClass */
- void _registerDerivedClass(RTTITypeBase* derivedClass) override
- {
- if(IReflectable::_isTypeIdDuplicate(derivedClass->getRTTIId()))
- {
- BS_EXCEPT(InternalErrorException, "RTTI type \"" + derivedClass->getRTTIName() +
- "\" has a duplicate ID: " + toString(derivedClass->getRTTIId()));
- }
- getDerivedClasses().push_back(derivedClass);
- }
- /************************************************************************/
- /* FIELDS OPERATING DIRECTLY ON SERIALIZABLE OBJECT */
- /************************************************************************/
- /**
- * Registers a new plain field. This field can then be accessed dynamically from the RTTI system and used for
- * automatic serialization. See RTTIField for more information about field types.
- *
- * @param[in] name Name of the field.
- * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
- * small data type that can be used for efficiently serializing data to disk and similar.
- * It is primarily used for compatibility between different versions of serialized data.
- * @param[in] getter Method used for retrieving the value of this field.
- * @param[in] setter Method used for setting the value of this field.
- * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
- */
- template<class ObjectType, class DataType>
- void addPlainField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(),
- void (ObjectType::*setter)(DataType&) = nullptr, UINT64 flags = 0)
- {
- addPlainField<ObjectType, DataType>(name, uniqueId,
- std::function<DataType&(ObjectType*)>(getter),
- std::function<void(ObjectType*, DataType&)>(setter), flags);
- }
- /**
- * Registers a new reflectable object field. This field can then be accessed dynamically from the RTTI system and
- * used for automatic serialization. See RTTIField for more information about field types.
- *
- * @param[in] name Name of the field.
- * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
- * small data type that can be used for efficiently serializing data to disk and similar.
- * It is primarily used for compatibility between different versions of serialized data.
- * @param[in] getter Method used for retrieving the value of this field.
- * @param[in] setter Method used for setting the value of this field.
- * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
- */
- template<class ObjectType, class DataType>
- void addReflectableField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(),
- void (ObjectType::*setter)(DataType&) = nullptr, UINT64 flags = 0)
- {
- addReflectableField<ObjectType, DataType>(name, uniqueId,
- std::function<DataType&(ObjectType*)>(getter),
- std::function<void(ObjectType*, DataType&)>(setter), flags);
- }
- /**
- * Registers a new reflectable object pointer field. This field can then be accessed dynamically from the RTTI
- * system and used for automatic serialization. See RTTIField for more information about field types.
- *
- * @param[in] name Name of the field.
- * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
- * small data type that can be used for efficiently serializing data to disk and similar.
- * It is primarily used for compatibility between different versions of serialized data.
- * @param[in] getter Method used for retrieving the value of this field.
- * @param[in] setter Method used for setting the value of this field.
- * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
- */
- template<class ObjectType, class DataType>
- void addReflectablePtrField(const String& name, UINT32 uniqueId, SPtr<DataType> (ObjectType::*getter)(),
- void (ObjectType::*setter)(SPtr<DataType>) = nullptr, UINT64 flags = 0)
- {
- addReflectablePtrField<ObjectType, DataType>(name, uniqueId,
- std::function<SPtr<DataType>(ObjectType*)>(getter),
- std::function<void(ObjectType*, SPtr<DataType>)>(setter), flags);
- }
- /**
- * Registers a new field containg an array of plain values. This field can then be accessed dynamically from the
- * RTTI system and used for automatic serialization. See RTTIField for more information about field types.
- *
- * @param[in] name Name of the field.
- * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
- * small data type that can be used for efficiently serializing data to disk and similar.
- * It is primarily used for compatibility between different versions of serialized data.
- * @param[in] getter Method used for retrieving a single element of the array.
- * @param[in] getSize Getter method that returns the size of the array.
- * @param[in] setter Method used for setting the a single element of the field.
- * @param[in] setSize Setter method that allows you to resize the array.
- * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
- */
- template<class ObjectType, class DataType>
- void addPlainArrayField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
- void (ObjectType::*setter)(UINT32, DataType&) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
- {
- addPlainArrayField<ObjectType, DataType>(name, uniqueId,
- std::function<DataType&(ObjectType*, UINT32)>(getter),
- std::function<UINT32(ObjectType*)>(getSize),
- std::function<void(ObjectType*, UINT32, DataType&)>(setter),
- std::function<void(ObjectType*, UINT32)>(setSize), flags);
- }
- /**
- * Registers a new field containg an array of reflectable object values. This field can then be accessed dynamically
- * from the RTTI system and used for automatic serialization. See RTTIField for more information about field types.
- *
- * @param[in] name Name of the field.
- * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
- * small data type that can be used for efficiently serializing data to disk and similar.
- * It is primarily used for compatibility between different versions of serialized data.
- * @param[in] getter Method used for retrieving a single element of the array.
- * @param[in] getSize Getter method that returns the size of the array.
- * @param[in] setter Method used for setting the a single element of the field.
- * @param[in] setSize Setter method that allows you to resize the array.
- * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
- */
- template<class ObjectType, class DataType>
- void addReflectableArrayField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
- void (ObjectType::*setter)(UINT32, DataType&) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
- {
- addReflectableArrayField<ObjectType, DataType>(name, uniqueId,
- std::function<DataType&(ObjectType*, UINT32)>(getter),
- std::function<UINT32(ObjectType*)>(getSize),
- std::function<void(ObjectType*, UINT32, DataType&)>(setter),
- std::function<void(ObjectType*, UINT32)>(setSize), flags);
- }
- /**
- * Registers a new field containg an array of reflectable obejct pointers. This field can then be accessed
- * dynamically from the RTTI system and used for automatic serialization. See RTTIField for more information
- * about field types.
- *
- * @param[in] name Name of the field.
- * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
- * small data type that can be used for efficiently serializing data to disk and similar.
- * It is primarily used for compatibility between different versions of serialized data.
- * @param[in] getter Method used for retrieving a single element of the array.
- * @param[in] getSize Getter method that returns the size of the array.
- * @param[in] setter Method used for setting the a single element of the field.
- * @param[in] setSize Setter method that allows you to resize the array.
- * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
- */
- template<class ObjectType, class DataType>
- void addReflectablePtrArrayField(const String& name, UINT32 uniqueId, SPtr<DataType> (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
- void (ObjectType::*setter)(UINT32, SPtr<DataType>) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
- {
- addReflectablePtrArrayField<ObjectType, DataType>(name, uniqueId,
- std::function<SPtr<DataType>(ObjectType*, UINT32)>(getter),
- std::function<UINT32(ObjectType*)>(getSize),
- std::function<void(ObjectType*, UINT32, SPtr<DataType>)>(setter),
- std::function<void(ObjectType*, UINT32)>(setSize), flags);
- }
- /**
- * Registers a new managed data block field. This field can then be accessed dynamically from the RTTI system and
- * used for automatic serialization. See RTTIField for more information about field types.
- *
- * @param[in] name Name of the field.
- * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
- * small data type that can be used for efficiently serializing data to disk and similar.
- * It is primarily used for compatibility between different versions of serialized data.
- * @param[in] getter Method used for retrieving the value of this field.
- * @param[in] setter Method used for setting the value of this field.
- * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
- */
- template<class ObjectType>
- void addDataBlockField(const String& name, UINT32 uniqueId, SPtr<DataStream> (ObjectType::*getter)(UINT32&),
- void (ObjectType::*setter)(const SPtr<DataStream>&, UINT32) = nullptr, UINT64 flags = 0)
- {
- addDataBlockField<ObjectType>(name, uniqueId,
- std::function<SPtr<DataStream>(ObjectType*, UINT32&)>(getter),
- std::function<void(ObjectType*, const SPtr<DataStream>&, UINT32)>(setter), flags);
- }
- protected:
- typedef Type OwnerType;
- typedef MyRTTIType MyType;
- virtual void initSerializableFields() {}
- /************************************************************************/
- /* FIELDS OPERATING ON DERIVED SERIALIZATION INTERFACE */
- /* (Needs an extra pointer to the actual object) */
- /************************************************************************/
- template<class InterfaceType, class ObjectType, class DataType>
- void addPlainField(const String& name, UINT32 uniqueId,
- DataType& (InterfaceType::*getter)(ObjectType*),
- void (InterfaceType::*setter)(ObjectType*, DataType&), UINT64 flags = 0)
- {
- using namespace std::placeholders;
- static_assert((std::is_base_of<bs::RTTIType<Type, BaseType, MyRTTIType>, InterfaceType>::value),
- "Class with the get/set methods must derive from bs::RTTIType.");
- static_assert(!(std::is_base_of<bs::IReflectable, DataType>::value),
- "Data type derives from IReflectable but it is being added as a plain field.");
- addPlainField<ObjectType, DataType>(name, uniqueId,
- std::function<DataType&(ObjectType*)>(std::bind(getter, static_cast<InterfaceType*>(this), _1)),
- std::function<void(ObjectType*, DataType&)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
- }
- template<class InterfaceType, class ObjectType, class DataType>
- void addReflectableField(const String& name, UINT32 uniqueId,
- DataType& (InterfaceType::*getter)(ObjectType*),
- void (InterfaceType::*setter)(ObjectType*, DataType&), UINT64 flags = 0)
- {
- using namespace std::placeholders;
- addReflectableField<ObjectType, DataType>(name, uniqueId,
- std::function<DataType&(ObjectType*)>(std::bind(getter, static_cast<InterfaceType*>(this), _1)),
- std::function<void(ObjectType*, DataType&)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
- }
- template<class InterfaceType, class ObjectType, class DataType>
- void addReflectablePtrField(const String& name, UINT32 uniqueId,
- SPtr<DataType> (InterfaceType::*getter)(ObjectType*),
- void (InterfaceType::*setter)(ObjectType*, SPtr<DataType>), UINT64 flags = 0)
- {
- using namespace std::placeholders;
- addReflectablePtrField<ObjectType, DataType>(name, uniqueId,
- std::function<SPtr<DataType>(ObjectType*)>(std::bind(getter, static_cast<InterfaceType*>(this), _1)),
- std::function<void(ObjectType*, SPtr<DataType>)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
- }
- template<class InterfaceType, class ObjectType, class DataType>
- void addPlainArrayField(const String& name, UINT32 uniqueId,
- DataType& (InterfaceType::*getter)(ObjectType*, UINT32),
- UINT32 (InterfaceType::*getSize)(ObjectType*),
- void (InterfaceType::*setter)(ObjectType*, UINT32, DataType&),
- void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
- {
- using namespace std::placeholders;
- static_assert((std::is_base_of<bs::RTTIType<Type, BaseType, MyRTTIType>, InterfaceType>::value),
- "Class with the get/set methods must derive from bs::RTTIType.");
- static_assert(!(std::is_base_of<bs::IReflectable, DataType>::value),
- "Data type derives from IReflectable but it is being added as a plain field.");
- addPlainArrayField<ObjectType, DataType>(name, uniqueId,
- std::function<DataType&(ObjectType*, UINT32)>(std::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
- std::function<UINT32(ObjectType*)>(std::bind(getSize, static_cast<InterfaceType*>(this), _1)),
- std::function<void(ObjectType*, UINT32, DataType&)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
- std::function<void(ObjectType*, UINT32)>(std::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
- }
- template<class InterfaceType, class ObjectType, class DataType>
- void addReflectableArrayField(const String& name, UINT32 uniqueId,
- DataType& (InterfaceType::*getter)(ObjectType*, UINT32),
- UINT32 (InterfaceType::*getSize)(ObjectType*),
- void (InterfaceType::*setter)(ObjectType*, UINT32, DataType&),
- void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
- {
- using namespace std::placeholders;
- addReflectableArrayField<ObjectType, DataType>(name, uniqueId,
- std::function<DataType&(ObjectType*, UINT32)>(std::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
- std::function<UINT32(ObjectType*)>(std::bind(getSize, static_cast<InterfaceType*>(this), _1)),
- std::function<void(ObjectType*, UINT32, DataType&)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
- std::function<void(ObjectType*, UINT32)>(std::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
- }
- template<class InterfaceType, class ObjectType, class DataType>
- void addReflectablePtrArrayField(const String& name, UINT32 uniqueId,
- SPtr<DataType> (InterfaceType::*getter)(ObjectType*, UINT32),
- UINT32 (InterfaceType::*getSize)(ObjectType*),
- void (InterfaceType::*setter)(ObjectType*, UINT32, SPtr<DataType>),
- void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
- {
- using namespace std::placeholders;
- addReflectablePtrArrayField<ObjectType, DataType>(name, uniqueId,
- std::function<SPtr<DataType>(ObjectType*, UINT32)>(std::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
- std::function<UINT32(ObjectType*)>(std::bind(getSize, static_cast<InterfaceType*>(this), _1)),
- std::function<void(ObjectType*, UINT32, SPtr<DataType>)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
- std::function<void(ObjectType*, UINT32)>(std::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
- }
- template<class InterfaceType, class ObjectType>
- void addDataBlockField(const String& name, UINT32 uniqueId, SPtr<DataStream> (InterfaceType::*getter)(ObjectType*, UINT32&),
- void (InterfaceType::*setter)(ObjectType*, const SPtr<DataStream>&, UINT32), UINT64 flags = 0)
- {
- using namespace std::placeholders;
- addDataBlockField<ObjectType>(name, uniqueId,
- std::function<SPtr<DataStream>(ObjectType*, UINT32&)>(std::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
- std::function<void(ObjectType*, const SPtr<DataStream>&, UINT32)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)), flags);
- }
- private:
- template<class ObjectType, class DataType>
- void addPlainField(const String& name, UINT32 uniqueId, Any getter, Any setter, UINT64 flags)
- {
- RTTIPlainField<DataType, ObjectType>* newField =
- bs_new<RTTIPlainField<DataType, ObjectType>>();
- newField->initSingle(name, uniqueId, getter, setter, flags);
- addNewField(newField);
- }
-
- template<class ObjectType, class DataType>
- void addReflectableField(const String& name, UINT32 uniqueId, Any getter, Any setter, UINT64 flags)
- {
- static_assert((std::is_base_of<bs::IReflectable, DataType>::value),
- "Invalid data type for complex field. It needs to derive from bs::IReflectable.");
- RTTIReflectableField<DataType, ObjectType>* newField =
- bs_new<RTTIReflectableField<DataType, ObjectType>>();
- newField->initSingle(name, uniqueId, getter, setter, flags);
- addNewField(newField);
- }
- template<class ObjectType, class DataType>
- void addReflectablePtrField(const String& name, UINT32 uniqueId, Any getter, Any setter, UINT64 flags)
- {
- static_assert((std::is_base_of<bs::IReflectable, DataType>::value),
- "Invalid data type for complex field. It needs to derive from bs::IReflectable.");
- RTTIReflectablePtrField<DataType, ObjectType>* newField =
- bs_new<RTTIReflectablePtrField<DataType, ObjectType>>();
- newField->initSingle(name, uniqueId, getter, setter, flags);
- addNewField(newField);
- }
- template<class ObjectType, class DataType>
- void addPlainArrayField(const String& name, UINT32 uniqueId, Any getter, Any getSize,
- Any setter, Any setSize, UINT64 flags)
- {
- RTTIPlainField<DataType, ObjectType>* newField =
- bs_new<RTTIPlainField<DataType, ObjectType>>();
- newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
- addNewField(newField);
- }
- template<class ObjectType, class DataType>
- void addReflectableArrayField(const String& name, UINT32 uniqueId, Any getter, Any getSize,
- Any setter, Any setSize, UINT64 flags)
- {
- static_assert((std::is_base_of<bs::IReflectable, DataType>::value),
- "Invalid data type for complex field. It needs to derive from bs::IReflectable.");
- RTTIReflectableField<DataType, ObjectType>* newField =
- bs_new<RTTIReflectableField<DataType, ObjectType>>();
- newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
- addNewField(newField);
- }
- template<class ObjectType, class DataType>
- void addReflectablePtrArrayField(const String& name, UINT32 uniqueId, Any getter, Any getSize,
- Any setter, Any setSize, UINT64 flags)
- {
- static_assert((std::is_base_of<bs::IReflectable, DataType>::value),
- "Invalid data type for complex field. It needs to derive from bs::IReflectable.");
- RTTIReflectablePtrField<DataType, ObjectType>* newField =
- bs_new<RTTIReflectablePtrField<DataType, ObjectType>>();
- newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
- addNewField(newField);
- }
- template<class ObjectType>
- void addDataBlockField(const String& name, UINT32 uniqueId, Any getter, Any setter, UINT64 flags)
- {
- RTTIManagedDataBlockField<UINT8*, ObjectType>* newField =
- bs_new<RTTIManagedDataBlockField<UINT8*, ObjectType>>();
- newField->initSingle(name, uniqueId, getter, setter, flags);
- addNewField(newField);
- }
- };
- template <typename Type, typename BaseType, typename MyRTTIType>
- InitRTTIOnStart<Type, BaseType> RTTIType<Type, BaseType, MyRTTIType>::initOnStart;
- /** Returns true if the provided object can be safely cast into type T. */
- template<class T>
- bool rtti_is_of_type(IReflectable* object)
- {
- static_assert((std::is_base_of<bs::IReflectable, T>::value),
- "Invalid data type for type checking. It needs to derive from bs::IReflectable.");
- return object->getTypeId() == T::getRTTIStatic()->getRTTIId();
- }
- /** Returns true if the provided object can be safely cast into type T. */
- template<class T>
- bool rtti_is_of_type(SPtr<IReflectable> object)
- {
- static_assert((std::is_base_of<bs::IReflectable, T>::value),
- "Invalid data type for type checking. It needs to derive from bs::IReflectable.");
- return object->getTypeId() == T::getRTTIStatic()->getRTTIId();
- }
- /** Creates a new object just from its type ID. */
- BS_UTILITY_EXPORT SPtr<IReflectable> rtti_create(UINT32 rttiId);
- /** Checks is the current object a subclass of some type. */
- template<class T>
- bool rtti_is_subclass(IReflectable* object)
- {
- static_assert((std::is_base_of<bs::IReflectable, T>::value),
- "Invalid data type for type checking. It needs to derive from bs::IReflectable.");
- return object->isDerivedFrom(T::getRTTIStatic());
- }
- /** @} */
- }
|