A 3D Tiles tileset. More...

#include <Cesium3DTiles/TilesetSpec.h>

Inheritance diagram for Cesium3DTiles::TilesetSpec:

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
Cesium3DTiles::Asset	asset
	Metadata about the entire tileset.

std::unordered_map< std::string, Cesium3DTiles::Properties >	properties
	A dictionary object of metadata about per-feature properties.

std::optional< Cesium3DTiles::Schema >	schema
	An object defining the structure of metadata classes and enums. When this is defined, then `schemaUri` shall be undefined.

std::optional< std::string >	schemaUri
	The URI (or IRI) of the external schema file. When this is defined, then `schema` shall be undefined.

std::optional< Cesium3DTiles::Statistics >	statistics
	An object containing statistics about metadata entities.

std::vector< Cesium3DTiles::GroupMetadata >	groups
	An array of groups that tile content may belong to. Each element of this array is a metadata entity that describes the group. The tile content `group` property is an index into this array.

std::optional< Cesium3DTiles::MetadataEntity >	metadata
	A metadata entity that is associated with this tileset.

double	geometricError = double()
	The error, in meters, introduced if this tileset is not rendered. At runtime, the geometric error is used to compute screen space error (SSE), i.e., the error measured in pixels.

Cesium3DTiles::Tile	root
	The root tile.

std::vector< std::string >	extensionsUsed
	Names of 3D Tiles extensions used somewhere in this tileset.

std::vector< std::string >	extensionsRequired
	Names of 3D Tiles extensions required to properly load this tileset. Each element of this array shall also be contained in `extensionsUsed`.

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

Protected Member Functions
	TilesetSpec ()=default
	This class is not meant to be instantiated directly. Use `Tileset` instead.

Friends
struct	Tileset

Detailed Description

A 3D Tiles tileset.

Definition at line 24 of file TilesetSpec.h.

Member Function Documentation

◆ getSizeBytes()

int64_t Cesium3DTiles::TilesetSpec::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 98 of file TilesetSpec.h.

Friends And Related Symbol Documentation

◆ Tileset

friend struct Tileset

friend

Definition at line 143 of file TilesetSpec.h.

Member Data Documentation

◆ asset

Cesium3DTiles::Asset Cesium3DTiles::TilesetSpec::asset

Metadata about the entire tileset.

Definition at line 33 of file TilesetSpec.h.

◆ extensionsRequired

std::vector<std::string> Cesium3DTiles::TilesetSpec::extensionsRequired

Names of 3D Tiles extensions required to properly load this tileset. Each element of this array shall also be contained in extensionsUsed.

Definition at line 90 of file TilesetSpec.h.

◆ extensionsUsed

std::vector<std::string> Cesium3DTiles::TilesetSpec::extensionsUsed

Names of 3D Tiles extensions used somewhere in this tileset.

Definition at line 84 of file TilesetSpec.h.

◆ geometricError

double Cesium3DTiles::TilesetSpec::geometricError = double()

The error, in meters, introduced if this tileset is not rendered. At runtime, the geometric error is used to compute screen space error (SSE), i.e., the error measured in pixels.

Definition at line 74 of file TilesetSpec.h.

◆ groups

std::vector<Cesium3DTiles::GroupMetadata> Cesium3DTiles::TilesetSpec::groups

An array of groups that tile content may belong to. Each element of this array is a metadata entity that describes the group. The tile content group property is an index into this array.

Definition at line 62 of file TilesetSpec.h.

◆ metadata

std::optional<Cesium3DTiles::MetadataEntity> Cesium3DTiles::TilesetSpec::metadata

A metadata entity that is associated with this tileset.

Definition at line 67 of file TilesetSpec.h.

◆ properties

std::unordered_map<std::string, Cesium3DTiles::Properties> Cesium3DTiles::TilesetSpec::properties

A dictionary object of metadata about per-feature properties.

Definition at line 38 of file TilesetSpec.h.

◆ root

Cesium3DTiles::Tile Cesium3DTiles::TilesetSpec::root

The root tile.

Definition at line 79 of file TilesetSpec.h.

◆ schema

std::optional<Cesium3DTiles::Schema> Cesium3DTiles::TilesetSpec::schema

An object defining the structure of metadata classes and enums. When this is defined, then schemaUri shall be undefined.

Definition at line 44 of file TilesetSpec.h.

◆ schemaUri

std::optional<std::string> Cesium3DTiles::TilesetSpec::schemaUri

The URI (or IRI) of the external schema file. When this is defined, then schema shall be undefined.

Definition at line 50 of file TilesetSpec.h.

◆ statistics

std::optional<Cesium3DTiles::Statistics> Cesium3DTiles::TilesetSpec::statistics

An object containing statistics about metadata entities.

Definition at line 55 of file TilesetSpec.h.

◆ TypeName

const char* Cesium3DTiles::TilesetSpec::TypeName = "Tileset"

staticconstexpr

The original name of this type.

Definition at line 28 of file TilesetSpec.h.

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

/home/runner/work/cesium-native/cesium-native/Cesium3DTiles/generated/include/Cesium3DTiles/TilesetSpec.h

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Friends