cesium-native 0.43.0
Loading...
Searching...
No Matches
Cesium3DTiles::Class Struct Referencefinal

A class containing a set of properties. More...

#include <Cesium3DTiles/Class.h>

Inheritance diagram for Cesium3DTiles::Class:
CesiumUtility::ExtensibleObject

Public Member Functions

int64_t getSizeBytes () const
 Calculates the size in bytes of this object, including the contents of all collections, pointers, and strings. This will NOT include the size of any extensions attached to the object. Calling this method may be slow as it requires traversing the object's entire structure.
 
- Public Member Functions inherited from CesiumUtility::ExtensibleObject
template<typename T >
bool hasExtension () const noexcept
 Checks if an extension exists given its static type.
 
template<typename T >
const T * getExtension () const noexcept
 Gets an extension given its static type.
 
template<typename T >
T * getExtension () noexcept
 Gets an extension given its static type.
 
const JsonValuegetGenericExtension (const std::string &extensionName) const noexcept
 Gets a generic extension with the given name as a CesiumUtility::JsonValue.
 
JsonValuegetGenericExtension (const std::string &extensionName) noexcept
 Gets a generic extension with the given name as a CesiumUtility::JsonValue.
 
template<typename T , typename... ConstructorArgumentTypes>
T & addExtension (ConstructorArgumentTypes &&... constructorArguments)
 Adds a statically-typed extension to this object.
 
template<typename T >
void removeExtension ()
 Removes a statically-typed extension from this object.
 
int64_t getSizeBytes () const
 Calculates the size in bytes of this ExtensibleObject, including all of its extras but NOT including its extensions. Calling this method may be slow as it requires traversing the entire object.
 

Public Attributes

std::optional< std::string > name
 The name of the class, e.g. for display purposes.
 
std::optional< std::string > description
 The description of the class.
 
std::unordered_map< std::string, Cesium3DTiles::ClassPropertyproperties
 A dictionary, where each key is a property ID and each value is an object defining the property. Property IDs shall be alphanumeric identifiers matching the regular expression ^[a-zA-Z_][a-zA-Z0-9_]*$.
 
- Public Attributes inherited from CesiumUtility::ExtensibleObject
std::unordered_map< std::string, std::any > extensions
 The extensions attached to this object.
 
JsonValue::Object extras
 Application-specific data.
 
JsonValue::Object unknownProperties
 Unknown properties that exist on this object but do not have any representation in the statically-typed classes.
 

Static Public Attributes

static constexpr const char * TypeName = "Class"
 The original name of this type.
 

Detailed Description

A class containing a set of properties.

Definition at line 17 of file Class.h.

Member Function Documentation

◆ getSizeBytes()

int64_t Cesium3DTiles::Class::getSizeBytes ( ) const
inline

Calculates the size in bytes of this object, including the contents of all collections, pointers, and strings. This will NOT include the size of any extensions attached to the object. Calling this method may be slow as it requires traversing the object's entire structure.

Definition at line 46 of file Class.h.

Member Data Documentation

◆ description

std::optional<std::string> Cesium3DTiles::Class::description

The description of the class.

Definition at line 31 of file Class.h.

◆ name

std::optional<std::string> Cesium3DTiles::Class::name

The name of the class, e.g. for display purposes.

Definition at line 26 of file Class.h.

◆ properties

std::unordered_map<std::string, Cesium3DTiles::ClassProperty> Cesium3DTiles::Class::properties

A dictionary, where each key is a property ID and each value is an object defining the property. Property IDs shall be alphanumeric identifiers matching the regular expression ^[a-zA-Z_][a-zA-Z0-9_]*$.

Definition at line 38 of file Class.h.

◆ TypeName

const char* Cesium3DTiles::Class::TypeName = "Class"
staticconstexpr

The original name of this type.

Definition at line 21 of file Class.h.


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