![]() |
Jolt Physics
A multi core friendly Game Physics Engine
|
#include <RTTI.h>
Classes | |
| struct | BaseClass |
| Base class information. More... | |
Public Types | |
| using | pCreateObjectFunction = void *(*)() |
| Function to create an object. | |
| using | pDestructObjectFunction = void (*)(void *inObject) |
| Function to destroy an object. | |
| using | pCreateRTTIFunction = void (*)(RTTI &inRTTI) |
| Function to initialize the runtime type info structure. | |
Public Member Functions | |
| RTTI (const char *inName, int inSize, pCreateObjectFunction inCreateObject, pDestructObjectFunction inDestructObject) | |
| Constructor. | |
| RTTI (const char *inName, int inSize, pCreateObjectFunction inCreateObject, pDestructObjectFunction inDestructObject, pCreateRTTIFunction inCreateRTTI) | |
| const char * | GetName () const |
| void | SetName (const char *inName) |
| int | GetSize () const |
| bool | IsAbstract () const |
| int | GetBaseClassCount () const |
| const RTTI * | GetBaseClass (int inIdx) const |
| uint32 | GetHash () const |
| void * | CreateObject () const |
| Create an object of this type (returns nullptr if the object is abstract). | |
| void | DestructObject (void *inObject) const |
| Destruct object of this type (does nothing if the object is abstract). | |
| void | AddBaseClass (const RTTI *inRTTI, int inOffset) |
| Add base class. | |
| bool | operator== (const RTTI &inRHS) const |
| Equality operators. | |
| bool | operator!= (const RTTI &inRHS) const |
| bool | IsKindOf (const RTTI *inRTTI) const |
| Test if this class is derived from class of type inRTTI. | |
| const void * | CastTo (const void *inObject, const RTTI *inRTTI) const |
| Cast inObject of this type to object of type inRTTI, returns nullptr if the cast is unsuccessful. | |
| void | AddAttribute (const SerializableAttribute &inAttribute) |
| Attribute access. | |
| int | GetAttributeCount () const |
| const SerializableAttribute & | GetAttribute (int inIdx) const |
Static Public Member Functions | |
| template<class T> | |
| static void * | sCreateObjectInternal () |
| Create an object of type T for types that cannot use JPH_OVERRIDE_NEW_DELETE (e.g. primitive types). | |
| template<class T> | |
| static void | sDestructObjectInternal (void *inObject) |
| Destruct an object created with sCreateObjectInternal. | |
Protected Attributes | |
| const char * | mName |
| Class name. | |
| int | mSize |
| Class size. | |
| StaticArray< BaseClass, 4 > | mBaseClasses |
| Names of base classes. | |
| pCreateObjectFunction | mCreate |
| Pointer to a function that will create a new instance of this class. | |
| pDestructObjectFunction | mDestruct |
| Pointer to a function that will destruct an object of this class. | |
| StaticArray< SerializableAttribute, 32 > | mAttributes |
| All attributes of this class. | |
Light weight runtime type information system. This way we don't need to turn on the default RTTI system of the compiler (introducing a possible overhead for every class)
Notes:
To use RTTI on a specific class use:
Header file:
class Foo
{
JPH_DECLARE_RTTI_VIRTUAL_BASE(Foo)
}
class Bar : public Foo
{
JPH_DECLARE_RTTI_VIRTUAL(Bar)
};
Implementation file:
JPH_IMPLEMENT_RTTI_VIRTUAL_BASE(Foo)
{
}
JPH_IMPLEMENT_RTTI_VIRTUAL(Bar)
{
JPH_ADD_BASE_CLASS(Bar, Foo) // Multiple inheritance is allowed, just do JPH_ADD_BASE_CLASS for every base class
}
For abstract classes use:
Header file:
class Foo
{
JPH_DECLARE_RTTI_ABSTRACT_BASE(Foo)
public:
virtual void AbstractFunction() = 0;
}
class Bar : public Foo
{
JPH_DECLARE_RTTI_VIRTUAL(Bar)
public:
virtual void AbstractFunction() { } // Function is now implemented so this class is no longer abstract
};
Implementation file:
JPH_IMPLEMENT_RTTI_ABSTRACT_BASE(Foo)
{
}
JPH_IMPLEMENT_RTTI_VIRTUAL(Bar)
{
JPH_ADD_BASE_CLASS(Bar, Foo)
}
Example of usage in a program:
Foo *foo_ptr = new Foo; Foo *bar_ptr = new Bar; IsType(foo_ptr, RTTI(Bar)) returns false IsType(bar_ptr, RTTI(Bar)) returns true IsKindOf(foo_ptr, RTTI(Bar)) returns false IsKindOf(bar_ptr, RTTI(Foo)) returns true IsKindOf(bar_ptr, RTTI(Bar)) returns true StaticCast<Bar>(foo_ptr) asserts and returns foo_ptr casted to Bar * StaticCast<Bar>(bar_ptr) returns bar_ptr casted to Bar * DynamicCast<Bar>(foo_ptr) returns nullptr DynamicCast<Bar>(bar_ptr) returns bar_ptr casted to Bar *
Other feature of DynamicCast:
class A { int data[5]; };
class B { int data[7]; };
class C : public A, public B { int data[9]; };
C *c = new C;
A *a = c;
Note that:
B *b = (B *)a;
generates an invalid pointer,
B *b = StaticCast<B>(a);
doesn't compile, and
B *b = DynamicCast<B>(a);
does the correct cast
| using RTTI::pCreateObjectFunction = void *(*)() |
Function to create an object.
| using RTTI::pCreateRTTIFunction = void (*)(RTTI &inRTTI) |
Function to initialize the runtime type info structure.
| using RTTI::pDestructObjectFunction = void (*)(void *inObject) |
Function to destroy an object.
| JPH_NAMESPACE_BEGIN RTTI::RTTI | ( | const char * | inName, |
| int | inSize, | ||
| pCreateObjectFunction | inCreateObject, | ||
| pDestructObjectFunction | inDestructObject ) |
Constructor.
| RTTI::RTTI | ( | const char * | inName, |
| int | inSize, | ||
| pCreateObjectFunction | inCreateObject, | ||
| pDestructObjectFunction | inDestructObject, | ||
| pCreateRTTIFunction | inCreateRTTI ) |
| void RTTI::AddAttribute | ( | const SerializableAttribute & | inAttribute | ) |
Attribute access.
| void RTTI::AddBaseClass | ( | const RTTI * | inRTTI, |
| int | inOffset ) |
Add base class.
| const void * RTTI::CastTo | ( | const void * | inObject, |
| const RTTI * | inRTTI ) const |
Cast inObject of this type to object of type inRTTI, returns nullptr if the cast is unsuccessful.
| void * RTTI::CreateObject | ( | ) | const |
Create an object of this type (returns nullptr if the object is abstract).
| void RTTI::DestructObject | ( | void * | inObject | ) | const |
Destruct object of this type (does nothing if the object is abstract).
| const SerializableAttribute & RTTI::GetAttribute | ( | int | inIdx | ) | const |
| int RTTI::GetAttributeCount | ( | ) | const |
| const RTTI * RTTI::GetBaseClass | ( | int | inIdx | ) | const |
| int RTTI::GetBaseClassCount | ( | ) | const |
| uint32 RTTI::GetHash | ( | ) | const |
|
inline |
|
inline |
|
inline |
| bool RTTI::IsKindOf | ( | const RTTI * | inRTTI | ) | const |
Test if this class is derived from class of type inRTTI.
|
inline |
| bool RTTI::operator== | ( | const RTTI & | inRHS | ) | const |
Equality operators.
|
inlinestatic |
Create an object of type T for types that cannot use JPH_OVERRIDE_NEW_DELETE (e.g. primitive types).
|
inlinestatic |
Destruct an object created with sCreateObjectInternal.
|
inline |
|
protected |
All attributes of this class.
|
protected |
Names of base classes.
|
protected |
Pointer to a function that will create a new instance of this class.
|
protected |
Pointer to a function that will destruct an object of this class.
|
protected |
Class name.
|
protected |
Class size.