cesium-native 0.66.0
Loading...
Searching...
No Matches
CesiumGltf::Availability Struct Referencefinal

An object describing the availability of a set of elements. More...

#include <CesiumGltf/Availability.h>

Inheritance diagram for CesiumGltf::Availability:
CesiumUtility::ExtensibleObject

Classes

struct  Constant
 Known values for Integer indicating whether all of the elements are available (1) or all are unavailable (0). More...
 

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

int32_t bitstream = -1
 Index of a buffer view that contains availability bits. If an element is available, its bit is 1, and if it is unavailable, its bit is 0.
 
std::optional< int64_t > availableCount
 A number indicating how many 1 bits exist in the availability bitstream.
 
std::optional< int32_t > constant
 Integer indicating whether all of the elements are available (1) or all are unavailable (0).
 
- 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 = "Availability"
 The original name of this type.
 

Detailed Description

An object describing the availability of a set of elements.

Definition at line 15 of file Availability.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::Availability::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 61 of file Availability.h.

Member Data Documentation

◆ availableCount

std::optional<int64_t> CesiumGltf::Availability::availableCount

A number indicating how many 1 bits exist in the availability bitstream.

Definition at line 44 of file Availability.h.

◆ bitstream

int32_t CesiumGltf::Availability::bitstream = -1

Index of a buffer view that contains availability bits. If an element is available, its bit is 1, and if it is unavailable, its bit is 0.

Definition at line 38 of file Availability.h.

◆ constant

std::optional<int32_t> CesiumGltf::Availability::constant

Integer indicating whether all of the elements are available (1) or all are unavailable (0).

Known values are defined in Constant.

Definition at line 53 of file Availability.h.

◆ TypeName

const char* CesiumGltf::Availability::TypeName = "Availability"
staticconstexpr

The original name of this type.

Definition at line 20 of file Availability.h.


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