BsRTTIType.h 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079
  1. //********************************** Banshee Engine (www.banshee3d.com) **************************************************//
  2. //**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
  3. #pragma once
  4. #include <string>
  5. #include <algorithm>
  6. #include <unordered_map>
  7. #include "BsPrerequisitesUtil.h"
  8. #include "BsManagedDataBlock.h"
  9. #include "BsRTTIField.h"
  10. #include "BsRTTIPlainField.h"
  11. #include "BsRTTIReflectableField.h"
  12. #include "BsRTTIReflectablePtrField.h"
  13. #include "BsRTTIManagedDataBlockField.h"
  14. #include "BsIReflectable.h"
  15. #include "BsBinaryDiff.h"
  16. namespace BansheeEngine
  17. {
  18. /** @addtogroup RTTI
  19. * @{
  20. */
  21. /** Similar to BS_PLAIN_MEMBER but allows you to specify name of the field and the variable it's referencing separately. */
  22. #define BS_PLAIN_MEMBER_NAMED(name, field) \
  23. decltype(OwnerType::field)& get##name(OwnerType* obj) { return obj->field; } \
  24. void set##name(OwnerType* obj, decltype(OwnerType::field)& val) { obj->field = val; }
  25. /** Similar to BS_REFL_MEMBER but allows you to specify name of the field and the variable it's referencing separately. */
  26. #define BS_REFL_MEMBER_NAMED(name, field) \
  27. decltype(OwnerType::field)& get##name(OwnerType* obj) { return obj->field; } \
  28. void set##name(OwnerType* obj, decltype(OwnerType::field)& val) { obj->field = val; }
  29. /** Similar to BS_REFLPTR_MEMBER but allows you to specify name of the field and the variable it's referencing separately. */
  30. #define BS_REFLPTR_MEMBER_NAMED(name, field) \
  31. decltype(OwnerType::field) get##name(OwnerType* obj) { return obj->field; } \
  32. void set##name(OwnerType* obj, decltype(OwnerType::field) val) { obj->field = val; }
  33. /** Shortcut for defining getter/setter methods for a RTTI plain field. */
  34. #define BS_PLAIN_MEMBER(name) \
  35. decltype(OwnerType::name)& get##name(OwnerType* obj) { return obj->name; } \
  36. void set##name(OwnerType* obj, decltype(OwnerType::name)& val) { obj->name = val; }
  37. /** Shortcut for defining getter/setter methods for a RTTI reflectable field. */
  38. #define BS_REFL_MEMBER(name) \
  39. decltype(OwnerType::name)& get##name(OwnerType* obj) { return obj->name; } \
  40. void set##name(OwnerType* obj, decltype(OwnerType::name)& val) { obj->name = val; }
  41. /** Shortcut for defining getter/setter methods for a RTTI reflectable pointer field. */
  42. #define BS_REFLPTR_MEMBER(name) \
  43. decltype(OwnerType::name) get##name(OwnerType* obj) { return obj->name; } \
  44. void set##name(OwnerType* obj, decltype(OwnerType::name) val) { obj->name = val; }
  45. /** Registers a plain field defined with BS_PLAIN_MEMBER or BS_PLAIN_MEMBER_NAMED with the RTTI object. */
  46. #define BS_ADD_PLAIN_FIELD(name, id) \
  47. addPlainField(#name, id, &MyType::get##name, &MyType::set##name);
  48. /** Registers a plain field defined with BS_REFL_MEMBER or BS_REFL_MEMBER_NAMED with the RTTI object. */
  49. #define BS_ADD_REFL_FIELD(name, id) \
  50. addReflectableField(#name, id, &MyType::get##name, &MyType::set##name);
  51. /** Registers a plain field defined with BS_REFLPTR_MEMBER or BS_REFLPTR_MEMBER_NAMED with the RTTI object. */
  52. #define BS_ADD_REFLPTR_FIELD(name, id) \
  53. addReflectablePtrField(#name, id, &MyType::get##name, &MyType::set##name);
  54. /** Shortcut for defining getter/setter methods for a RTTI plain Vector<T> field. */
  55. #define BS_PLAIN_MEMBER_VEC(name) \
  56. std::common_type<decltype(OwnerType::name)>::type::value_type& get##name(OwnerType* obj, UINT32 idx) { return obj->name[idx]; } \
  57. void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::name)>::type::value_type& val) { obj->name[idx] = val; } \
  58. UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->name.size(); } \
  59. void setSize##name(OwnerType* obj, UINT32 val) { obj->name.resize(val); }
  60. /** Shortcut for defining getter/setter methods for a RTTI reflectable Vector<T> field. */
  61. #define BS_REFL_MEMBER_VEC(name) \
  62. std::common_type<decltype(OwnerType::name)>::type::value_type& get##name(OwnerType* obj, UINT32 idx) { return obj->name[idx]; } \
  63. void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::name)>::type::value_type& val) { obj->name[idx] = val; } \
  64. UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->name.size(); } \
  65. void setSize##name(OwnerType* obj, UINT32 val) { obj->name.resize(val); }
  66. /** Shortcut for defining getter/setter methods for a RTTI reflectable pointer Vector<T> field. */
  67. #define BS_REFLPTR_MEMBER_VEC(name) \
  68. std::common_type<decltype(OwnerType::name)>::type::value_type get##name(OwnerType* obj, UINT32 idx) { return obj->name[idx]; } \
  69. void set##name(OwnerType* obj, UINT32 idx, std::common_type<decltype(OwnerType::name)>::type::value_type val) { obj->name[idx] = val; } \
  70. UINT32 getSize##name(OwnerType* obj) { return (UINT32)obj->name.size(); } \
  71. void setSize##name(OwnerType* obj, UINT32 val) { obj->name.resize(val); }
  72. /** Registers a plain array field defined with BS_PLAIN_MEMBER_VEC with the RTTI object. */
  73. #define BS_ADD_PLAIN_FIELD_ARR(name, id) \
  74. addPlainArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, \
  75. &MyType::set##name, &MyType::setSize##name);
  76. /** Registers a reflectable object array field defined with BS_PLAIN_MEMBER_VEC with the RTTI object. */
  77. #define BS_ADD_REFL_FIELD_ARR(name, id) \
  78. addReflectableArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, \
  79. &MyType::set##name, &MyType::setSize##name);
  80. /** Registers a reflectable pointer array field defined with BS_PLAIN_MEMBER_VEC with the RTTI object. */
  81. #define BS_ADD_REFLPTR_FIELD_ARR(name, id) \
  82. addReflectablePtrArrayField(#name, id, &MyType::get##name, &MyType::getSize##name, \
  83. &MyType::set##name, &MyType::setSize##name);
  84. /** @} */
  85. /** @addtogroup Internal-Utility
  86. * @{
  87. */
  88. /** @addtogroup RTTI-Internal
  89. * @{
  90. */
  91. /**
  92. * Provides an interface for accessing fields of a certain class.
  93. * Data can be easily accessed by getter and setter methods.
  94. *
  95. * Supported data types:
  96. * - Plain types - All types defined in BsRTTIField.h, mostly native types and POD (plain old data) structs. Data is parsed byte by byte.
  97. * No pointers to plain types are supported. Data is passed around by value.
  98. * - Reflectable types - Any class deriving from IReflectable. Data is parsed based on fields in its RTTI class. Can be pointer or value type.
  99. * - Arrays of both plain and reflectable types are supported
  100. * - Data blocks - A managed or unmanaged block of data. See ManagedDataBlock.
  101. */
  102. class BS_UTILITY_EXPORT RTTITypeBase
  103. {
  104. public:
  105. RTTITypeBase();
  106. virtual ~RTTITypeBase();
  107. /** Returns RTTI type information for all classes that derive from the class that owns this RTTI type. */
  108. virtual Vector<RTTITypeBase*>& getDerivedClasses() = 0;
  109. /**
  110. * Returns RTTI type information for the class that owns this RTTI type. If the class has not base type, null is
  111. * returned instead.
  112. */
  113. virtual RTTITypeBase* getBaseClass() = 0;
  114. /** Returns true if current RTTI class is derived from @p base. (Or if it is the same type as base) */
  115. virtual bool isDerivedFrom(RTTITypeBase* base) = 0;
  116. /** Creates a new instance of the class owning this RTTI type. */
  117. virtual SPtr<IReflectable> newRTTIObject() = 0;
  118. /** Returns the name of the class owning this RTTI type. */
  119. virtual const String& getRTTIName() = 0;
  120. /** Returns an RTTI id that uniquely represents each class in the RTTI system. */
  121. virtual UINT32 getRTTIId() = 0;
  122. /**
  123. * Called by the serializers when serialization for this object has started. Use this to do any preprocessing on
  124. * data you might need during serialization itself.
  125. */
  126. virtual void onSerializationStarted(IReflectable* obj) {}
  127. /**
  128. * Called by the serializers when serialization for this object has ended. After serialization has ended you can
  129. * be sure that the type has been fully serialized, and you may clean up any temporary data.
  130. */
  131. virtual void onSerializationEnded(IReflectable* obj) {}
  132. /**
  133. * Called by the serializers when deserialization for this object has started. Use this to do any preprocessing
  134. * on data you might need during deserialization itself.
  135. */
  136. virtual void onDeserializationStarted(IReflectable* obj) {}
  137. /**
  138. * Called by the serializers when deserialization for this object has ended. At this point you can be sure the
  139. * instance has been fully deserialized and you may safely use it.
  140. *
  141. * One exception being are fields you marked with RTTI_Flag_WeakRef, as they might be resolved only after
  142. * deserialization has fully completed for all objects.
  143. */
  144. virtual void onDeserializationEnded(IReflectable* obj) {}
  145. /**
  146. * Returns a handler that determines how are "diffs" generated and applied when it comes to objects of this RTTI
  147. * type. A "diff" is a list of differences between two objects that may be saved, viewed or applied to another
  148. * object to transform it.
  149. */
  150. virtual IDiff& getDiffHandler() const
  151. {
  152. static BinaryDiff diffHandler;
  153. return diffHandler;
  154. }
  155. /**
  156. * Allows you to assign a value to a plain field with the specified name on the provided instance.
  157. *
  158. * @note Caller must ensure instance and value types are valid for this field.
  159. */
  160. template <class ObjectType, class DataType>
  161. void setPlainValue(ObjectType* object, const String& name, DataType& value)
  162. {
  163. RTTIField* genericField = findField(name);
  164. genericField->checkIsPlain(false);
  165. RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
  166. UINT32 typeSize = 0;
  167. if(RTTIPlainType<DataType>::hasDynamicSize)
  168. typeSize = RTTIPlainType<DataType>::getDynamicSize(value);
  169. else
  170. typeSize = sizeof(DataType);
  171. UINT8* tempBuffer = (UINT8*)bs_stack_alloc(typeSize);
  172. RTTIPlainType<DataType>::toMemory(value, (char*)tempBuffer);
  173. field->fromBuffer(object, tempBuffer);
  174. bs_stack_free(tempBuffer);
  175. }
  176. /**
  177. * Allows you to assign a value to a plain field array element with the specified name and index on the provided instance.
  178. *
  179. * @note Caller must ensure instance and value types are valid for this field.
  180. */
  181. template <class ObjectType, class DataType>
  182. void setPlainArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
  183. {
  184. RTTIField* genericField = findField(name);
  185. genericField->checkIsPlain(true);
  186. RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
  187. UINT32 typeSize = 0;
  188. if(RTTIPlainType<DataType>::hasDynamicSize)
  189. typeSize = RTTIPlainType<DataType>::getDynamicSize(value);
  190. else
  191. typeSize = sizeof(DataType);
  192. UINT8* tempBuffer = (UINT8*)bs_stack_alloc(typeSize);
  193. RTTIPlainType<DataType>::toMemory(value, (char*)tempBuffer);
  194. field->arrayElemFromBuffer(object, index, tempBuffer);
  195. bs_stack_free(tempBuffer);
  196. }
  197. /**
  198. * Allows you to assign a value to a reflectable field with the specified name on the provided instance.
  199. *
  200. * @note Caller must ensure instance and value types are valid for this field.
  201. */
  202. template <class ObjectType, class DataType>
  203. void setReflectableValue(ObjectType* object, const String& name, DataType& value)
  204. {
  205. static_assert((std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  206. "Invalid data type for complex field. It needs to derive from BansheeEngine::IReflectable.");
  207. RTTIField* genericField = findField(name);
  208. genericField->checkIsComplex(false);
  209. RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
  210. field->setValue(object, value);
  211. }
  212. /**
  213. * Allows you to assign a value to a reflectable field array element with the specified name and index on the
  214. * provided instance.
  215. *
  216. * @note Caller must ensure instance and value types are valid for this field.
  217. */
  218. template <class ObjectType, class DataType>
  219. void setReflectableArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
  220. {
  221. static_assert((std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  222. "Invalid data type for complex field. It needs to derive from BansheeEngine::IReflectable.");
  223. RTTIField* genericField = findField(name);
  224. genericField->checkIsComplex(true);
  225. RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
  226. field->setArrayValue(object, index, value);
  227. }
  228. /**
  229. * Allows you to assign a value to a managed data block field with the specified name on the provided instance.
  230. *
  231. * @note Caller must ensure instance type is valid for this field.
  232. */
  233. template <class ObjectType>
  234. void setDataBlockValue(ObjectType* object, const String& name, ManagedDataBlock value)
  235. {
  236. RTTIField* genericField = findField(name);
  237. genericField->checkIsDataBlock();
  238. RTTIManagedDataBlockFieldBase* field = static_cast<RTTIManagedDataBlockFieldBase*>(genericField);
  239. field->setValue(object, value);
  240. }
  241. /**
  242. * Allows you to assign a value to a reflectable pointer field with the specified name on the provided instance.
  243. *
  244. * @note Caller must ensure instance and value types are valid for this field.
  245. */
  246. template <class ObjectType, class DataType>
  247. void setReflectablePtrValue(ObjectType* object, const String& name, SPtr<DataType> value)
  248. {
  249. static_assert((std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  250. "Invalid data type for complex field. It needs to derive from BansheeEngine::IReflectable.");
  251. RTTIField* genericField = findField(name);
  252. genericField->checkIsComplexPtr(false);
  253. RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
  254. field->setValue(object, value);
  255. }
  256. /**
  257. * Allows you to assign a value to a reflectable pointer field array element with the specified name and index on
  258. * the provided instance.
  259. *
  260. * @note Caller must ensure instance and value types are valid for this field.
  261. */
  262. template <class ObjectType, class DataType>
  263. void setReflectablePtrArrayValue(ObjectType* object, const String& name, UINT32 index, SPtr<DataType> value)
  264. {
  265. static_assert((std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  266. "Invalid data type for complex field. It needs to derive from BansheeEngine::IReflectable.");
  267. RTTIField* genericField = findField(name);
  268. genericField->checkIsComplexPtr(true);
  269. RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
  270. field->setArrayValue(object, index, value);
  271. }
  272. /**
  273. * Reads a value from a plain field with the specified name from the provided instance.
  274. *
  275. * @note Caller must ensure instance and value types are valid for this field.
  276. */
  277. template <class ObjectType, class DataType>
  278. void getPlainValue(ObjectType* object, const String& name, DataType& value)
  279. {
  280. RTTIField* genericField = findField(name);
  281. genericField->checkIsPlain(false);
  282. RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
  283. UINT32 typeSize = 0;
  284. if(field->hasDynamicSize())
  285. typeSize = field->getDynamicSize(object);
  286. else
  287. typeSize = field->getTypeSize();
  288. UINT8* tempBuffer = (UINT8*)bs_stack_alloc(typeSize);
  289. field->toBuffer(object, tempBuffer);
  290. RTTIPlainType<DataType>::fromMemory(value, (char*)tempBuffer);
  291. bs_stack_free(tempBuffer);
  292. }
  293. /**
  294. * Reads a value from a plain array field with the specified name and index from the provided instance.
  295. *
  296. * @note Caller must ensure instance and value types are valid for this field.
  297. */
  298. template <class ObjectType, class DataType>
  299. void getPlainArrayValue(ObjectType* object, const String& name, UINT32 index, DataType& value)
  300. {
  301. RTTIField* genericField = findField(name);
  302. genericField->checkIsPlain(true);
  303. RTTIPlainFieldBase* field = static_cast<RTTIPlainFieldBase*>(genericField);
  304. UINT32 typeSize = 0;
  305. if(field->hasDynamicSize())
  306. typeSize = field->getArrayElemDynamicSize(object, arrIdx);
  307. else
  308. typeSize = field->getTypeSize();
  309. UINT8* tempBuffer = (UINT8*)bs_stack_alloc(typeSize);
  310. field->arrayElemToBuffer(object, index, tempBuffer);
  311. RTTIPlainType<DataType>::fromMemory(value, (char*)tempBuffer);
  312. bs_stack_free(tempBuffer);
  313. }
  314. /**
  315. * Reads a value from a reflectable object field with the specified name from the provided instance.
  316. *
  317. * @note Caller must ensure instance and value types are valid for this field.
  318. */
  319. template <class ObjectType>
  320. IReflectable& getReflectableValue(ObjectType* object, const String& name)
  321. {
  322. RTTIField* genericField = findField(name);
  323. genericField->checkIsComplex(false);
  324. RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
  325. return field->getValue(object);
  326. }
  327. /**
  328. * Reads a value from a reflectable object array field with the specified name and index from the provided instance.
  329. *
  330. * @note Caller must ensure instance and value types are valid for this field.
  331. */
  332. template <class ObjectType>
  333. IReflectable& getReflectableArrayValue(ObjectType* object, const String& name, UINT32 index)
  334. {
  335. RTTIField* genericField = findField(name);
  336. genericField->checkIsComplex(true);
  337. RTTIReflectableFieldBase* field = static_cast<RTTIReflectableFieldBase*>(genericField);
  338. return field->getArrayValue(object, index);
  339. }
  340. /**
  341. * Reads a managed data block field with the specified name from the provided instance.
  342. *
  343. * @note Caller must ensure instance type is valid for this field.
  344. */
  345. template <class ObjectType>
  346. ManagedDataBlock getDataBlockValue(ObjectType* object, const String& name)
  347. {
  348. RTTIField* genericField = findField(name);
  349. genericField->checkIsDataBlock();
  350. RTTIManagedDataBlockFieldBase* field = static_cast<RTTIManagedDataBlockFieldBase*>(genericField);
  351. return field->getValue(object);
  352. }
  353. /**
  354. * Reads a value from a reflectable object pointer field with the specified name from the provided instance.
  355. *
  356. * @note Caller must ensure instance and value types are valid for this field.
  357. */
  358. template <class ObjectType>
  359. SPtr<IReflectable> getReflectablePtrValue(ObjectType* object, const String& name)
  360. {
  361. RTTIField* genericField = findField(name);
  362. genericField->checkIsComplexPtr(false);
  363. RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
  364. return field->getValue(object);
  365. }
  366. /**
  367. * Reads a value from a reflectable pointer array field with the specified name and index from the provided instance.
  368. *
  369. * @note Caller must ensure instance and value types are valid for this field.
  370. */
  371. template <class ObjectType>
  372. SPtr<IReflectable> getReflectablePtrArrayValue(ObjectType* object, const String& name, UINT32 index)
  373. {
  374. RTTIField* genericField = findField(name);
  375. genericField->checkIsComplexPtr(true);
  376. RTTIReflectablePtrFieldBase* field = static_cast<RTTIReflectablePtrFieldBase*>(genericField);
  377. return field->getArrayValue(object, index);
  378. }
  379. /**
  380. * Returns the size of the array of the field with the specified name on the provided instance.
  381. *
  382. * @note Caller must ensure instance type is valid and that the field as an array.
  383. */
  384. template <class ObjectType>
  385. UINT32 getArraySize(ObjectType* object, const String& name)
  386. {
  387. RTTIField* field = findField(name);
  388. return field->getArraySize(object);
  389. }
  390. /**
  391. * Sets the size of the array of the field with the specified name on the provided instance.
  392. *
  393. * @note
  394. * Caller must ensure instance type is valid and that the field as an array. This might clear any existing data
  395. * from the array.
  396. */
  397. template <class ObjectType>
  398. void setArraySize(ObjectType* object, const String& name, UINT32 size)
  399. {
  400. RTTIField* field = findField(name);
  401. field->setArraySize(object, size);
  402. }
  403. /** Returns the total number of fields in this RTTI type. */
  404. UINT32 getNumFields() const { return (UINT32)mFields.size(); }
  405. /** Returns a field based on the field index. Use getNumFields() to get total number of fields available. */
  406. RTTIField* getField(UINT32 idx) { return mFields.at(idx); }
  407. /**
  408. * Tries to find a field with the specified name. Throws an exception if it can't.
  409. *
  410. * @param name The name of the field.
  411. */
  412. RTTIField* findField(const String& name);
  413. /**
  414. * Tries to find a field with the specified unique ID. Doesn't throw an exception if it can't find the field
  415. * (Unlike findField(const String&)).
  416. *
  417. * @param uniqueFieldId Unique identifier for the field.
  418. *
  419. * @return nullptr if it can't find the field.
  420. */
  421. RTTIField* findField(int uniqueFieldId);
  422. /** @name Internal
  423. * @{
  424. */
  425. /** Called by the RTTI system when a class is first found in order to form child/parent class hierarchy. */
  426. virtual void _registerDerivedClass(RTTITypeBase* derivedClass) = 0;
  427. /** @} */
  428. protected:
  429. /**
  430. * Tries to add a new field to the fields array, and throws an exception if a field with the same name or id
  431. * already exists.
  432. *
  433. * @param[in] field Field, must be non-null.
  434. */
  435. void addNewField(RTTIField* field);
  436. private:
  437. Vector<RTTIField*> mFields;
  438. };
  439. /** Used for initializing a certain type as soon as the program is loaded. */
  440. template<typename Type, typename BaseType>
  441. struct InitRTTIOnStart
  442. {
  443. public:
  444. InitRTTIOnStart()
  445. {
  446. BaseType::getRTTIStatic()->_registerDerivedClass(Type::getRTTIStatic());
  447. }
  448. void makeSureIAmInstantiated() { }
  449. };
  450. /** Specialization for root class of RTTI hierarchy - IReflectable */
  451. template<typename Type>
  452. struct InitRTTIOnStart<Type, IReflectable>
  453. {
  454. public:
  455. InitRTTIOnStart()
  456. {
  457. IReflectable::_registerDerivedClass(Type::getRTTIStatic());
  458. }
  459. void makeSureIAmInstantiated() { }
  460. };
  461. /**
  462. * Template that returns RTTI type of the specified type, unless the specified type is IReflectable in which case it
  463. * returns a null.
  464. */
  465. template<typename Type>
  466. struct GetRTTIType
  467. {
  468. RTTITypeBase* operator()() { return Type::getRTTIStatic(); }
  469. };
  470. /** Specialization for root class of RTTI hierarchy - IReflectable. */
  471. template<>
  472. struct GetRTTIType<IReflectable>
  473. {
  474. RTTITypeBase* operator()() { return nullptr; }
  475. };
  476. /** @} */
  477. /** @} */
  478. /** @addtogroup RTTI
  479. * @{
  480. */
  481. /**
  482. * Allows you to provide a run-time type information for a specific class, along with support for
  483. * serialization/deserialization.
  484. *
  485. * Derive from this class and return the that class from IReflectable::getRTTI. This way you can separate serialization
  486. * logic from the actual class you're serializing.
  487. *
  488. * This class will provide a way to register individual fields in the class, together with ways to read and write them,
  489. * as well a providing information about class hierarchy, and run-time type checking.
  490. */
  491. template <typename Type, typename BaseType, typename MyRTTIType>
  492. class RTTIType : public RTTITypeBase
  493. {
  494. protected:
  495. /************************************************************************/
  496. /* RTTI CLASS META DATA */
  497. /************************************************************************/
  498. static InitRTTIOnStart<Type, BaseType> initOnStart;
  499. public:
  500. RTTIType()
  501. {
  502. // Compiler will only generate code for stuff that is directly used, including static data members,
  503. // so we fool it here like we're using the class directly. Otherwise compiler won't generate the code for the member
  504. // and our type won't get initialized on start (Actual behavior is a bit more random)
  505. initOnStart.makeSureIAmInstantiated();
  506. }
  507. virtual ~RTTIType() {}
  508. /** Returns a singleton of this RTTI type. */
  509. static MyRTTIType* instance()
  510. {
  511. static MyRTTIType inst;
  512. return &inst;
  513. }
  514. /** @copydoc RTTITypeBase::getDerivedClasses */
  515. Vector<RTTITypeBase*>& getDerivedClasses() override
  516. {
  517. static Vector<RTTITypeBase*> mRTTIDerivedClasses;
  518. return mRTTIDerivedClasses;
  519. }
  520. /** @copydoc RTTITypeBase::getBaseClass */
  521. RTTITypeBase* getBaseClass() override
  522. {
  523. return GetRTTIType<BaseType>()();
  524. }
  525. /** @copydoc RTTITypeBase::isDerivedFrom */
  526. bool isDerivedFrom(RTTITypeBase* base) override
  527. {
  528. assert(base != nullptr);
  529. Stack<RTTITypeBase*> todo;
  530. todo.push(base);
  531. while (!todo.empty())
  532. {
  533. RTTITypeBase* currentType = todo.top();
  534. todo.pop();
  535. if (currentType->getRTTIId() == getRTTIId())
  536. return true;
  537. const Vector<RTTITypeBase*>& derivedClasses = currentType->getDerivedClasses();
  538. for (auto iter = derivedClasses.begin(); iter != derivedClasses.end(); ++iter)
  539. todo.push(*iter);
  540. }
  541. return false;
  542. }
  543. /** @copydoc RTTITypeBase::_registerDerivedClass */
  544. void _registerDerivedClass(RTTITypeBase* derivedClass) override
  545. {
  546. if(IReflectable::_isTypeIdDuplicate(derivedClass->getRTTIId()))
  547. {
  548. BS_EXCEPT(InternalErrorException, "RTTI type \"" + derivedClass->getRTTIName() +
  549. "\" has a duplicate ID: " + toString(derivedClass->getRTTIId()));
  550. }
  551. getDerivedClasses().push_back(derivedClass);
  552. }
  553. /************************************************************************/
  554. /* FIELDS OPERATING DIRECTLY ON SERIALIZABLE OBJECT */
  555. /************************************************************************/
  556. /**
  557. * Registers a new plain field. This field can then be accessed dynamically from the RTTI system and used for
  558. * automatic serialization. See RTTIField for more information about field types.
  559. *
  560. * @param[in] name Name of the field.
  561. * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
  562. * small data type that can be used for efficiently serializing data to disk and similar.
  563. * It is primarily used for compatibility between different versions of serialized data.
  564. * @param[in] getter Method used for retrieving the value of this field.
  565. * @param[in] setter Method used for setting the value of this field.
  566. * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
  567. */
  568. template<class ObjectType, class DataType>
  569. void addPlainField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(),
  570. void (ObjectType::*setter)(DataType&) = nullptr, UINT64 flags = 0)
  571. {
  572. addPlainField<ObjectType, DataType>(name, uniqueId,
  573. std::function<DataType&(ObjectType*)>(getter),
  574. std::function<void(ObjectType*, DataType&)>(setter), flags);
  575. }
  576. /**
  577. * Registers a new reflectable object field. This field can then be accessed dynamically from the RTTI system and
  578. * used for automatic serialization. See RTTIField for more information about field types.
  579. *
  580. * @param[in] name Name of the field.
  581. * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
  582. * small data type that can be used for efficiently serializing data to disk and similar.
  583. * It is primarily used for compatibility between different versions of serialized data.
  584. * @param[in] getter Method used for retrieving the value of this field.
  585. * @param[in] setter Method used for setting the value of this field.
  586. * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
  587. */
  588. template<class ObjectType, class DataType>
  589. void addReflectableField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(),
  590. void (ObjectType::*setter)(DataType&) = nullptr, UINT64 flags = 0)
  591. {
  592. addReflectableField<ObjectType, DataType>(name, uniqueId,
  593. std::function<DataType&(ObjectType*)>(getter),
  594. std::function<void(ObjectType*, DataType&)>(setter), flags);
  595. }
  596. /**
  597. * Registers a new reflectable object pointer field. This field can then be accessed dynamically from the RTTI
  598. * system and used for automatic serialization. See RTTIField for more information about field types.
  599. *
  600. * @param[in] name Name of the field.
  601. * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
  602. * small data type that can be used for efficiently serializing data to disk and similar.
  603. * It is primarily used for compatibility between different versions of serialized data.
  604. * @param[in] getter Method used for retrieving the value of this field.
  605. * @param[in] setter Method used for setting the value of this field.
  606. * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
  607. */
  608. template<class ObjectType, class DataType>
  609. void addReflectablePtrField(const String& name, UINT32 uniqueId, SPtr<DataType> (ObjectType::*getter)(),
  610. void (ObjectType::*setter)(SPtr<DataType>) = nullptr, UINT64 flags = 0)
  611. {
  612. addReflectablePtrField<ObjectType, DataType>(name, uniqueId,
  613. std::function<SPtr<DataType>(ObjectType*)>(getter),
  614. std::function<void(ObjectType*, SPtr<DataType>)>(setter), flags);
  615. }
  616. /**
  617. * Registers a new field containg an array of plain values. This field can then be accessed dynamically from the
  618. * RTTI system and used for automatic serialization. See RTTIField for more information about field types.
  619. *
  620. * @param[in] name Name of the field.
  621. * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
  622. * small data type that can be used for efficiently serializing data to disk and similar.
  623. * It is primarily used for compatibility between different versions of serialized data.
  624. * @param[in] getter Method used for retrieving a single element of the array.
  625. * @param[in] getSize Getter method that returns the size of the array.
  626. * @param[in] setter Method used for setting the a single element of the field.
  627. * @param[in] setSize Setter method that allows you to resize the array.
  628. * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
  629. */
  630. template<class ObjectType, class DataType>
  631. void addPlainArrayField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
  632. void (ObjectType::*setter)(UINT32, DataType&) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
  633. {
  634. addPlainArrayField<ObjectType, DataType>(name, uniqueId,
  635. std::function<DataType&(ObjectType*, UINT32)>(getter),
  636. std::function<UINT32(ObjectType*)>(getSize),
  637. std::function<void(ObjectType*, UINT32, DataType&)>(setter),
  638. std::function<void(ObjectType*, UINT32)>(setSize), flags);
  639. }
  640. /**
  641. * Registers a new field containg an array of reflectable object values. This field can then be accessed dynamically
  642. * from the RTTI system and used for automatic serialization. See RTTIField for more information about field types.
  643. *
  644. * @param[in] name Name of the field.
  645. * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
  646. * small data type that can be used for efficiently serializing data to disk and similar.
  647. * It is primarily used for compatibility between different versions of serialized data.
  648. * @param[in] getter Method used for retrieving a single element of the array.
  649. * @param[in] getSize Getter method that returns the size of the array.
  650. * @param[in] setter Method used for setting the a single element of the field.
  651. * @param[in] setSize Setter method that allows you to resize the array.
  652. * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
  653. */
  654. template<class ObjectType, class DataType>
  655. void addReflectableArrayField(const String& name, UINT32 uniqueId, DataType& (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
  656. void (ObjectType::*setter)(UINT32, DataType&) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
  657. {
  658. addReflectableArrayField<ObjectType, DataType>(name, uniqueId,
  659. std::function<DataType&(ObjectType*, UINT32)>(getter),
  660. std::function<UINT32(ObjectType*)>(getSize),
  661. std::function<void(ObjectType*, UINT32, DataType&)>(setter),
  662. std::function<void(ObjectType*, UINT32)>(setSize), flags);
  663. }
  664. /**
  665. * Registers a new field containg an array of reflectable obejct pointers. This field can then be accessed
  666. * dynamically from the RTTI system and used for automatic serialization. See RTTIField for more information
  667. * about field types.
  668. *
  669. * @param[in] name Name of the field.
  670. * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
  671. * small data type that can be used for efficiently serializing data to disk and similar.
  672. * It is primarily used for compatibility between different versions of serialized data.
  673. * @param[in] getter Method used for retrieving a single element of the array.
  674. * @param[in] getSize Getter method that returns the size of the array.
  675. * @param[in] setter Method used for setting the a single element of the field.
  676. * @param[in] setSize Setter method that allows you to resize the array.
  677. * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
  678. */
  679. template<class ObjectType, class DataType>
  680. void addReflectablePtrArrayField(const String& name, UINT32 uniqueId, SPtr<DataType> (ObjectType::*getter)(UINT32), UINT32 (ObjectType::*getSize)(),
  681. void (ObjectType::*setter)(UINT32, SPtr<DataType>) = nullptr, void(ObjectType::*setSize)(UINT32) = nullptr, UINT64 flags = 0)
  682. {
  683. addReflectablePtrArrayField<ObjectType, DataType>(name, uniqueId,
  684. std::function<SPtr<DataType>(ObjectType*, UINT32)>(getter),
  685. std::function<UINT32(ObjectType*)>(getSize),
  686. std::function<void(ObjectType*, UINT32, SPtr<DataType>)>(setter),
  687. std::function<void(ObjectType*, UINT32)>(setSize), flags);
  688. }
  689. /**
  690. * Registers a new managed data block field. This field can then be accessed dynamically from the RTTI system and
  691. * used for automatic serialization. See RTTIField for more information about field types.
  692. *
  693. * @param[in] name Name of the field.
  694. * @param[in] uniqueId Unique identifier for this field. Although name is also a unique identifier we want a
  695. * small data type that can be used for efficiently serializing data to disk and similar.
  696. * It is primarily used for compatibility between different versions of serialized data.
  697. * @param[in] getter Method used for retrieving the value of this field.
  698. * @param[in] setter Method used for setting the value of this field.
  699. * @param[in] flags Various flags you can use to specialize how systems handle this field. See RTTIFieldFlag.
  700. */
  701. template<class ObjectType>
  702. void addDataBlockField(const String& name, UINT32 uniqueId, ManagedDataBlock (ObjectType::*getter)(),
  703. void (ObjectType::*setter)(ManagedDataBlock) = nullptr, UINT64 flags = 0, UINT8* (customAllocator)(ObjectType*, UINT32) = 0)
  704. {
  705. addDataBlockField<ObjectType>(name, uniqueId,
  706. std::function<ManagedDataBlock(ObjectType*)>(getter),
  707. std::function<void(ObjectType*, ManagedDataBlock)>(setter), flags, customAllocator);
  708. }
  709. protected:
  710. typedef Type OwnerType;
  711. typedef MyRTTIType MyType;
  712. virtual void initSerializableFields() {}
  713. /************************************************************************/
  714. /* FIELDS OPERATING ON DERIVED SERIALIZATION INTERFACE */
  715. /* (Needs an extra pointer to the actual object) */
  716. /************************************************************************/
  717. template<class InterfaceType, class ObjectType, class DataType>
  718. void addPlainField(const String& name, UINT32 uniqueId,
  719. DataType& (InterfaceType::*getter)(ObjectType*),
  720. void (InterfaceType::*setter)(ObjectType*, DataType&), UINT64 flags = 0)
  721. {
  722. using namespace std::placeholders;
  723. static_assert((std::is_base_of<BansheeEngine::RTTIType<Type, BaseType, MyRTTIType>, InterfaceType>::value),
  724. "Class with the get/set methods must derive from BansheeEngine::RTTIType.");
  725. static_assert(!(std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  726. "Data type derives from IReflectable but it is being added as a plain field.");
  727. addPlainField<ObjectType, DataType>(name, uniqueId,
  728. std::function<DataType&(ObjectType*)>(std::bind(getter, static_cast<InterfaceType*>(this), _1)),
  729. std::function<void(ObjectType*, DataType&)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
  730. }
  731. template<class InterfaceType, class ObjectType, class DataType>
  732. void addReflectableField(const String& name, UINT32 uniqueId,
  733. DataType& (InterfaceType::*getter)(ObjectType*),
  734. void (InterfaceType::*setter)(ObjectType*, DataType&), UINT64 flags = 0)
  735. {
  736. using namespace std::placeholders;
  737. addReflectableField<ObjectType, DataType>(name, uniqueId,
  738. std::function<DataType&(ObjectType*)>(std::bind(getter, static_cast<InterfaceType*>(this), _1)),
  739. std::function<void(ObjectType*, DataType&)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
  740. }
  741. template<class InterfaceType, class ObjectType, class DataType>
  742. void addReflectablePtrField(const String& name, UINT32 uniqueId,
  743. SPtr<DataType> (InterfaceType::*getter)(ObjectType*),
  744. void (InterfaceType::*setter)(ObjectType*, SPtr<DataType>), UINT64 flags = 0)
  745. {
  746. using namespace std::placeholders;
  747. addReflectablePtrField<ObjectType, DataType>(name, uniqueId,
  748. std::function<SPtr<DataType>(ObjectType*)>(std::bind(getter, static_cast<InterfaceType*>(this), _1)),
  749. std::function<void(ObjectType*, SPtr<DataType>)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
  750. }
  751. template<class InterfaceType, class ObjectType, class DataType>
  752. void addPlainArrayField(const String& name, UINT32 uniqueId,
  753. DataType& (InterfaceType::*getter)(ObjectType*, UINT32),
  754. UINT32 (InterfaceType::*getSize)(ObjectType*),
  755. void (InterfaceType::*setter)(ObjectType*, UINT32, DataType&),
  756. void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
  757. {
  758. using namespace std::placeholders;
  759. static_assert((std::is_base_of<BansheeEngine::RTTIType<Type, BaseType, MyRTTIType>, InterfaceType>::value),
  760. "Class with the get/set methods must derive from BansheeEngine::RTTIType.");
  761. static_assert(!(std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  762. "Data type derives from IReflectable but it is being added as a plain field.");
  763. addPlainArrayField<ObjectType, DataType>(name, uniqueId,
  764. std::function<DataType&(ObjectType*, UINT32)>(std::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
  765. std::function<UINT32(ObjectType*)>(std::bind(getSize, static_cast<InterfaceType*>(this), _1)),
  766. std::function<void(ObjectType*, UINT32, DataType&)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
  767. std::function<void(ObjectType*, UINT32)>(std::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
  768. }
  769. template<class InterfaceType, class ObjectType, class DataType>
  770. void addReflectableArrayField(const String& name, UINT32 uniqueId,
  771. DataType& (InterfaceType::*getter)(ObjectType*, UINT32),
  772. UINT32 (InterfaceType::*getSize)(ObjectType*),
  773. void (InterfaceType::*setter)(ObjectType*, UINT32, DataType&),
  774. void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
  775. {
  776. using namespace std::placeholders;
  777. addReflectableArrayField<ObjectType, DataType>(name, uniqueId,
  778. std::function<DataType&(ObjectType*, UINT32)>(std::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
  779. std::function<UINT32(ObjectType*)>(std::bind(getSize, static_cast<InterfaceType*>(this), _1)),
  780. std::function<void(ObjectType*, UINT32, DataType&)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
  781. std::function<void(ObjectType*, UINT32)>(std::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
  782. }
  783. template<class InterfaceType, class ObjectType, class DataType>
  784. void addReflectablePtrArrayField(const String& name, UINT32 uniqueId,
  785. SPtr<DataType> (InterfaceType::*getter)(ObjectType*, UINT32),
  786. UINT32 (InterfaceType::*getSize)(ObjectType*),
  787. void (InterfaceType::*setter)(ObjectType*, UINT32, SPtr<DataType>),
  788. void(InterfaceType::*setSize)(ObjectType*, UINT32), UINT64 flags = 0)
  789. {
  790. using namespace std::placeholders;
  791. addReflectablePtrArrayField<ObjectType, DataType>(name, uniqueId,
  792. std::function<SPtr<DataType>(ObjectType*, UINT32)>(std::bind(getter, static_cast<InterfaceType*>(this), _1, _2)),
  793. std::function<UINT32(ObjectType*)>(std::bind(getSize, static_cast<InterfaceType*>(this), _1)),
  794. std::function<void(ObjectType*, UINT32, SPtr<DataType>)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2, _3)),
  795. std::function<void(ObjectType*, UINT32)>(std::bind(setSize, static_cast<InterfaceType*>(this), _1, _2)), flags);
  796. }
  797. template<class InterfaceType, class ObjectType>
  798. void addDataBlockField(const String& name, UINT32 uniqueId, ManagedDataBlock (InterfaceType::*getter)(ObjectType*),
  799. void (InterfaceType::*setter)(ObjectType*, ManagedDataBlock), UINT64 flags = 0,
  800. UINT8* (customAllocator)(ObjectType*, UINT32) = 0)
  801. {
  802. using namespace std::placeholders;
  803. if(customAllocator != 0)
  804. {
  805. std::function<UINT8*(ObjectType*, UINT32)> customAllocFunc = std::bind(customAllocator, _1, _2);
  806. addDataBlockField<ObjectType>(name, uniqueId,
  807. std::function<ManagedDataBlock(ObjectType*)>(std::bind(getter, static_cast<InterfaceType*>(this), _1)),
  808. std::function<void(ObjectType*, ManagedDataBlock)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags,
  809. customAllocFunc);
  810. }
  811. else
  812. {
  813. addDataBlockField<ObjectType>(name, uniqueId,
  814. std::function<ManagedDataBlock(ObjectType*)>(std::bind(getter, static_cast<InterfaceType*>(this), _1)),
  815. std::function<void(ObjectType*, ManagedDataBlock)>(std::bind(setter, static_cast<InterfaceType*>(this), _1, _2)), flags);
  816. }
  817. }
  818. private:
  819. template<class ObjectType, class DataType>
  820. void addPlainField(const String& name, UINT32 uniqueId, Any getter, Any setter, UINT64 flags)
  821. {
  822. RTTIPlainField<DataType, ObjectType>* newField =
  823. bs_new<RTTIPlainField<DataType, ObjectType>>();
  824. newField->initSingle(name, uniqueId, getter, setter, flags);
  825. addNewField(newField);
  826. }
  827. template<class ObjectType, class DataType>
  828. void addReflectableField(const String& name, UINT32 uniqueId, Any getter, Any setter, UINT64 flags)
  829. {
  830. static_assert((std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  831. "Invalid data type for complex field. It needs to derive from BansheeEngine::IReflectable.");
  832. RTTIReflectableField<DataType, ObjectType>* newField =
  833. bs_new<RTTIReflectableField<DataType, ObjectType>>();
  834. newField->initSingle(name, uniqueId, getter, setter, flags);
  835. addNewField(newField);
  836. }
  837. template<class ObjectType, class DataType>
  838. void addReflectablePtrField(const String& name, UINT32 uniqueId, Any getter, Any setter, UINT64 flags)
  839. {
  840. static_assert((std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  841. "Invalid data type for complex field. It needs to derive from BansheeEngine::IReflectable.");
  842. RTTIReflectablePtrField<DataType, ObjectType>* newField =
  843. bs_new<RTTIReflectablePtrField<DataType, ObjectType>>();
  844. newField->initSingle(name, uniqueId, getter, setter, flags);
  845. addNewField(newField);
  846. }
  847. template<class ObjectType, class DataType>
  848. void addPlainArrayField(const String& name, UINT32 uniqueId, Any getter, Any getSize,
  849. Any setter, Any setSize, UINT64 flags)
  850. {
  851. RTTIPlainField<DataType, ObjectType>* newField =
  852. bs_new<RTTIPlainField<DataType, ObjectType>>();
  853. newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
  854. addNewField(newField);
  855. }
  856. template<class ObjectType, class DataType>
  857. void addReflectableArrayField(const String& name, UINT32 uniqueId, Any getter, Any getSize,
  858. Any setter, Any setSize, UINT64 flags)
  859. {
  860. static_assert((std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  861. "Invalid data type for complex field. It needs to derive from BansheeEngine::IReflectable.");
  862. RTTIReflectableField<DataType, ObjectType>* newField =
  863. bs_new<RTTIReflectableField<DataType, ObjectType>>();
  864. newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
  865. addNewField(newField);
  866. }
  867. template<class ObjectType, class DataType>
  868. void addReflectablePtrArrayField(const String& name, UINT32 uniqueId, Any getter, Any getSize,
  869. Any setter, Any setSize, UINT64 flags)
  870. {
  871. static_assert((std::is_base_of<BansheeEngine::IReflectable, DataType>::value),
  872. "Invalid data type for complex field. It needs to derive from BansheeEngine::IReflectable.");
  873. RTTIReflectablePtrField<DataType, ObjectType>* newField =
  874. bs_new<RTTIReflectablePtrField<DataType, ObjectType>>();
  875. newField->initArray(name, uniqueId, getter, getSize, setter, setSize, flags);
  876. addNewField(newField);
  877. }
  878. template<class ObjectType>
  879. void addDataBlockField(const String& name, UINT32 uniqueId, Any getter, Any setter, UINT64 flags,
  880. Any customAllocator = Any())
  881. {
  882. RTTIManagedDataBlockField<ManagedDataBlock, ObjectType>* newField =
  883. bs_new<RTTIManagedDataBlockField<ManagedDataBlock, ObjectType>>();
  884. newField->initSingle(name, uniqueId, getter, setter, flags, customAllocator);
  885. addNewField(newField);
  886. }
  887. };
  888. template <typename Type, typename BaseType, typename MyRTTIType>
  889. InitRTTIOnStart<Type, BaseType> RTTIType<Type, BaseType, MyRTTIType>::initOnStart;
  890. /** Returns true if the provided object can be safely cast into type T. */
  891. template<class T>
  892. bool rtti_is_of_type(IReflectable* object)
  893. {
  894. static_assert((std::is_base_of<BansheeEngine::IReflectable, T>::value),
  895. "Invalid data type for type checking. It needs to derive from BansheeEngine::IReflectable.");
  896. return object->getTypeId() == T::getRTTIStatic()->getRTTIId();
  897. }
  898. /** Returns true if the provided object can be safely cast into type T. */
  899. template<class T>
  900. bool rtti_is_of_type(SPtr<IReflectable> object)
  901. {
  902. static_assert((std::is_base_of<BansheeEngine::IReflectable, T>::value),
  903. "Invalid data type for type checking. It needs to derive from BansheeEngine::IReflectable.");
  904. return object->getTypeId() == T::getRTTIStatic()->getRTTIId();
  905. }
  906. /** Creates a new object just from its type ID. */
  907. SPtr<IReflectable> rtti_create(UINT32 rttiId);
  908. /** Checks is the current object a subclass of some type. */
  909. template<class T>
  910. bool rtti_is_subclass(IReflectable* object)
  911. {
  912. static_assert((std::is_base_of<BansheeEngine::IReflectable, T>::value),
  913. "Invalid data type for type checking. It needs to derive from BansheeEngine::IReflectable.");
  914. return object->isDerivedFrom(T::getRTTIStatic());
  915. }
  916. /** @} */
  917. }