Metadata about the glTF asset. More...

#include <CesiumGltf/Asset.h>

Inheritance diagram for CesiumGltf::Asset:

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 >	copyright
	A copyright message suitable for display to credit the content creator.

std::optional< std::string >	generator
	Tool that generated this glTF model. Useful for debugging.

int32_t	thumbnail = -1
	The index of the image in the `images` array to use as a thumbnail for this asset. The image SHOULD be a common, widely-supported format, but MAY have any media type.

std::string	version
	The glTF version in the form of `<major>.<minor>` that this asset targets.

std::optional< std::string >	minVersion
	The minimum glTF version in the form of `<major>.<minor>` that this asset targets. This property MUST NOT be greater than the asset version.

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

Detailed Description

Metadata about the glTF asset.

Definition at line 16 of file Asset.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::Asset::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 59 of file Asset.h.

Member Data Documentation

◆ copyright

std::optional<std::string> CesiumGltf::Asset::copyright

A copyright message suitable for display to credit the content creator.

Definition at line 26 of file Asset.h.

◆ generator

std::optional<std::string> CesiumGltf::Asset::generator

Tool that generated this glTF model. Useful for debugging.

Definition at line 31 of file Asset.h.

◆ minVersion

std::optional<std::string> CesiumGltf::Asset::minVersion

The minimum glTF version in the form of <major>.<minor> that this asset targets. This property MUST NOT be greater than the asset version.

Definition at line 51 of file Asset.h.

◆ thumbnail

int32_t CesiumGltf::Asset::thumbnail = -1

The index of the image in the images array to use as a thumbnail for this asset. The image SHOULD be a common, widely-supported format, but MAY have any media type.

Definition at line 38 of file Asset.h.

◆ TypeName

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

staticconstexpr

The original name of this type.

Definition at line 20 of file Asset.h.

◆ version

std::string CesiumGltf::Asset::version

The glTF version in the form of <major>.<minor> that this asset targets.

Definition at line 44 of file Asset.h.

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

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

Public Member Functions

Public Attributes

Static Public Attributes