CesiumGltf::PropertyTableProperty Struct Referencefinal
An array of binary property values. More...
#include <CesiumGltf/PropertyTableProperty.h>
Inheritance diagram for CesiumGltf::PropertyTableProperty:
Classes | |
| struct | ArrayOffsetType |
Known values for The type of values in arrayOffsets. More... | |
| struct | StringOffsetType |
Known values for The type of values in stringOffsets. More... | |
Public Attributes | |
| int32_t | values = -1 |
The index of the buffer view containing property values. The data type of property values is determined by the property definition: When type is BOOLEAN values are packed into a bitstream. When type is STRING values are stored as byte sequences and decoded as UTF-8 strings. When type is SCALAR, VECN, or MATN the values are stored as the provided componentType and the buffer view byteOffset must be aligned to a multiple of the componentType size. When type is ENUM values are stored as the enum's valueType and the buffer view byteOffset must be aligned to a multiple of the valueType size. Each enum value in the array must match one of the allowed values in the enum definition. arrayOffsets is required for variable-length arrays and stringOffsets is required for strings (for variable-length arrays of strings, both are required). | |
| int32_t | arrayOffsets = -1 |
The index of the buffer view containing offsets for variable-length arrays. The number of offsets is equal to the property table count plus one. The offsets represent the start positions of each array, with the last offset representing the position after the last array. The array length is computed using the difference between the subsequent offset and the current offset. If type is STRING the offsets index into the string offsets array (stored in stringOffsets), otherwise they index into the property array (stored in values). The data type of these offsets is determined by arrayOffsetType. The buffer view byteOffset must be aligned to a multiple of the arrayOffsetType size. | |
| int32_t | stringOffsets = -1 |
The index of the buffer view containing offsets for strings. The number of offsets is equal to the number of string elements plus one. The offsets represent the byte offsets of each string in the property array (stored in values), with the last offset representing the byte offset after the last string. The string byte length is computed using the difference between the subsequent offset and the current offset. The data type of these offsets is determined by stringOffsetType. The buffer view byteOffset must be aligned to a multiple of the stringOffsetType size. | |
| std::string | arrayOffsetType = ArrayOffsetType::UINT32 |
The type of values in arrayOffsets. More... | |
| std::string | stringOffsetType = StringOffsetType::UINT32 |
The type of values in stringOffsets. More... | |
| std::optional< CesiumUtility::JsonValue > | offset |
An offset to apply to property values. Only applicable when the component type is FLOAT32 or FLOAT64, or when the property is normalized. Overrides the class property's offset if both are defined. | |
| std::optional< CesiumUtility::JsonValue > | scale |
A scale to apply to property values. Only applicable when the component type is FLOAT32 or FLOAT64, or when the property is normalized. Overrides the class property's scale if both are defined. | |
| std::optional< CesiumUtility::JsonValue > | max |
Maximum value present in the property values. Only applicable to SCALAR, VECN, and MATN types. This is the maximum of all property values, after the transforms based on the normalized, offset, and scale properties have been applied. | |
| std::optional< CesiumUtility::JsonValue > | min |
Minimum value present in the property values. Only applicable to SCALAR, VECN, and MATN types. This is the minimum of all property values, after the transforms based on the normalized, offset, and scale properties have been applied. | |
 Public Attributes inherited from CesiumUtility::ExtensibleObject | |
| std::unordered_map< std::string, std::any > | extensions |
| The extensions attached to this object. More... | |
| JsonValue::Object | extras |
| Application-specific data. More... | |
| JsonValue::Object | unknownProperties |
| Unknown properties that exist on this object but do not have any representation in the statically-typed classes. More... | |
Static Public Attributes | |
| static constexpr const char * | TypeName = "PropertyTableProperty" |
Additional Inherited Members | |
| Public Member Functions inherited from CesiumUtility::ExtensibleObject | |
| template<typename T > | |
| bool | hasExtension () const noexcept |
| Checks if an extension exists given its static type. More... | |
| template<typename T > | |
| const T * | getExtension () const noexcept |
| Gets an extension given its static type. More... | |
| template<typename T > | |
| T * | getExtension () noexcept |
| Gets an extension given its static type. More... | |
| const JsonValue * | getGenericExtension (const std::string &extensionName) const noexcept |
| Gets a generic extension with the given name as a CesiumUtility::JsonValue. More... | |
| JsonValue * | getGenericExtension (const std::string &extensionName) noexcept |
| Gets a generic extension with the given name as a CesiumUtility::JsonValue. More... | |
| template<typename T , typename... ConstructorArgumentTypes> | |
| T & | addExtension (ConstructorArgumentTypes &&... constructorArguments) |
| Adds a statically-typed extension to this object. More... | |
| template<typename T > | |
| void | removeExtension () |
| Removes a statically-typed extension from this object. More... | |
Detailed Description
An array of binary property values.
Definition at line 18 of file PropertyTableProperty.h.
Member Data Documentation
◆ arrayOffsetType
| std::string CesiumGltf::PropertyTableProperty::arrayOffsetType = ArrayOffsetType::UINT32 |
The type of values in arrayOffsets.
Known values are defined in ArrayOffsetType.
Definition at line 96 of file PropertyTableProperty.h.
◆ stringOffsetType
| std::string CesiumGltf::PropertyTableProperty::stringOffsetType = StringOffsetType::UINT32 |
The type of values in stringOffsets.
Known values are defined in StringOffsetType.
Definition at line 104 of file PropertyTableProperty.h.
The documentation for this struct was generated from the following file:
- /home/runner/work/cesium-native/cesium-native/CesiumGltf/generated/include/CesiumGltf/PropertyTableProperty.h
