Cesium for Unreal 2.12.0
|
#include <CesiumPropertyTextureProperty.h>
Static Public Member Functions | |
static ECesiumPropertyTexturePropertyStatus | GetPropertyTexturePropertyStatus (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the status of the property texture property. | |
static ECesiumMetadataBlueprintType | GetBlueprintType (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the best-fitting type for the property that is accessible from Blueprints. | |
static ECesiumMetadataBlueprintType | GetArrayElementBlueprintType (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the best-fitting Blueprints type for the elements in this property's array values. | |
static FCesiumMetadataValueType | GetValueType (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the type of the metadata value as defined in the EXT_structural_metadata extension. | |
static int64 | GetArraySize (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the number of elements in an array of this property. | |
static int64 | GetGltfTextureCoordinateSetIndex (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the glTF texture coordinate set index used by the property texture property. | |
static int64 | GetUnrealUVChannel (const UPrimitiveComponent *Component, UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the UV channel containing the texture coordinate set that is used by the property texture property on the given component. | |
static TArray< int64 > | GetChannels (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Get the channels array of this property. | |
static uint8 | GetByte (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, uint8 DefaultValue=0) |
Attempts to retrieve the value at the given texture coordinates as an unsigned 8-bit integer. | |
static int32 | GetInteger (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, int32 DefaultValue=0) |
Attempts to retrieve the value at the given texture coordinates as a signed 32-bit integer. | |
static float | GetFloat (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, float DefaultValue=0.0f) |
Attempts to retrieve the value at the given texture coordinates as a single-precision floating-point number. | |
static double | GetFloat64 (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, double DefaultValue=0.0) |
Attempts to retrieve the value at the given texture coordinates as a double-precision floating-point number. | |
static FIntPoint | GetIntPoint (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, const FIntPoint &DefaultValue) |
Attempts to retrieve the value at the given texture coordinates as a FIntPoint. | |
static FVector2D | GetVector2D (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, const FVector2D &DefaultValue) |
Attempts to retrieve the value at the given texture coordinates as a FVector2D. | |
static FIntVector | GetIntVector (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, const FIntVector &DefaultValue) |
Attempts to retrieve the value at the given texture coordinates as a FIntVector. | |
static FVector | GetVector (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, const FVector &DefaultValue) |
Attempts to retrieve the value at the given texture coordinates as a FVector. | |
static FVector4 | GetVector4 (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV, const FVector4 &DefaultValue) |
Attempts to retrieve the value at the given texture coordinates as a FVector4. | |
static FCesiumPropertyArray | GetArray (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV) |
Attempts to retrieve the value for the given texture coordinates as a FCesiumPropertyArray. | |
static FCesiumMetadataValue | GetValue (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV) |
Retrieves the value of the property for the given texture coordinates. | |
static FCesiumMetadataValue | GetRawValue (UPARAM(ref) const FCesiumPropertyTextureProperty &Property, const FVector2D &UV) |
Retrieves the raw value of the property for the given feature. | |
static bool | IsNormalized (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Whether this property is normalized. | |
static FCesiumMetadataValue | GetOffset (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the offset of this property. | |
static FCesiumMetadataValue | GetScale (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the scale of this property. | |
static FCesiumMetadataValue | GetMinimumValue (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the minimum value of this property. | |
static FCesiumMetadataValue | GetMaximumValue (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the maximum value of this property. | |
static FCesiumMetadataValue | GetNoDataValue (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the "no data" value of this property, as defined by its class property. | |
static FCesiumMetadataValue | GetDefaultValue (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Gets the default value of this property, as defined by its class property. | |
static PRAGMA_DISABLE_DEPRECATION_WARNINGS FString | GetSwizzle (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Get the string representing how the metadata is encoded into a pixel color. | |
static int64 | GetComponentCount (UPARAM(ref) const FCesiumPropertyTextureProperty &Property) |
Get the component count of this property. | |
Definition at line 117 of file CesiumPropertyTextureProperty.h.
|
static |
Attempts to retrieve the value for the given texture coordinates as a FCesiumPropertyArray.
If the property is not an array type, this returns an empty array.
For numeric array properties, the raw array value for a given coordinates 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 | The property texture property. |
UV | The texture coordinates. |
|
static |
Gets the best-fitting Blueprints type for the elements in this property's array values.
If the given property does not contain array values, this returns None.
Property | The property texture property. |
|
static |
Gets the number of elements in an array of this property.
Only applicable when the property is a fixed-length array type.
Property | The property texture property. |
|
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 texture property. |
|
static |
Attempts to retrieve the value at the given texture coordinates as an unsigned 8-bit integer.
For numeric properties, the raw value for the given coordinates 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 property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
DefaultValue | The default value to fall back on. |
|
static |
Get the channels array of this property.
This contains the indices of the meaningful texel channels that will be used when sampling the property texture.
Property | The property texture property. |
|
static |
Get the component count of this property.
Since the metadata is encoded as pixel color, this is also the number of meaningful channels it will use.
Property | The property texture property. |
|
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 texture property. |
|
static |
Attempts to retrieve the value at the given texture coordinates as a single-precision floating-point number.
For numeric properties, the raw value for the given coordinates 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 property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value at the given texture coordinates as a double-precision floating-point number.
For numeric properties, the raw value for the given coordinates 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 property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
DefaultValue | The default value to fall back on. |
|
static |
Gets the glTF texture coordinate set index used by the property texture property.
This is the index N corresponding to the "TEXCOORD_N" attribute on the glTF primitive that samples this texture.
If the property texture property is invalid, this returns -1.
Property | The property texture property. |
|
static |
Attempts to retrieve the value at the given texture coordinates as a signed 32-bit integer.
For numeric properties, the raw value for the given coordinates 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 property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value at the given texture coordinates as a FIntPoint.
For numeric properties, the raw value for the given coordinates 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 property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value at the given texture coordinates as a FIntVector.
For numeric properties, the raw value for the given coordinates 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 property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
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 texture 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 texture 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.
This is not applicable to boolean properties. If a "no data" value is not defined or applicable, this returns an empty value.
Property | The property texture 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 texture property. |
|
static |
Gets the status of the property texture property.
If this property texture property is invalid in any way, this will briefly indicate why.
Property | The property texture property. |
|
static |
Retrieves the raw value of the property for the given feature.
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.
Property | The property texture property. |
UV | The texture coordinates. |
|
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 texture property. |
|
static |
Get the string representing how the metadata is encoded into a pixel color.
This is useful to unpack the correct order of the metadata components from the pixel color.
Property | The property texture property. |
|
static |
Gets the UV channel containing the texture coordinate set that is used by the property texture property on the given component.
This refers to the UV channel it uses on the primitive's static mesh, which is not necessarily equal to value of GetGltfTextureCoordinateSetIndex.
This function may be used with FindCollisionUV to get the feature ID from a line trace hit. However, in order for this function to work, the feature ID texture should be listed under the CesiumFeaturesMetadataComponent of the owner Cesium3DTileset. Otherwise, its texture coordinate set may not be included in the Unreal mesh data. To avoid using CesiumFeaturesMetadataComponent, use GetFeatureIDFromHit instead.
This returns -1 if the property texture property is invalid, or if the specified texture coordinate set is not present in the component's mesh data.
Component | The component to get the texture coordinate set from. |
Property | The property texture property. |
|
static |
Retrieves the value of the property for the given texture coordinates.
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 for a given feature 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 texture property. |
UV | The texture coordinates. |
|
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 texture property. |
|
static |
Attempts to retrieve the value at the given texture coordinates as a FVector.
For numeric properties, the raw value for the given coordinates 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 single-precision float, the default value is returned.
If the property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value at the given texture coordinates as a FVector2D.
For numeric properties, the raw value for the given coordinates 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 property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
DefaultValue | The default value to fall back on. |
|
static |
Attempts to retrieve the value at the given texture coordinates as a FVector4.
For numeric properties, the raw value for the given coordinates 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 property texture property is somehow invalid, the user-defined default value is returned.
Property | The property texture property. |
UV | The texture coordinates. |
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 texture property. |