KHR_billboard glTF Node Extension. More...

#include <CesiumGltf/ExtensionKhrBillboard.h>

Inheritance diagram for CesiumGltf::ExtensionKhrBillboard:

Classes
struct	RotationAxisItems
	Known values for rotationAxis. 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
bool	overlay = false
	If true, the billboard is rendered on top of other objects. (Default: false)

std::vector< std::string >	rotationAxis = {"X", "Y", "Z"}
	The axes around which the billboard rotates. 'X', 'Y', and/or 'Z'. (Default: ['X', 'Y', 'Z'])

bool	scaleWithDistance = false
	If true, the billboard scales with distance from the camera. (Default: false)

std::vector< double >	up = {0, 1, 0}
	The up direction of the billboard. Must be defined if `viewDirection` is parallel to the default up vector. (Default: +Y)

std::vector< double >	viewDirection = {0, 0, 1}
	The view direction of the billboard. (Default: +Z)

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

static constexpr const char *	ExtensionName = "KHR_billboard"
	The official name of the extension. This should be the same as its key in the `extensions` object.

Detailed Description

KHR_billboard glTF Node Extension.

Definition at line 15 of file ExtensionKhrBillboard.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::ExtensionKhrBillboard::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 74 of file ExtensionKhrBillboard.h.

Member Data Documentation

◆ ExtensionName

const char* CesiumGltf::ExtensionKhrBillboard::ExtensionName = "KHR_billboard"

staticconstexpr

The official name of the extension. This should be the same as its key in the extensions object.

Definition at line 23 of file ExtensionKhrBillboard.h.

◆ overlay

bool CesiumGltf::ExtensionKhrBillboard::overlay = false

If true, the billboard is rendered on top of other objects. (Default: false)

Definition at line 43 of file ExtensionKhrBillboard.h.

◆ rotationAxis

std::vector<std::string> CesiumGltf::ExtensionKhrBillboard::rotationAxis = {"X", "Y", "Z"}

The axes around which the billboard rotates. 'X', 'Y', and/or 'Z'. (Default: ['X', 'Y', 'Z'])

Definition at line 49 of file ExtensionKhrBillboard.h.

◆ scaleWithDistance

bool CesiumGltf::ExtensionKhrBillboard::scaleWithDistance = false

If true, the billboard scales with distance from the camera. (Default: false)

Definition at line 55 of file ExtensionKhrBillboard.h.

◆ TypeName

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

staticconstexpr

The original name of this type.

Definition at line 20 of file ExtensionKhrBillboard.h.

◆ up

std::vector<double> CesiumGltf::ExtensionKhrBillboard::up = {0, 1, 0}

The up direction of the billboard. Must be defined if viewDirection is parallel to the default up vector. (Default: +Y)

Definition at line 61 of file ExtensionKhrBillboard.h.

◆ viewDirection

std::vector<double> CesiumGltf::ExtensionKhrBillboard::viewDirection = {0, 0, 1}

The view direction of the billboard. (Default: +Z)

Definition at line 66 of file ExtensionKhrBillboard.h.

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

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

Classes

Public Member Functions

Public Attributes

Static Public Attributes