Parameters describing an implicit shape. More...

#include <CesiumGltf/Shape.h>

Inheritance diagram for CesiumGltf::Shape:

Classes
struct	Type
	Known values for Specifies the shape type. 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 CesiumGltf::NamedObject
int64_t	getSizeBytes () const
	Calculates the size in bytes of this object, including the contents of all collections, pointers, and strings. 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::string	type = Type::sphere
	Specifies the shape type.

std::optional< CesiumGltf::Sphere >	sphere
	A set of parameter values that are used to define a sphere shape.

std::optional< CesiumGltf::Box >	box
	A set of parameter values that are used to define a box shape.

std::optional< CesiumGltf::Capsule >	capsule
	A set of parameter values that are used to define a capsule shape.

std::optional< CesiumGltf::Cylinder >	cylinder
	A set of parameter values that are used to define a cylinder shape.

Public Attributes inherited from CesiumGltf::NamedObject
std::string	name
	The user-defined name of this object.

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

Detailed Description

Parameters describing an implicit shape.

Definition at line 19 of file Shape.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::Shape::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 82 of file Shape.h.

Member Data Documentation

◆ box

std::optional<CesiumGltf::Box> CesiumGltf::Shape::box

A set of parameter values that are used to define a box shape.

Definition at line 64 of file Shape.h.

◆ capsule

std::optional<CesiumGltf::Capsule> CesiumGltf::Shape::capsule

A set of parameter values that are used to define a capsule shape.

Definition at line 69 of file Shape.h.

◆ cylinder

std::optional<CesiumGltf::Cylinder> CesiumGltf::Shape::cylinder

A set of parameter values that are used to define a cylinder shape.

Definition at line 74 of file Shape.h.

◆ sphere

std::optional<CesiumGltf::Sphere> CesiumGltf::Shape::sphere

A set of parameter values that are used to define a sphere shape.

Definition at line 59 of file Shape.h.

◆ type

std::string CesiumGltf::Shape::type = Type::sphere

Specifies the shape type.

Known values are defined in Type.

Definition at line 54 of file Shape.h.

◆ TypeName

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

staticconstexpr

The original name of this type.

Definition at line 23 of file Shape.h.

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

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

Classes

Public Member Functions

Public Attributes

Static Public Attributes