Urho3D::Variant Class Reference

Variable that supports a fixed set of types. More...

#include <Urho3D/Core/Variant.h>

Public Member Functions
	Variant ()=default
	Construct empty.
	Variant (int value)
	Construct from integer.
	Variant (long long value)
	Construct from 64 bit integer.
	Variant (unsigned value)
	Construct from unsigned integer.
	Variant (unsigned long long 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 ea::string &value)
	Construct from a string.
	Variant (const char *value)
	Construct from a C string.
	Variant (const VariantBuffer &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 Rect &value)
	Construct from a rect.
	Variant (const IntRect &value)
	Construct from an integer rect.
	Variant (const IntVector2 &value)
	Construct from an IntVector2.
	Variant (const IntVector3 &value)
	Construct from an IntVector3.
	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 VariantCurve &value)
	Construct from a VariantCurve.
	Variant (const StringVariantMap &value)
	Construct from a string variant map.
	Variant (const ea::string &type, const ea::string &value)
	Construct from type and value.
	Variant (VariantType type, const ea::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 (VariantType type)
	Construct from type.
	Variant (const Variant &value)
	Copy-construct from another variant.
	Variant (Variant &&value)
	Move-construct from another variant.
	~Variant ()
	Destruct.
void	Clear ()
	Reset to empty.
Variant &	operator= (const Variant &rhs)
	Assign from another variant.
Variant &	operator= (Variant &&rhs)
	Move-assign from another variant.
Variant &	operator= (int rhs)
	Assign from an integer.
Variant &	operator= (long long rhs)
	Assign from 64 bit integer.
Variant &	operator= (unsigned long long rhs)
	Assign from unsigned 64 bit 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 ea::string &rhs)
	Assign from a string.
Variant &	operator= (const char *rhs)
	Assign from a C string.
Variant &	operator= (const VariantBuffer &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 Rect &rhs)
	Assign from a rect.
Variant &	operator= (const IntRect &rhs)
	Assign from an integer rect.
Variant &	operator= (const IntVector2 &rhs)
	Assign from an IntVector2.
Variant &	operator= (const IntVector3 &rhs)
	Assign from an IntVector3.
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.
Variant &	operator= (const VariantCurve &rhs)
	Assign from a VariantCurve.
Variant &	operator= (const StringVariantMap &rhs)
	Assign from a string variant map.
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 64 bit integer. To return true, both the type and value must match.
bool	operator== (long long rhs) const
	Test for equality with an 64 bit integer. To return true, both the type and value must match.
bool	operator== (unsigned long long 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 ea::string &rhs) const
	Test for equality with a string. To return true, both the type and value must match.
bool	operator== (const VariantBuffer &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 Rect &rhs) const
	Test for equality with a rect. 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 IntVector3 &rhs) const
	Test for equality with an IntVector3. 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 VariantCurve &rhs) const
	Test for equality with a VariantCurve. To return true, both the type and value must match.
bool	operator== (const StringVariantMap &rhs) const
	Test for equality with a string variant map. 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!= (long long rhs) const
	Test for inequality with an 64 bit integer.
bool	operator!= (unsigned long long rhs) const
	Test for inequality with an unsigned 64 bit 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 ea::string &rhs) const
	Test for inequality with a string.
bool	operator!= (const VariantBuffer &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 Rect &rhs) const
	Test for inequality with a rect.
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 IntVector3 &rhs) const
	Test for inequality with an IntVector3.
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.
bool	operator!= (const VariantCurve &rhs) const
	Test for inequality with a VariantCurve.
bool	operator!= (const StringVariantMap &rhs) const
	Test for inequality with a variant map.
void	FromString (const ea::string &type, const ea::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 ea::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.
void	SetCustomVariantValue (const CustomVariantValue &value)
	Set custom value.
void	SetCustomVariantValue (CustomVariantValue &&value)
	Set custom value without copying.
Variant	Convert (VariantType targetType) const
	Convert variant value. Returns variant of VAR_NONE type if conversion fails / not possible.
template<class T >
void	SetCustom (T value)
	Set custom value.
int	GetInt () const
	Return int or zero on type mismatch. Floats and doubles are converted.
long long	GetInt64 () const
	Return 64 bit int or zero on type mismatch. Floats and doubles are converted.
unsigned long long	GetUInt64 () const
	Return unsigned 64 bit 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 ea::string &	GetString () const
	Return string or empty on type mismatch.
const VariantBuffer &	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 Rect &	GetRect () const
	Return a rect 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.
const IntVector3 &	GetIntVector3 () const
	Return an IntVector3 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.
const VariantCurve &	GetVariantCurve () const
	Return a VariantCurve or identity on type mismatch.
const StringVariantMap &	GetStringVariantMap () const
	Return a string variant map or empty on type mismatch.
CustomVariantValue *	GetCustomVariantValuePtr ()
	Return pointer to custom variant value.
const CustomVariantValue *	GetCustomVariantValuePtr () const
	Return const pointer to custom variant value.
template<class T >
T	GetCustom () const
	Return custom variant value or default-constructed on type mismatch.
template<class T >
bool	IsCustomType () const
	Return true if specified custom type is stored in the variant.
VariantType	GetType () const
ea::string	GetTypeName () const
ea::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
bool	IsEmpty () const
template<class T >
T	Get (ea::enable_if_t<!ea::is_enum_v< T >, int >=0) const
	Return the value, template version.
template<class T >
T	Get (ea::enable_if_t< ea::is_enum_v< T >, int >=0) const
	Return the value casted to enum.
template<class T >
ea::optional< T >	GetOptional () const
	Return the value as optional.
VariantBuffer *	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.
StringVariantMap *	GetStringVariantMapPtr ()
	Return a pointer to a modifiable string variant map or null on type mismatch.
template<class T >
T *	GetCustomPtr ()
	Return a pointer to a modifiable custom variant value or null on type mismatch.
template<class T >
const T *	GetCustomPtr () const
	Return a pointer to a constant custom variant value or null on type mismatch.
Variant	Lerp (const Variant &rhs, float t) const
	Linear interpolation. Supported for scalars, vectors and some other types.
unsigned	ToHash () const
	Hash function for containers.
template<>
int	Get (int) const
template<>
unsigned	Get (int) const
template<>
long long	Get (int) const
template<>
unsigned long long	Get (int) const
template<>
StringHash	Get (int) const
template<>
bool	Get (int) const
template<>
float	Get (int) const
template<>
double	Get (int) const
template<>
const Vector2 &	Get (int) const
template<>
const Vector3 &	Get (int) const
template<>
const Vector4 &	Get (int) const
template<>
const Quaternion &	Get (int) const
template<>
const Color &	Get (int) const
template<>
const Rect &	Get (int) const
template<>
const IntRect &	Get (int) const
template<>
const IntVector2 &	Get (int) const
template<>
const IntVector3 &	Get (int) const
template<>
const VariantBuffer &	Get (int) const
template<>
void *	Get (int) const
template<>
RefCounted *	Get (int) const
template<>
const Matrix3 &	Get (int) const
template<>
const Matrix3x4 &	Get (int) const
template<>
const Matrix4 &	Get (int) const
template<>
const VariantCurve &	Get (int) const
template<>
ResourceRef	Get (int) const
template<>
ResourceRefList	Get (int) const
template<>
VariantVector	Get (int) const
template<>
StringVector	Get (int) const
template<>
VariantMap	Get (int) const
template<>
Vector2	Get (int) const
template<>
Vector3	Get (int) const
template<>
Vector4	Get (int) const
template<>
Quaternion	Get (int) const
template<>
Color	Get (int) const
template<>
Rect	Get (int) const
template<>
IntRect	Get (int) const
template<>
IntVector2	Get (int) const
template<>
IntVector3	Get (int) const
template<>
VariantBuffer	Get (int) const
template<>
Matrix3	Get (int) const
template<>
Matrix3x4	Get (int) const
template<>
Matrix4	Get (int) const
template<>
VariantCurve	Get (int) const
template<>
StringVariantMap	Get (int) const
template<>
URHO3D_API int	Get (int) const
template<>
URHO3D_API unsigned	Get (int) const
template<>
URHO3D_API long long	Get (int) const
template<>
URHO3D_API unsigned long long	Get (int) const
template<>
URHO3D_API StringHash	Get (int) const
template<>
URHO3D_API bool	Get (int) const
template<>
URHO3D_API float	Get (int) const
template<>
URHO3D_API double	Get (int) const
template<>
const URHO3D_API Vector2 &	Get (int) const
template<>
const URHO3D_API Vector3 &	Get (int) const
template<>
const URHO3D_API Vector4 &	Get (int) const
template<>
const URHO3D_API Quaternion &	Get (int) const
template<>
const URHO3D_API Color &	Get (int) const
template<>
const URHO3D_API ea::string &	Get (int) const
template<>
const URHO3D_API Rect &	Get (int) const
template<>
const URHO3D_API IntRect &	Get (int) const
template<>
const URHO3D_API IntVector2 &	Get (int) const
template<>
const URHO3D_API IntVector3 &	Get (int) const
template<>
const URHO3D_API VariantBuffer &	Get (int) const
template<>
URHO3D_API void *	Get (int) const
template<>
URHO3D_API RefCounted *	Get (int) const
template<>
const URHO3D_API Matrix3 &	Get (int) const
template<>
const URHO3D_API Matrix3x4 &	Get (int) const
template<>
const URHO3D_API Matrix4 &	Get (int) const
template<>
const URHO3D_API VariantCurve &	Get (int) const
template<>
URHO3D_API ResourceRef	Get (int) const
template<>
URHO3D_API ResourceRefList	Get (int) const
template<>
URHO3D_API VariantVector	Get (int) const
template<>
URHO3D_API StringVector	Get (int) const
template<>
URHO3D_API VariantMap	Get (int) const
template<>
URHO3D_API Vector2	Get (int) const
template<>
URHO3D_API Vector3	Get (int) const
template<>
URHO3D_API Vector4	Get (int) const
template<>
URHO3D_API Quaternion	Get (int) const
template<>
URHO3D_API Color	Get (int) const
template<>
URHO3D_API ea::string	Get (int) const
template<>
URHO3D_API Rect	Get (int) const
template<>
URHO3D_API IntRect	Get (int) const
template<>
URHO3D_API IntVector2	Get (int) const
template<>
URHO3D_API IntVector3	Get (int) const
template<>
URHO3D_API VariantBuffer	Get (int) const
template<>
URHO3D_API Matrix3	Get (int) const
template<>
URHO3D_API Matrix3x4	Get (int) const
template<>
URHO3D_API Matrix4	Get (int) const
template<>
URHO3D_API VariantCurve	Get (int) const
template<>
URHO3D_API StringVariantMap	Get (int) const

Static Public Member Functions
static const char *const *	GetTypeNameList ()
	Return type name list.
static ea::string	GetTypeName (VariantType type)
	Return name for variant type.
static VariantType	GetTypeFromName (const ea::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 VariantBuffer	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.
static const VariantCurve	emptyCurve
	Empty variant curve.
static const StringVariantMap	emptyStringVariantMap
	Empty string variant map.

Private Member Functions
void	SetType (VariantType newType)
	Set new type and allocate/deallocate memory as necessary.

Private Attributes
VariantType	type_ = VAR_NONE
	Variant type.
VariantValue	value_
	Variant value.

Detailed Description

Variable that supports a fixed set of types.

Member Function Documentation

GetType()

VariantType Urho3D::Variant::GetType ( ) const

inline

Return value's type.

GetTypeName()

ea::string Urho3D::Variant::GetTypeName

(

)

const

Return value's type name.

IsEmpty()

bool Urho3D::Variant::IsEmpty ( ) const

inline

Return true when the variant is empty (i.e. not initialized yet).

IsZero()

bool Urho3D::Variant::IsZero

(

)

const

Return true when the variant value is considered zero according to its actual type.

---

The documentation for this class was generated from the following files:

• Urho3D/Core/Variant.h
• Urho3D/Core/Variant.cpp