![]() |
Cesium for Unreal 2.18.0
|
#include <CesiumPropertyAttributeProperty.h>
Static Public Member Functions | |
static ECesiumPropertyAttributePropertyStatus | GetPropertyAttributePropertyStatus (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the status of the property attribute property. | |
static ECesiumMetadataBlueprintType | GetBlueprintType (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the best-fitting type for the property that is accessible from Blueprints. | |
static FCesiumMetadataValueType | GetValueType (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the type of the metadata value as defined in the EXT_structural_metadata extension. | |
static int64 | GetPropertySize (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the number of values in the property. | |
static uint8 | GetByte (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, uint8 DefaultValue=0) |
Attempts to retrieve the value at the given index as an unsigned 8-bit integer. | |
static int32 | GetInteger (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, int32 DefaultValue=0) |
Attempts to retrieve the value for the given index as a signed 32-bit integer. | |
static int64 | GetInteger64 (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, int64 DefaultValue=0) |
Attempts to retrieve the value for the given index as a signed 64-bit integer. | |
static float | GetFloat (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, float DefaultValue=0.0f) |
Attempts to retrieve the value for the given index as a single-precision floating-point number. | |
static double | GetFloat64 (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, double DefaultValue=0.0) |
Attempts to retrieve the value for the given index as a double-precision floating-point number. | |
static FIntPoint | GetIntPoint (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, const FIntPoint &DefaultValue) |
Attempts to retrieve the value for the given index as a FIntPoint. | |
static FVector2D | GetVector2D (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, const FVector2D &DefaultValue) |
Attempts to retrieve the value for the given index as a FVector2D. | |
static FIntVector | GetIntVector (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, const FIntVector &DefaultValue) |
Attempts to retrieve the value for the given index as a FIntVector. | |
static FVector3f | GetVector3f (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, const FVector3f &DefaultValue) |
Attempts to retrieve the value for the given index as a FVector3f. | |
static FVector | GetVector (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, const FVector &DefaultValue) |
Attempts to retrieve the value for the given index as a FVector. | |
static FVector4 | GetVector4 (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, const FVector4 &DefaultValue) |
Attempts to retrieve the value for the given index as a FVector4. | |
static FMatrix | GetMatrix (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index, const FMatrix &DefaultValue) |
Attempts to retrieve the value for the given index as a FMatrix. | |
static FCesiumMetadataValue | GetValue (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index) |
Retrieves the value of the property for the given index. | |
static FCesiumMetadataValue | GetRawValue (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property, int64 Index) |
Retrieves the raw value of the property for the given index. | |
static bool | IsNormalized (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Whether this property is normalized. | |
static FCesiumMetadataValue | GetOffset (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the offset of this property. | |
static FCesiumMetadataValue | GetScale (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the scale of this property. | |
static FCesiumMetadataValue | GetMinimumValue (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the minimum value of this property. | |
static FCesiumMetadataValue | GetMaximumValue (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the maximum value of this property. | |
static FCesiumMetadataValue | GetNoDataValue (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the "no data" value of this property, as defined by its class property. | |
static FCesiumMetadataValue | GetDefaultValue (UPARAM(ref) const FCesiumPropertyAttributeProperty &Property) |
Gets the default value of this property, as defined by its class property. | |
Definition at line 139 of file CesiumPropertyAttributeProperty.h.
|
static |
Gets the best-fitting type for the property that is accessible from Blueprints.
For the most precise representation of the values possible in Blueprints, you should retrieve it using this type.
Property | The property attribute property. |
|
static |
Attempts to retrieve the value at the given index as an unsigned 8-bit integer.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
If the value is an integer between 0 and 255, it is returned as-is. Otherwise, if the value is a floating-point number in the aforementioned range, it is truncated (rounded toward zero) and returned.
In all other cases, the user-defined default value is returned. If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Gets the default value of this property, as defined by its class property.
This default value is used use when encountering a "no data" value in the property.
If a default value is not defined, this returns an empty value.
Property | The property attribute property. |
|
static |
Attempts to retrieve the value for the given index as a single-precision floating-point number.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
If the value is already a single-precision floating-point number, it is returned as-is. Otherwise, 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.
In all other cases, the user-defined default value is returned. If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a double-precision floating-point number.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
If the value is a single-precision floating-point number, it is returned as-is. Otherwise, if the value is an integer, it is converted to the closest representation as a double-precision floating-point number.
In all other cases, the user-defined default value is returned. If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a signed 32-bit integer.
Although property attribute properties do not directly support 32-bit signed integers, this can be used to losslessly retrieve values from smaller integer properties.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
If the value is an integer between -2,147,483,648 and 2,147,483,647, it is returned as-is. Otherwise, if the value is a floating-point number in the aforementioned range, it is truncated (rounded toward zero) and returned.
In all other cases, the user-defined default value is returned. If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a signed 64-bit integer.
Although property attribute properties do not directly support 64-bit integers, this can be used to losslessly retrieve values from unsigned 32-bit integer properties.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
If the value is an integer and between -2^63 and (2^63 - 1), it is returned as-is. Otherwise, if the value is a floating-point number in the aforementioned range, it is truncated (rounded toward zero) and returned.
In all other cases, the user-defined default value is returned. If the index ID is out-of-range, or if the property table property is somehow invalid, the user-defined default value is returned.
Property | The property table property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a FIntPoint.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
Property values are converted as follows:
In all other cases, the user-defined 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.
If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a FIntVector.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
Property values are converted as follows:
In all other cases, the user-defined 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.
If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a FMatrix.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
Property values are converted as follows:
In all other cases, the user-defined default value is returned. If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Gets the maximum value of this property.
This can be defined by the class property that it implements, or overridden by the instance of the property itself.
This is only applicable to scalar, vecN and matN properties. It represents the component-wise maximum of all property values with normalization, offset, and scale applied. If a maximum value is not defined or applicable, this returns an empty value.
Property | The property attribute property. |
|
static |
Gets the minimum value of this property.
This can be defined by the class property that it implements, or overridden by the instance of the property itself.
This is only applicable to scalar, vecN and matN properties. It represents the component-wise minimum of all property values with normalization, offset, and scale applied. If a minimum value is not defined or applicable, this returns an empty value.
Property | The property attribute property. |
|
static |
Gets the "no data" value of this property, as defined by its class property.
This value functions a sentinel value, indicating missing data wherever it appears. The value is compared against the property's raw data, without normalization, offset, or scale applied.
If a "no data" value is not defined or applicable, this returns an empty value.
Property | The property attribute property. |
|
static |
Gets the offset of this property.
This can be defined by the class property that it implements, or overridden by the instance of the property itself.
This is only applicable to properties with floating-point or normalized integer component types. If an offset is not defined or applicable, this returns an empty value.
Property | The property attribute property. |
|
static |
Gets the status of the property attribute property.
If this property attribute property is invalid in any way, this will briefly indicate why.
Property | The property attribute property. |
|
static |
Gets the number of values in the property.
Property | The property attribute property. |
|
static |
Retrieves the raw value of the property for the given index.
This is the value of the property without normalization, offset, or scale applied.
If this property specifies a "no data" value, and the raw value is equal to this "no data" value, the value is returned as-is.
If this property is an empty property with a specified default value, it will not have any raw data to retrieve. The returned value will be empty.
Property | The property attribute property. |
Index | The index. |
|
static |
Gets the scale of this property.
This can be defined by the class property that it implements, or overridden by the instance of the property itself.
This is only applicable to properties with floating-point or normalized integer component types. If a scale is not defined or applicable, this returns an empty value.
Property | The property attribute property. |
|
static |
Retrieves the value of the property for the given index.
This allows the value to be acted on more generically; its true value can be retrieved later as a specific Blueprints type.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is returned. If the raw value is equal to the property's "no data" value, an empty value will be returned. However, if the property itself specifies a default value, then the property-defined default value will be returned.
Property | The property attribute property. |
Index | The index. |
|
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.
Property | The property attribute property. |
|
static |
Attempts to retrieve the value for the given index as a FVector.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
Property values are converted as follows:
In all other cases, the user-defined default value is returned. If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a FVector2D.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
Property values are converted as follows:
In all other cases, the user-defined default value is returned. If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a FVector3f.
For numeric properties, the raw value transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
Property values are converted as follows:
In all other cases, the user-defined default value is returned. In all vector cases, if any of the relevant components cannot be represented as a single-precision float, the user-defined default value is returned.
If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value for the given index as a FVector4.
For numeric properties, the raw value will be transformed by the property's normalization, scale, and offset before it is further converted. If the raw value is equal to the property's "no data" value, then the property's default value will be converted if possible. If the property-defined default value cannot be converted, or does not exist, then the user-defined default value is returned.
Property values are converted as follows:
In all other cases, the user-defined default value is returned. If the index is out-of-range, or if the property attribute property is somehow invalid, the user-defined default value is returned.
Property | The property attribute property. |
Index | The index. |
DefaultValue | The default value to fall back on. |
|
static |
Whether this property is normalized.
Only applicable when this property has an integer component type.
Property | The property attribute property. |