Urho3D::Variant Class Reference
Public Member Functions |
Static Public Member Functions |
Static Public Attributes |
Private Member Functions |
Private Attributes |
List of all members
Urho3D::Variant Class Reference
Variable that supports a fixed set of types. More...
#include <Urho3D/Core/Variant.h>
Collaboration diagram for Urho3D::Variant:
Public Member Functions | |
| Variant () | |
| Construct empty. | |
| Variant (int value) | |
| Construct from integer. | |
| Variant (unsigned value) | |
| Construct from unsigned integer. | |
| Variant (const StringHash &value) | |
| Construct from a string hash (convert to integer). | |
| Variant (bool value) | |
| Construct from a bool. | |
| Variant (float value) | |
| Construct from a float. | |
| Variant (double value) | |
| Construct from a double. | |
| Variant (const Vector2 &value) | |
| Construct from a Vector2. | |
| Variant (const Vector3 &value) | |
| Construct from a Vector3. | |
| Variant (const Vector4 &value) | |
| Construct from a Vector4. | |
| Variant (const Quaternion &value) | |
| Construct from a quaternion. | |
| Variant (const Color &value) | |
| Construct from a color. | |
| Variant (const String &value) | |
| Construct from a string. | |
| Variant (const char *value) | |
| Construct from a C string. | |
| Variant (const PODVector< unsigned char > &value) | |
| Construct from a buffer. | |
| Variant (const VectorBuffer &value) | |
| Construct from a VectorBuffer and store as a buffer. | |
| Variant (void *value) | |
| Construct from a pointer. | |
| Variant (const ResourceRef &value) | |
| Construct from a resource reference. | |
| Variant (const ResourceRefList &value) | |
| Construct from a resource reference list. | |
| Variant (const VariantVector &value) | |
| Construct from a variant vector. | |
| Variant (const VariantMap &value) | |
| Construct from a variant map. | |
| Variant (const StringVector &value) | |
| Construct from a string vector. | |
| Variant (const IntRect &value) | |
| Construct from an integer rect. | |
| Variant (const IntVector2 &value) | |
| Construct from an IntVector2. | |
| Variant (RefCounted *value) | |
| Construct from a RefCounted pointer. The object will be stored internally in a WeakPtr so that its expiration can be detected safely. | |
| Variant (const Matrix3 &value) | |
| Construct from a Matrix3. | |
| Variant (const Matrix3x4 &value) | |
| Construct from a Matrix3x4. | |
| Variant (const Matrix4 &value) | |
| Construct from a Matrix4. | |
| Variant (const String &type, const String &value) | |
| Construct from type and value. | |
| Variant (VariantType type, const String &value) | |
| Construct from type and value. | |
| Variant (const char *type, const char *value) | |
| Construct from type and value. | |
| Variant (VariantType type, const char *value) | |
| Construct from type and value. | |
| Variant (const Variant &value) | |
| Copy-construct from another variant. | |
| ~Variant () | |
| Destruct. | |
| void | Clear () |
| Reset to empty. | |
| Variant & | operator= (const Variant &rhs) |
| Assign from another variant. | |
| Variant & | operator= (int rhs) |
| Assign from an integer. | |
| Variant & | operator= (unsigned rhs) |
| Assign from an unsigned integer. | |
| Variant & | operator= (const StringHash &rhs) |
| Assign from a StringHash (convert to integer.) | |
| Variant & | operator= (bool rhs) |
| Assign from a bool. | |
| Variant & | operator= (float rhs) |
| Assign from a float. | |
| Variant & | operator= (double rhs) |
| Assign from a double. | |
| Variant & | operator= (const Vector2 &rhs) |
| Assign from a Vector2. | |
| Variant & | operator= (const Vector3 &rhs) |
| Assign from a Vector3. | |
| Variant & | operator= (const Vector4 &rhs) |
| Assign from a Vector4. | |
| Variant & | operator= (const Quaternion &rhs) |
| Assign from a quaternion. | |
| Variant & | operator= (const Color &rhs) |
| Assign from a color. | |
| Variant & | operator= (const String &rhs) |
| Assign from a string. | |
| Variant & | operator= (const char *rhs) |
| Assign from a C string. | |
| Variant & | operator= (const PODVector< unsigned char > &rhs) |
| Assign from a buffer. | |
| Variant & | operator= (const VectorBuffer &rhs) |
| Assign from a VectorBuffer and store as a buffer. | |
| Variant & | operator= (void *rhs) |
| Assign from a void pointer. | |
| Variant & | operator= (const ResourceRef &rhs) |
| Assign from a resource reference. | |
| Variant & | operator= (const ResourceRefList &rhs) |
| Assign from a resource reference list. | |
| Variant & | operator= (const VariantVector &rhs) |
| Assign from a variant vector. | |
| Variant & | operator= (const StringVector &rhs) |
| Assign from a string vector. | |
| Variant & | operator= (const VariantMap &rhs) |
| Assign from a variant map. | |
| Variant & | operator= (const IntRect &rhs) |
| Assign from an integer rect. | |
| Variant & | operator= (const IntVector2 &rhs) |
| Assign from an IntVector2. | |
| Variant & | operator= (RefCounted *rhs) |
| Assign from a RefCounted pointer. The object will be stored internally in a WeakPtr so that its expiration can be detected safely. | |
| Variant & | operator= (const Matrix3 &rhs) |
| Assign from a Matrix3. | |
| Variant & | operator= (const Matrix3x4 &rhs) |
| Assign from a Matrix3x4. | |
| Variant & | operator= (const Matrix4 &rhs) |
| Assign from a Matrix4. | |
| bool | operator== (const Variant &rhs) const |
| Test for equality with another variant. | |
| bool | operator== (int rhs) const |
| Test for equality with an integer. To return true, both the type and value must match. | |
| bool | operator== (unsigned rhs) const |
| Test for equality with an unsigned integer. To return true, both the type and value must match. | |
| bool | operator== (bool rhs) const |
| Test for equality with a bool. To return true, both the type and value must match. | |
| bool | operator== (float rhs) const |
| Test for equality with a float. To return true, both the type and value must match. | |
| bool | operator== (double rhs) const |
| Test for equality with a double. To return true, both the type and value must match. | |
| bool | operator== (const Vector2 &rhs) const |
| Test for equality with a Vector2. To return true, both the type and value must match. | |
| bool | operator== (const Vector3 &rhs) const |
| Test for equality with a Vector3. To return true, both the type and value must match. | |
| bool | operator== (const Vector4 &rhs) const |
| Test for equality with a Vector4. To return true, both the type and value must match. | |
| bool | operator== (const Quaternion &rhs) const |
| Test for equality with a quaternion. To return true, both the type and value must match. | |
| bool | operator== (const Color &rhs) const |
| Test for equality with a color. To return true, both the type and value must match. | |
| bool | operator== (const String &rhs) const |
| Test for equality with a string. To return true, both the type and value must match. | |
| bool | operator== (const PODVector< unsigned char > &rhs) const |
| Test for equality with a buffer. To return true, both the type and value must match. | |
| bool | operator== (const VectorBuffer &rhs) const |
| Test for equality with a VectorBuffer. To return true, both the type and value must match. | |
| bool | operator== (void *rhs) const |
| Test for equality with a void pointer. To return true, both the type and value must match, with the exception that a RefCounted pointer is also allowed. | |
| bool | operator== (const ResourceRef &rhs) const |
| Test for equality with a resource reference. To return true, both the type and value must match. | |
| bool | operator== (const ResourceRefList &rhs) const |
| Test for equality with a resource reference list. To return true, both the type and value must match. | |
| bool | operator== (const VariantVector &rhs) const |
| Test for equality with a variant vector. To return true, both the type and value must match. | |
| bool | operator== (const StringVector &rhs) const |
| Test for equality with a string vector. To return true, both the type and value must match. | |
| bool | operator== (const VariantMap &rhs) const |
| Test for equality with a variant map. To return true, both the type and value must match. | |
| bool | operator== (const IntRect &rhs) const |
| Test for equality with an integer rect. To return true, both the type and value must match. | |
| bool | operator== (const IntVector2 &rhs) const |
| Test for equality with an IntVector2. To return true, both the type and value must match. | |
| bool | operator== (const StringHash &rhs) const |
| Test for equality with a StringHash. To return true, both the type and value must match. | |
| bool | operator== (RefCounted *rhs) const |
| Test for equality with a RefCounted pointer. To return true, both the type and value must match, with the exception that void pointer is also allowed. | |
| bool | operator== (const Matrix3 &rhs) const |
| Test for equality with a Matrix3. To return true, both the type and value must match. | |
| bool | operator== (const Matrix3x4 &rhs) const |
| Test for equality with a Matrix3x4. To return true, both the type and value must match. | |
| bool | operator== (const Matrix4 &rhs) const |
| Test for equality with a Matrix4. To return true, both the type and value must match. | |
| bool | operator!= (const Variant &rhs) const |
| Test for inequality with another variant. | |
| bool | operator!= (int rhs) const |
| Test for inequality with an integer. | |
| bool | operator!= (unsigned rhs) const |
| Test for inequality with an unsigned integer. | |
| bool | operator!= (bool rhs) const |
| Test for inequality with a bool. | |
| bool | operator!= (float rhs) const |
| Test for inequality with a float. | |
| bool | operator!= (double rhs) const |
| Test for inequality with a double. | |
| bool | operator!= (const Vector2 &rhs) const |
| Test for inequality with a Vector2. | |
| bool | operator!= (const Vector3 &rhs) const |
| Test for inequality with a Vector3. | |
| bool | operator!= (const Vector4 &rhs) const |
| Test for inequality with an Vector4. | |
| bool | operator!= (const Quaternion &rhs) const |
| Test for inequality with a Quaternion. | |
| bool | operator!= (const String &rhs) const |
| Test for inequality with a string. | |
| bool | operator!= (const PODVector< unsigned char > &rhs) const |
| Test for inequality with a buffer. | |
| bool | operator!= (const VectorBuffer &rhs) const |
| Test for inequality with a VectorBuffer. | |
| bool | operator!= (void *rhs) const |
| Test for inequality with a pointer. | |
| bool | operator!= (const ResourceRef &rhs) const |
| Test for inequality with a resource reference. | |
| bool | operator!= (const ResourceRefList &rhs) const |
| Test for inequality with a resource reference list. | |
| bool | operator!= (const VariantVector &rhs) const |
| Test for inequality with a variant vector. | |
| bool | operator!= (const StringVector &rhs) const |
| Test for inequality with a string vector. | |
| bool | operator!= (const VariantMap &rhs) const |
| Test for inequality with a variant map. | |
| bool | operator!= (const IntRect &rhs) const |
| Test for inequality with an integer rect. | |
| bool | operator!= (const IntVector2 &rhs) const |
| Test for inequality with an IntVector2. | |
| bool | operator!= (const StringHash &rhs) const |
| Test for inequality with a StringHash. | |
| bool | operator!= (RefCounted *rhs) const |
| Test for inequality with a RefCounted pointer. | |
| bool | operator!= (const Matrix3 &rhs) const |
| Test for inequality with a Matrix3. | |
| bool | operator!= (const Matrix3x4 &rhs) const |
| Test for inequality with a Matrix3x4. | |
| bool | operator!= (const Matrix4 &rhs) const |
| Test for inequality with a Matrix4. | |
| void | FromString (const String &type, const String &value) |
| Set from typename and value strings. Pointers will be set to null, and VariantBuffer or VariantMap types are not supported. | |
| void | FromString (const char *type, const char *value) |
| Set from typename and value strings. Pointers will be set to null, and VariantBuffer or VariantMap types are not supported. | |
| void | FromString (VariantType type, const String &value) |
| Set from type and value string. Pointers will be set to null, and VariantBuffer or VariantMap types are not supported. | |
| void | FromString (VariantType type, const char *value) |
| Set from type and value string. Pointers will be set to null, and VariantBuffer or VariantMap types are not supported. | |
| void | SetBuffer (const void *data, unsigned size) |
| Set buffer type from a memory area. | |
| int | GetInt () const |
| Return int or zero on type mismatch. Floats and doubles are converted. | |
| unsigned | GetUInt () const |
| Return unsigned int or zero on type mismatch. Floats and doubles are converted. | |
| StringHash | GetStringHash () const |
| Return StringHash or zero on type mismatch. | |
| bool | GetBool () const |
| Return bool or false on type mismatch. | |
| float | GetFloat () const |
| Return float or zero on type mismatch. Ints and doubles are converted. | |
| double | GetDouble () const |
| Return double or zero on type mismatch. Ints and floats are converted. | |
| const Vector2 & | GetVector2 () const |
| Return Vector2 or zero on type mismatch. | |
| const Vector3 & | GetVector3 () const |
| Return Vector3 or zero on type mismatch. | |
| const Vector4 & | GetVector4 () const |
| Return Vector4 or zero on type mismatch. | |
| const Quaternion & | GetQuaternion () const |
| Return quaternion or identity on type mismatch. | |
| const Color & | GetColor () const |
| Return color or default on type mismatch. Vector4 is aliased to Color if necessary. | |
| const String & | GetString () const |
| Return string or empty on type mismatch. | |
| const PODVector< unsigned char > & | GetBuffer () const |
| Return buffer or empty on type mismatch. | |
| VectorBuffer | GetVectorBuffer () const |
| Return VectorBuffer containing the buffer or empty on type mismatch. | |
| void * | GetVoidPtr () const |
| Return void pointer or null on type mismatch. RefCounted pointer will be converted. | |
| const ResourceRef & | GetResourceRef () const |
| Return a resource reference or empty on type mismatch. | |
| const ResourceRefList & | GetResourceRefList () const |
| Return a resource reference list or empty on type mismatch. | |
| const VariantVector & | GetVariantVector () const |
| Return a variant vector or empty on type mismatch. | |
| const StringVector & | GetStringVector () const |
| Return a string vector or empty on type mismatch. | |
| const VariantMap & | GetVariantMap () const |
| Return a variant map or empty on type mismatch. | |
| const IntRect & | GetIntRect () const |
| Return an integer rect or empty on type mismatch. | |
| const IntVector2 & | GetIntVector2 () const |
| Return an IntVector2 or empty on type mismatch. | |
| RefCounted * | GetPtr () const |
| Return a RefCounted pointer or null on type mismatch. Will return null if holding a void pointer, as it can not be safely verified that the object is a RefCounted. | |
| const Matrix3 & | GetMatrix3 () const |
| Return a Matrix3 or identity on type mismatch. | |
| const Matrix3x4 & | GetMatrix3x4 () const |
| Return a Matrix3x4 or identity on type mismatch. | |
| const Matrix4 & | GetMatrix4 () const |
| Return a Matrix4 or identity on type mismatch. | |
| VariantType | GetType () const |
| Return value's type. | |
| String | GetTypeName () const |
| Return value's type name. | |
| String | ToString () const |
| Convert value to string. Pointers are returned as null, and VariantBuffer or VariantMap are not supported and return empty. | |
| bool | IsZero () const |
| Return true when the variant value is considered zero according to its actual type. | |
| bool | IsEmpty () const |
| Return true when the variant is empty (i.e. not initialized yet). | |
| template<class T > | |
| T | Get () const |
| Return the value, template version. | |
| PODVector< unsigned char > * | GetBufferPtr () |
| Return a pointer to a modifiable buffer or null on type mismatch. | |
| VariantVector * | GetVariantVectorPtr () |
| Return a pointer to a modifiable variant vector or null on type mismatch. | |
| StringVector * | GetStringVectorPtr () |
| Return a pointer to a modifiable string vector or null on type mismatch. | |
| VariantMap * | GetVariantMapPtr () |
| Return a pointer to a modifiable variant map or null on type mismatch. | |
| template<> | |
| int | Get () const |
| template<> | |
| unsigned | Get () const |
| template<> | |
| StringHash | Get () const |
| template<> | |
| bool | Get () const |
| template<> | |
| float | Get () const |
| template<> | |
| double | Get () const |
| template<> | |
| const Vector2 & | Get () const |
| template<> | |
| const Vector3 & | Get () const |
| template<> | |
| const Vector4 & | Get () const |
| template<> | |
| const Quaternion & | Get () const |
| template<> | |
| const Color & | Get () const |
| template<> | |
| const String & | Get () const |
| template<> | |
| const IntRect & | Get () const |
| template<> | |
| const IntVector2 & | Get () const |
| template<> | |
| const PODVector< unsigned char > & | Get () const |
| template<> | |
| void * | Get () const |
| template<> | |
| RefCounted * | Get () const |
| template<> | |
| const Matrix3 & | Get () const |
| template<> | |
| const Matrix3x4 & | Get () const |
| template<> | |
| const Matrix4 & | Get () const |
| template<> | |
| ResourceRef | Get () const |
| template<> | |
| ResourceRefList | Get () const |
| template<> | |
| VariantVector | Get () const |
| template<> | |
| StringVector | Get () const |
| template<> | |
| VariantMap | Get () const |
| template<> | |
| Vector2 | Get () const |
| template<> | |
| Vector3 | Get () const |
| template<> | |
| Vector4 | Get () const |
| template<> | |
| Quaternion | Get () const |
| template<> | |
| Color | Get () const |
| template<> | |
| String | Get () const |
| template<> | |
| IntRect | Get () const |
| template<> | |
| IntVector2 | Get () const |
| template<> | |
| PODVector< unsigned char > | Get () const |
| template<> | |
| Matrix3 | Get () const |
| template<> | |
| Matrix3x4 | Get () const |
| template<> | |
| Matrix4 | Get () const |
| template<> | |
| URHO3D_API int | Get () const |
| template<> | |
| URHO3D_API unsigned | Get () const |
| template<> | |
| URHO3D_API StringHash | Get () const |
| template<> | |
| URHO3D_API bool | Get () const |
| template<> | |
| URHO3D_API float | Get () const |
| template<> | |
| URHO3D_API double | Get () const |
| template<> | |
| URHO3D_API const Vector2 & | Get () const |
| template<> | |
| URHO3D_API const Vector3 & | Get () const |
| template<> | |
| URHO3D_API const Vector4 & | Get () const |
| template<> | |
| URHO3D_API const Quaternion & | Get () const |
| template<> | |
| URHO3D_API const Color & | Get () const |
| template<> | |
| URHO3D_API const String & | Get () const |
| template<> | |
| URHO3D_API const IntRect & | Get () const |
| template<> | |
| URHO3D_API const IntVector2 & | Get () const |
| template<> | |
| URHO3D_API const PODVector < unsigned char > & | Get () const |
| template<> | |
| URHO3D_API void * | Get () const |
| template<> | |
| URHO3D_API RefCounted * | Get () const |
| template<> | |
| URHO3D_API const Matrix3 & | Get () const |
| template<> | |
| URHO3D_API const Matrix3x4 & | Get () const |
| template<> | |
| URHO3D_API const Matrix4 & | Get () const |
| template<> | |
| URHO3D_API ResourceRef | Get () const |
| template<> | |
| URHO3D_API ResourceRefList | Get () const |
| template<> | |
| URHO3D_API VariantVector | Get () const |
| template<> | |
| URHO3D_API StringVector | Get () const |
| template<> | |
| URHO3D_API VariantMap | Get () const |
| template<> | |
| URHO3D_API Vector2 | Get () const |
| template<> | |
| URHO3D_API Vector3 | Get () const |
| template<> | |
| URHO3D_API Vector4 | Get () const |
| template<> | |
| URHO3D_API Quaternion | Get () const |
| template<> | |
| URHO3D_API Color | Get () const |
| template<> | |
| URHO3D_API String | Get () const |
| template<> | |
| URHO3D_API IntRect | Get () const |
| template<> | |
| URHO3D_API IntVector2 | Get () const |
| template<> | |
| URHO3D_API PODVector< unsigned char > | Get () const |
| template<> | |
| URHO3D_API Matrix3 | Get () const |
| template<> | |
| URHO3D_API Matrix3x4 | Get () const |
| template<> | |
| URHO3D_API Matrix4 | Get () const |
| template<> | |
| const VariantValue * | Get () const |
Static Public Member Functions | |
| static String | GetTypeName (VariantType type) |
| Return name for variant type. | |
| static VariantType | GetTypeFromName (const String &typeName) |
| Return variant type from type name. | |
| static VariantType | GetTypeFromName (const char *typeName) |
| Return variant type from type name. | |
Static Public Attributes | |
| static const Variant | EMPTY |
| Empty variant. | |
|
static const PODVector < unsigned char > | emptyBuffer |
| Empty buffer. | |
| static const ResourceRef | emptyResourceRef |
| Empty resource reference. | |
| static const ResourceRefList | emptyResourceRefList |
| Empty resource reference list. | |
| static const VariantMap | emptyVariantMap |
| Empty variant map. | |
| static const VariantVector | emptyVariantVector |
| Empty variant vector. | |
| static const StringVector | emptyStringVector |
| Empty string vector. | |
Private Member Functions | |
| void | SetType (VariantType newType) |
| Set new type and allocate/deallocate memory as necessary. | |
Private Attributes | |
| VariantType | type_ |
| Variant type. | |
| VariantValue | value_ |
| Variant value. | |
Detailed Description
Variable that supports a fixed set of types.
The documentation for this class was generated from the following files:
- Source/Urho3D/Core/Variant.h
- Source/Urho3D/Core/Variant.cpp
- Source/Urho3D/LuaScript/ToluaUtils.cpp