cesium-native  0.41.0
CesiumGltf::Enum Struct Referencefinal

An object defining the values of an enum. More...

#include <CesiumGltf/Enum.h>

Inheritance diagram for CesiumGltf::Enum:
CesiumUtility::ExtensibleObject

Classes

struct  ValueType
 Known values for The type of the integer enum value. More...
 

Public Attributes

std::optional< std::string > name
 The name of the enum, e.g. for display purposes.
 
std::optional< std::string > description
 The description of the enum.
 
std::string valueType = ValueType::UINT16
 The type of the integer enum value. More...
 
std::vector< CesiumGltf::EnumValuevalues
 An array of enum values. Duplicate names or duplicate integer values are not allowed.
 
- 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 = "Enum"
 

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 JsonValuegetGenericExtension (const std::string &extensionName) const noexcept
 Gets a generic extension with the given name as a CesiumUtility::JsonValue. More...
 
JsonValuegetGenericExtension (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 object defining the values of an enum.

Definition at line 18 of file Enum.h.

Member Data Documentation

◆ valueType

std::string CesiumGltf::Enum::valueType = ValueType::UINT16

The type of the integer enum value.

Known values are defined in ValueType.

Definition at line 58 of file Enum.h.


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