#include <CesiumMetadataValue.h>

Inheritance diagram for UCesiumMetadataValueBlueprintLibrary:

Static Public Member Functions
static ECesiumMetadataBlueprintType	GetBlueprintType (UPARAM(ref) const FCesiumMetadataValue &Value)
	Gets the best-fitting Blueprints type for this value.

static ECesiumMetadataBlueprintType	GetArrayElementBlueprintType (UPARAM(ref) const FCesiumMetadataValue &Value)
	Gets the best-fitting Blueprints type for the elements of this array value.

static FCesiumMetadataValueType	GetValueType (UPARAM(ref) const FCesiumMetadataValue &Value)
	Gets the type of the metadata value as defined in the EXT_structural_metadata extension.

static PRAGMA_DISABLE_DEPRECATION_WARNINGS ECesiumMetadataTrueType_DEPRECATED	GetTrueType (UPARAM(ref) const FCesiumMetadataValue &Value)
	Gets true type of the value.

static ECesiumMetadataTrueType_DEPRECATED	GetTrueComponentType (UPARAM(ref) const FCesiumMetadataValue &Value)
	Gets true type of the elements in the array.

static PRAGMA_ENABLE_DEPRECATION_WARNINGS bool	GetBoolean (UPARAM(ref) const FCesiumMetadataValue &value, bool DefaultValue)
	Attempts to retrieve the value as a boolean.

static uint8	GetByte (UPARAM(ref) const FCesiumMetadataValue &Value, uint8 DefaultValue)
	Attempts to retrieve the value as an unsigned 8-bit integer.

static int32	GetInteger (UPARAM(ref) const FCesiumMetadataValue &Value, int32 DefaultValue)
	Attempts to retrieve the value as a signed 32-bit integer.

static int64	GetInteger64 (UPARAM(ref) const FCesiumMetadataValue &Value, int64 DefaultValue)
	Attempts to retrieve the value as a signed 64-bit integer.

static float	GetFloat (UPARAM(ref) const FCesiumMetadataValue &Value, float DefaultValue)
	Attempts to retrieve the value as a single-precision floating-point number.

static double	GetFloat64 (UPARAM(ref) const FCesiumMetadataValue &Value, double DefaultValue)
	Attempts to retrieve the value as a double-precision floating-point number.

static FIntPoint	GetIntPoint (UPARAM(ref) const FCesiumMetadataValue &Value, const FIntPoint &DefaultValue)
	Attempts to retrieve the value as a FIntPoint.

static FVector2D	GetVector2D (UPARAM(ref) const FCesiumMetadataValue &Value, const FVector2D &DefaultValue)
	Attempts to retrieve the value as a FVector2D.

static FIntVector	GetIntVector (UPARAM(ref) const FCesiumMetadataValue &Value, const FIntVector &DefaultValue)
	Attempts to retrieve the value as a FIntVector.

static FVector3f	GetVector3f (UPARAM(ref) const FCesiumMetadataValue &Value, const FVector3f &DefaultValue)
	Attempts to retrieve the value as a FVector3f.

static FVector	GetVector (UPARAM(ref) const FCesiumMetadataValue &Value, const FVector &DefaultValue)
	Attempts to retrieve the value as a FVector.

static FVector4	GetVector4 (UPARAM(ref) const FCesiumMetadataValue &Value, const FVector4 &DefaultValue)
	Attempts to retrieve the value as a FVector4.

static FMatrix	GetMatrix (UPARAM(ref) const FCesiumMetadataValue &Value, const FMatrix &DefaultValue)
	Attempts to retrieve the value as a FMatrix.

static FString	GetString (UPARAM(ref) const FCesiumMetadataValue &Value, const FString &DefaultValue)
	Attempts to retrieve the value as a FString.

static FCesiumPropertyArray	GetArray (UPARAM(ref) const FCesiumMetadataValue &Value)
	Attempts to retrieve the value as a FCesiumPropertyArray.

static bool	IsEmpty (UPARAM(ref) const FCesiumMetadataValue &Value)
	Whether the value is empty, i.e., whether it does not actually represent any data.

static TMap< FString, FString >	GetValuesAsStrings (const TMap< FString, FCesiumMetadataValue > &Values)
	Gets the given map of metadata values as a new map of strings, mapped by name.

Detailed Description

Definition at line 257 of file CesiumMetadataValue.h.

Member Function Documentation

◆ GetArray()

static FCesiumPropertyArray UCesiumMetadataValueBlueprintLibrary::GetArray ( UPARAM(ref) const FCesiumMetadataValue & Value )

static

Attempts to retrieve the value as a FCesiumPropertyArray.

If the property is not an array type, this returns an empty array.

Parameters

Value The metadata value to retrieve.

Returns: The value as a FCesiumPropertyArray.

◆ GetArrayElementBlueprintType()

static ECesiumMetadataBlueprintType UCesiumMetadataValueBlueprintLibrary::GetArrayElementBlueprintType ( UPARAM(ref) const FCesiumMetadataValue & Value )

static

Gets the best-fitting Blueprints type for the elements of this array value.

If the given value is not of an array type, this returns None.

◆ GetBlueprintType()

static ECesiumMetadataBlueprintType UCesiumMetadataValueBlueprintLibrary::GetBlueprintType ( UPARAM(ref) const FCesiumMetadataValue & Value )

static

Gets the best-fitting Blueprints type for this value.

For the most precise representation of the value possible from Blueprints, you should retrieve it using this type.

◆ GetBoolean()

static PRAGMA_ENABLE_DEPRECATION_WARNINGS bool UCesiumMetadataValueBlueprintLibrary::GetBoolean	(	UPARAM(ref) const FCesiumMetadataValue &	value,
		bool	DefaultValue )

static

Attempts to retrieve the value as a boolean.

If the value is a boolean, it is returned as-is.

If the value is a scalar, zero is converted to false, while any other value is converted to true.

If the value is a string, "0", "false", and "no" (case-insensitive) are converted to false, while "1", "true", and "yes" are converted to true. All other strings, including strings that can be converted to numbers, will return the default value.

All other types return the default value.

Parameters

value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a Boolean.

Returns: The value as a Boolean.

◆ GetByte()

static uint8 UCesiumMetadataValueBlueprintLibrary::GetByte	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		uint8	DefaultValue )

static

Attempts to retrieve the value as an unsigned 8-bit integer.

If the value is an integer between 0 and 255, it is returned as-is.

If the value is a floating-point number in the aforementioned range, it is truncated (rounded toward zero) and returned.

If the value is a boolean, 1 is returned for true and 0 for false.

If the value is a string and the entire string can be parsed as an integer between 0 and 255, the parsed value is returned. The string is parsed in a locale-independent way and does not support the use of commas or other delimiters to group digits together.

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a Byte.

Returns: The value as a Byte.

◆ GetFloat()

static float UCesiumMetadataValueBlueprintLibrary::GetFloat	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		float	DefaultValue )

static

Attempts to retrieve the value as a single-precision floating-point number.

If the value is already a single-precision floating-point number, it is returned as-is.

If the value is a scalar of any other type within the range of values that a single-precision float can represent, it is converted to its closest representation as a single-precision float and returned.

If the value is a boolean, 1.0f is returned for true and 0.0f for false.

If the value is a string, and the entire string can be parsed as a number, the parsed value is returned. The string is parsed in a locale-independent way and does not support the use of a comma or other delimiter to group digits togther.

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a Float.

Returns: The value as a Float.

◆ GetFloat64()

static double UCesiumMetadataValueBlueprintLibrary::GetFloat64	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		double	DefaultValue )

static

Attempts to retrieve the value as a double-precision floating-point number.

If the value is a single- or double-precision floating-point number, it is returned as-is.

If the value is an integer, it is converted to the closest representable double-precision floating-point number.

If the value is a boolean, 1.0 is returned for true and 0.0 for false.

If the value is a string and the entire string can be parsed as a number, the parsed value is returned. The string is parsed in a locale-independent way and does not support the use of commas or other delimiters to group digits together.

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a Float64.

Returns: The value as a Float64.

◆ GetInteger()

static int32 UCesiumMetadataValueBlueprintLibrary::GetInteger	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		int32	DefaultValue )

static

Attempts to retrieve the value as a signed 32-bit integer.

If the value is an integer between -2,147,483,648 and 2,147,483,647, it is returned as-is.

If the value is a floating-point number in the aforementioned range, it is truncated (rounded toward zero) and returned;

If the value is a boolean, 1 is returned for true and 0 for false.

If the value is a string and the entire string can be parsed as an integer in the valid range, the parsed value is returned. If it can be parsed as a floating-point number, the parsed value is truncated (rounded toward zero). In either case, the string is parsed in a locale-independent way and does not support the use of commas or other delimiters to group digits together.

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to an Integer.

Returns: The value as an Integer.

◆ GetInteger64()

static int64 UCesiumMetadataValueBlueprintLibrary::GetInteger64	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		int64	DefaultValue )

static

Attempts to retrieve the value as a signed 64-bit integer.

If the value is an integer and between -2^63 and (2^63 - 1), it is returned as-is.

If the value is a floating-point number in the aforementioned range, it is truncated (rounded toward zero) and returned;

If the value is a boolean, 1 is returned for true and 0 for false.

If the value is a string and the entire string can be parsed as an integer in the valid range, the parsed value is returned. If it can be parsed as a floating-point number, the parsed value is truncated (rounded toward zero). In either case, the string is parsed in a locale-independent way and does not support the use of commas or other delimiters to group digits together.

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to an Integer64.

Returns: The value as an Integer64.

◆ GetIntPoint()

static FIntPoint UCesiumMetadataValueBlueprintLibrary::GetIntPoint	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		const FIntPoint &	DefaultValue )

static

Attempts to retrieve the value as a FIntPoint.

If the value is a 2-dimensional vector, its components will be converted to 32-bit signed integers if possible.

If the value is a 3- or 4-dimensional vector, it will use the first two components to construct the FIntPoint.

If the value is a scalar that can be converted to a 32-bit signed integer, the resulting FIntPoint will have this value in both of its components.

If the value is a boolean, (1, 1) is returned for true, while (0, 0) is returned for false.

If the value is a string that can be parsed as a FIntPoint, the parsed value is returned. The string must be formatted as "X=... Y=...".

In all other cases, the default value is returned. In all vector cases, if any of the relevant components cannot be represented as a 32-bit signed, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a FIntPoint.

Returns: The value as a FIntPoint.

◆ GetIntVector()

static FIntVector UCesiumMetadataValueBlueprintLibrary::GetIntVector	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		const FIntVector &	DefaultValue )

static

Attempts to retrieve the value as a FIntVector.

If the value is a 3-dimensional vector, its components will be converted to 32-bit signed integers if possible.

If the value is a 4-dimensional vector, it will use the first three components to construct the FIntVector.

If the value is a 2-dimensional vector, it will become the XY-components of the FIntVector. The Z component will be set to zero.

If the value is a scalar that can be converted to a 32-bit signed integer, the resulting FIntVector will have this value in all of its components.

If the value is a boolean, (1, 1, 1) is returned for true, while (0, 0, 0) is returned for false.

If the value is a string that can be parsed as a FIntVector, the parsed value is returned. The string must be formatted as "X=... Y=... Z=".

In all other cases, the default value is returned. In all vector cases, if any of the relevant components cannot be represented as a 32-bit signed integer, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a FIntVector.

Returns: The value as a FIntVector.

◆ GetMatrix()

static FMatrix UCesiumMetadataValueBlueprintLibrary::GetMatrix	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		const FMatrix &	DefaultValue )

static

Attempts to retrieve the value as a FMatrix.

If the value is a 4-by-4 matrix, its components will be converted to double-precision floating-point numbers.

If the value is a 3-by-3 matrix, it will initialize the corresponding entries of the FMatrix, while all other entries are set to zero. In other words, the 3-by-3 matrix is returned in an FMatrix where the fourth row and column are filled with zeroes.

If the value is a 2-by-2 matrix, it will initialize the corresponding entries of the FMatrix, while all other entries are set to zero. In other words, the 2-by-2 matrix is returned in an FMatrix where the third and fourth rows / columns are filled with zeroes.

If the value is a scalar, then the resulting FMatrix will have this value along its diagonal, including the very last component. All other entries will be zero.

If the value is a boolean, it is converted to 1.0 for true and 0.0 for false. Then, the resulting FMatrix will have this value along its diagonal, including the very last component. All other entries will be zero.

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a FMatrix.

Returns: The value as a FMatrix.

◆ GetString()

static FString UCesiumMetadataValueBlueprintLibrary::GetString	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		const FString &	DefaultValue )

static

Attempts to retrieve the value as a FString.

String properties are returned as-is.

Scalar values are converted to a string with std::to_string.

Boolean properties are converted to "true" or "false".

Vector properties are returned as strings in the format "X=... Y=... Z=... W=..." depending on how many components they have.

Matrix properties are returned as strings row-by-row, where each row's values are printed between square brackets. For example, a 2-by-2 matrix will be printed out as "[A B] [C D]".

Array properties return the default value.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a FString.

Returns: The value as a FString.

◆ GetTrueComponentType()

static ECesiumMetadataTrueType_DEPRECATED UCesiumMetadataValueBlueprintLibrary::GetTrueComponentType ( UPARAM(ref) const FCesiumMetadataValue & Value )

static

Gets true type of the elements in the array.

If this value is not an array, the component type will be None. Many of these types are not accessible from Blueprints, but can be converted to a Blueprint-accessible type.

◆ GetTrueType()

static PRAGMA_DISABLE_DEPRECATION_WARNINGS ECesiumMetadataTrueType_DEPRECATED UCesiumMetadataValueBlueprintLibrary::GetTrueType ( UPARAM(ref) const FCesiumMetadataValue & Value )

static

Gets true type of the value.

Many of these types are not accessible from Blueprints, but can be converted to a Blueprint-accessible type.

◆ GetValuesAsStrings()

static TMap< FString, FString > UCesiumMetadataValueBlueprintLibrary::GetValuesAsStrings ( const TMap< FString, FCesiumMetadataValue > & Values )

static

Gets the given map of metadata values as a new map of strings, mapped by name.

This is useful for displaying the values from a property table or property texture as strings in a user interface.

Array properties cannot be converted to strings, so empty strings will be returned for their values.

◆ GetValueType()

static FCesiumMetadataValueType UCesiumMetadataValueBlueprintLibrary::GetValueType ( UPARAM(ref) const FCesiumMetadataValue & Value )

static

Gets the type of the metadata value as defined in the EXT_structural_metadata extension.

Many of these types are not accessible from Blueprints, but can be converted to a Blueprint-accessible type.

◆ GetVector()

static FVector UCesiumMetadataValueBlueprintLibrary::GetVector	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		const FVector &	DefaultValue )

static

Attempts to retrieve the value as a FVector.

If the value is a 3-dimensional vector, its components will be converted to double-precision floating-point numbers.

If the value is a 4-dimensional vector, a FVector containing the first three components will be returned.

If the value is a 2-dimensional vector, it will become the XY-components of the FVector. The Z-component will be set to zero.

If the value is a scalar, then the resulting FVector will have this value as a double-precision floating-point number in all of its components.

If the value is a boolean, (1.0, 1.0, 1.0) is returned for true, while (0.0, 0.0, 0.0) is returned for false.

If the value is a string that can be parsed as a FVector, the parsed value is returned. The string must be formatted as "X=... Y=... Z=".

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a FVector.

Returns: The value as a FVector.

◆ GetVector2D()

static FVector2D UCesiumMetadataValueBlueprintLibrary::GetVector2D	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		const FVector2D &	DefaultValue )

static

Attempts to retrieve the value as a FVector2D.

If the value is a 2-dimensional vector, its components will be converted to double-precision floating-point numbers.

If the value is a 3- or 4-dimensional vector, it will use the first two components to construct the FVector2D.

If the value is a scalar, the resulting FVector2D will have this value in both of its components.

If the value is a boolean, (1.0, 1.0) is returned for true, while (0.0, 0.0) is returned for false.

If the value is a string that can be parsed as a FVector2D, the parsed value is returned. The string must be formatted as "X=... Y=...".

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a FIntPoint.

Returns: The value as a FIntPoint.

◆ GetVector3f()

static FVector3f UCesiumMetadataValueBlueprintLibrary::GetVector3f	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		const FVector3f &	DefaultValue )

static

Attempts to retrieve the value as a FVector3f.

If the value is a 3-dimensional vector, its components will be converted to the closest representable single-precision floats, if possible.

If the value is a 4-dimensional vector, a FVector3f containing the first three components will be returned.

If the value is a 2-dimensional vector, it will become the XY-components of the FVector3f. The Z-component will be set to zero.

If the value is a scalar that can be converted to a single-precision floating-point number, then the resulting FVector3f will have this value in all of its components.

If the value is a boolean, (1.0f, 1.0f, 1.0f) is returned for true, while (0.0f, 0.0f, 0.0f) is returned for false.

If the value is a string that can be parsed as a FVector3f, the parsed value is returned. The string must be formatted as "X=... Y=... Z=".

In all other cases, the default value is returned. In all vector cases, if any of the relevant components cannot be represented as a single-precision float, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a FVector3f.

Returns: The value as a FVector3f.

◆ GetVector4()

static FVector4 UCesiumMetadataValueBlueprintLibrary::GetVector4	(	UPARAM(ref) const FCesiumMetadataValue &	Value,
		const FVector4 &	DefaultValue )

static

Attempts to retrieve the value as a FVector4.

If the value is a 4-dimensional vector, its components will be converted to double-precision floating-point numbers.

If the value is a 3-dimensional vector, it will become the XYZ-components of the FVector4. The W-component will be set to zero.

If the value is a 2-dimensional vector, it will become the XY-components of the FVector4. The Z- and W-components will be set to zero.

If the value is a scalar, then the resulting FVector4 will have this value as a double-precision floating-point number in all of its components.

If the value is a boolean, (1.0, 1.0, 1.0, 1.0) is returned for true, while (0.0, 0.0, 0.0, 0.0) is returned for false.

If the value is a string that can be parsed as a FVector4, the parsed value is returned. This follows the rules of FVector4::InitFromString. The string must be formatted as "X=... Y=... Z=... W=...". The W-component is optional; if absent, it will be set to 1.0.

In all other cases, the default value is returned.

Parameters

Value	The metadata value to retrieve.
DefaultValue	The default value to use if the given value cannot be converted to a FVector4.

Returns: The value as a FVector4.

◆ IsEmpty()

static bool UCesiumMetadataValueBlueprintLibrary::IsEmpty ( UPARAM(ref) const FCesiumMetadataValue & Value )

static

Whether the value is empty, i.e., whether it does not actually represent any data.

An empty value functions as a null value, and can be compared to a std::nullopt in C++. For example, when the raw value of a property matches the property's specified "no data" value, it will return an empty FCesiumMetadataValue.

Parameters

Value The metadata value to retrieve.

Returns: Whether the value is empty.

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

Source/CesiumRuntime/Public/CesiumMetadataValue.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetArray()

◆ GetArrayElementBlueprintType()

◆ GetBlueprintType()

◆ GetBoolean()

◆ GetByte()

◆ GetFloat()

◆ GetFloat64()

◆ GetInteger()

◆ GetInteger64()

◆ GetIntPoint()

◆ GetIntVector()

◆ GetMatrix()

◆ GetString()

◆ GetTrueComponentType()

◆ GetTrueType()

◆ GetValuesAsStrings()

◆ GetValueType()

◆ GetVector()

◆ GetVector2D()

◆ GetVector3f()

◆ GetVector4()

◆ IsEmpty()