Blueprint library functions for acting on an array property in EXT_structural_metadata. More...

#include <CesiumPropertyArrayBlueprintLibrary.h>

Inheritance diagram for UCesiumPropertyArrayBlueprintLibrary:

Static Public Member Functions
static ECesiumMetadataBlueprintType	GetElementBlueprintType (UPARAM(ref) const FCesiumPropertyArray &array)
	Gets the best-fitting Blueprints type for the elements of this array.

static FCesiumMetadataValueType	GetElementValueType (UPARAM(ref) const FCesiumPropertyArray &array)
	Gets the true value type of the elements in the array.

static int64	GetArraySize (UPARAM(ref) const FCesiumPropertyArray &Array)
	Gets the number of elements in the array.

static FCesiumMetadataValue	GetValue (UPARAM(ref) const FCesiumPropertyArray &Array, int64 Index)
	Retrieves an element from the array as a FCesiumMetadataValue.

static PRAGMA_DISABLE_DEPRECATION_WARNINGS ECesiumMetadataBlueprintType	GetBlueprintComponentType (UPARAM(ref) const FCesiumPropertyArray &array)
	Gets the best-fitting Blueprints type for the elements of this array.

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

static int64	GetSize (UPARAM(ref) const FCesiumPropertyArray &Array)
	Gets the number of elements in the array.

static bool	GetBoolean (UPARAM(ref) const FCesiumPropertyArray &Array, int64 Index, bool DefaultValue=false)
	Retrieves an element from the array and attempts to convert it to a Boolean value.

static uint8	GetByte (UPARAM(ref) const FCesiumPropertyArray &Array, int64 Index, uint8 DefaultValue=0)
	Retrieves an element from the array and attempts to convert it to an unsigned 8-bit integer value.

static int32	GetInteger (UPARAM(ref) const FCesiumPropertyArray &Array, int64 Index, int32 DefaultValue=0)
	Retrieves an element from the array and attempts to convert it to a signed 32-bit integer value.

static int64	GetInteger64 (UPARAM(ref) const FCesiumPropertyArray &Array, int64 Index, int64 DefaultValue=0)
	This function is deprecated.

static float	GetFloat (UPARAM(ref) const FCesiumPropertyArray &array, int64 index, float DefaultValue=0.0f)
	Retrieves an element from the array and attempts to convert it to a 32-bit floating-point value.

static double	GetFloat64 (UPARAM(ref) const FCesiumPropertyArray &array, int64 index, double DefaultValue)
	Retrieves an element from the array and attempts to convert it to a 64-bit floating-point value.

static FString	GetString (UPARAM(ref) const FCesiumPropertyArray &Array, int64 Index, const FString &DefaultValue="")
	Retrieves an element from the array and attempts to convert it to a string value.

Detailed Description

Blueprint library functions for acting on an array property in EXT_structural_metadata.

Definition at line 14 of file CesiumPropertyArrayBlueprintLibrary.h.

Member Function Documentation

◆ GetArraySize()

static int64 UCesiumPropertyArrayBlueprintLibrary::GetArraySize ( UPARAM(ref) const FCesiumPropertyArray & Array )

static

Gets the number of elements in the array.

Returns 0 if the elements have an unknown type.

Parameters

Array The array.

Returns: The number of elements in the array.

◆ GetBlueprintComponentType()

static PRAGMA_DISABLE_DEPRECATION_WARNINGS ECesiumMetadataBlueprintType UCesiumPropertyArrayBlueprintLibrary::GetBlueprintComponentType ( UPARAM(ref) const FCesiumPropertyArray & array )

static

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

Parameters

array The array.

◆ GetBoolean()

static bool UCesiumPropertyArrayBlueprintLibrary::GetBoolean	(	UPARAM(ref) const FCesiumPropertyArray &	Array,
		int64	Index,
		bool	DefaultValue = false )

static

Retrieves an element from the array and attempts to convert it to a Boolean value.

If the element is boolean, it is returned directly.

If the element is numeric, zero is converted to false, while any other value is converted to true.

If the element 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.

Other types of elements will return the default value.

Parameters

Array	The array.
Index	The index of the array element to retrieve.
DefaultValue	The default value to use if the index is invalid or the element's value cannot be converted.

Returns: The element value.

◆ GetByte()

static uint8 UCesiumPropertyArrayBlueprintLibrary::GetByte	(	UPARAM(ref) const FCesiumPropertyArray &	Array,
		int64	Index,
		uint8	DefaultValue = 0 )

static

Retrieves an element from the array and attempts to convert it to an unsigned 8-bit integer value.

If the element is an integer and between 0 and 255, it is returned directly.

If the element is a floating-point number, it is truncated (rounded toward zero).

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

If the element 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 use of a comma or other character to group digits.

Otherwise, the default value is returned.

Parameters

Array	The array.
Index	The index of the array element to retrieve.
DefaultValue	The default value to use if the index is invalid or the element's value cannot be converted.

Returns: The element value.

◆ GetElementBlueprintType()

static ECesiumMetadataBlueprintType UCesiumPropertyArrayBlueprintLibrary::GetElementBlueprintType ( UPARAM(ref) const FCesiumPropertyArray & array )

static

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

Parameters

array The array.

◆ GetElementValueType()

static FCesiumMetadataValueType UCesiumPropertyArrayBlueprintLibrary::GetElementValueType ( UPARAM(ref) const FCesiumPropertyArray & array )

static

Gets the true value type of the elements in the array.

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

Parameters

array The array.

◆ GetFloat()

static float UCesiumPropertyArrayBlueprintLibrary::GetFloat	(	UPARAM(ref) const FCesiumPropertyArray &	array,
		int64	index,
		float	DefaultValue = 0.0f )

static

Retrieves an element from the array and attempts to convert it to a 32-bit floating-point value.

If the element is a single-precision floating-point number, is is returned.

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

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

If the element 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 use of a comma or other character to group digits.

Otherwise, the default value is returned.

Parameters

array	The array.
index	The index of the array element to retrieve.
DefaultValue	The default value to use if the index is invalid or the element's value cannot be converted.

Returns: The element value.

◆ GetFloat64()

static double UCesiumPropertyArrayBlueprintLibrary::GetFloat64	(	UPARAM(ref) const FCesiumPropertyArray &	array,
		int64	index,
		double	DefaultValue )

static

Retrieves an element from the array and attempts to convert it to a 64-bit floating-point value.

If the element is a single- or double-precision floating-point number, is is returned.

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

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

If the element 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 use of a comma or other character to group digits.

Otherwise, the default value is returned.

Parameters

array	The array.
index	The index of the array element to retrieve.
DefaultValue	The default value to use if the index is invalid or the element's value cannot be converted.

Returns: The element value.

◆ GetInteger()

static int32 UCesiumPropertyArrayBlueprintLibrary::GetInteger	(	UPARAM(ref) const FCesiumPropertyArray &	Array,
		int64	Index,
		int32	DefaultValue = 0 )

static

Retrieves an element from the array and attempts to convert it to a signed 32-bit integer value.

If the element is an integer and between -2,147,483,647 and 2,147,483,647, it is returned directly.

If the element is a floating-point number, it is truncated (rounded toward zero).

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

If the element 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 use of a comma or other character to group digits.

Otherwise, the default value is returned.

Parameters

Array	The array.
Index	The index of the array element to retrieve.
DefaultValue	The default value to use if the index is invalid or the element's value cannot be converted.

Returns: The element value.

◆ GetInteger64()

static int64 UCesiumPropertyArrayBlueprintLibrary::GetInteger64	(	UPARAM(ref) const FCesiumPropertyArray &	Array,
		int64	Index,
		int64	DefaultValue = 0 )

static

This function is deprecated.

Use Cesium > Metadata > Property Array > GetValue instead.

Retrieves an element from the array and attempts to convert it to a signed 64-bit integer value.

If the element is an integer and between -2^63-1 and 2^63-1, it is returned directly.

If the element is a floating-point number, it is truncated (rounded toward zero).

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

If the element 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 use of a comma or other character to group digits.

Otherwise, the default value is returned.

Parameters

Array	The array.
Index	The index of the array element to retrieve.
DefaultValue	The default value to use if the index is invalid or the element's value cannot be converted.

Returns: The element value.

◆ GetSize()

static int64 UCesiumPropertyArrayBlueprintLibrary::GetSize ( UPARAM(ref) const FCesiumPropertyArray & Array )

static

Gets the number of elements in the array.

Returns 0 if the elements have an unknown type.

Parameters

Array The array.

Returns: The number of elements in the array.

◆ GetString()

static FString UCesiumPropertyArrayBlueprintLibrary::GetString	(	UPARAM(ref) const FCesiumPropertyArray &	Array,
		int64	Index,
		const FString &	DefaultValue = "" )

static

Retrieves an element from the array and attempts to convert it to a string value.

Numeric elements are converted to a string with FString::Format, which uses the current locale.

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

String elements are returned directly.

Parameters

Array	The array.
Index	The index of the array element to retrieve.
DefaultValue	The default value to use if the index is invalid or the element's value cannot be converted.

Returns: The element value.

◆ GetTrueComponentType()

static ECesiumMetadataTrueType_DEPRECATED UCesiumPropertyArrayBlueprintLibrary::GetTrueComponentType ( UPARAM(ref) const FCesiumPropertyArray & array )

static

Gets true type of the elements in the array.

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

Parameters

array The array.

◆ GetValue()

static FCesiumMetadataValue UCesiumPropertyArrayBlueprintLibrary::GetValue	(	UPARAM(ref) const FCesiumPropertyArray &	Array,
		int64	Index )

static

Retrieves an element from the array as a FCesiumMetadataValue.

The value can then be retrieved as a specific Blueprints type.

If the index is out-of-bounds, this returns a bogus FCesiumMetadataValue of an unknown type.

Parameters

Array	The array.
Index	The index of the array element to retrieve.

Returns: The element as a FCesiumMetadataValue.

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

Source/CesiumRuntime/Public/CesiumPropertyArrayBlueprintLibrary.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetArraySize()

◆ GetBlueprintComponentType()

◆ GetBoolean()

◆ GetByte()

◆ GetElementBlueprintType()

◆ GetElementValueType()

◆ GetFloat()

◆ GetFloat64()

◆ GetInteger()

◆ GetInteger64()

◆ GetSize()

◆ GetString()

◆ GetTrueComponentType()

◆ GetValue()