Properties conforming to a class, organized as property values stored in attributes. More...

#include <CesiumGltf/PropertyAttribute.h>

Inheritance diagram for CesiumGltf::PropertyAttribute:

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 JsonValue *	getGenericExtension (const std::string &extensionName) const noexcept
	Gets a generic extension with the given name as a `CesiumUtility::JsonValue`.

JsonValue *	getGenericExtension (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 property attribute, e.g. for display purposes.

std::string	classProperty
	The class that property values conform to. The value must be a class ID declared in the `classes` dictionary.

std::unordered_map< std::string, CesiumGltf::PropertyAttributeProperty >	properties
	A dictionary, where each key corresponds to a property ID in the class' `properties` dictionary and each value is an object describing where property values are stored. Required properties must be included in this dictionary.

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 = "PropertyAttribute"
	The original name of this type.

Detailed Description

Properties conforming to a class, organized as property values stored in attributes.

Definition at line 18 of file PropertyAttribute.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::PropertyAttribute::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 51 of file PropertyAttribute.h.

Member Data Documentation

◆ classProperty

std::string CesiumGltf::PropertyAttribute::classProperty

The class that property values conform to. The value must be a class ID declared in the classes dictionary.

Definition at line 34 of file PropertyAttribute.h.

◆ name

std::optional<std::string> CesiumGltf::PropertyAttribute::name

The name of the property attribute, e.g. for display purposes.

Definition at line 28 of file PropertyAttribute.h.

◆ properties

std::unordered_map<std::string, CesiumGltf::PropertyAttributeProperty> CesiumGltf::PropertyAttribute::properties

A dictionary, where each key corresponds to a property ID in the class' properties dictionary and each value is an object describing where property values are stored. Required properties must be included in this dictionary.

Definition at line 43 of file PropertyAttribute.h.

◆ TypeName

const char* CesiumGltf::PropertyAttribute::TypeName = "PropertyAttribute"

staticconstexpr

The original name of this type.

Definition at line 23 of file PropertyAttribute.h.

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

/home/runner/work/cesium-native/cesium-native/CesiumGltf/generated/include/CesiumGltf/PropertyAttribute.h

Public Member Functions

Public Attributes

Static Public Attributes