A directional, point, or spot light. More...

#include <CesiumGltf/Light.h>

Inheritance diagram for CesiumGltf::Light:

Classes
struct	Type
	Known values for Specifies the light 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::vector< double >	color = {1, 1, 1}
	Color of the light source.

double	intensity = 1
	Intensity of the light source. `point` and `spot` lights use luminous intensity in candela (lm/sr) while `directional` lights use illuminance in lux (lm/m^2)

std::optional< CesiumGltf::Spotlight >	spot
	spot

std::string	type = Type::directional
	Specifies the light type.

std::optional< double >	range
	A distance cutoff at which the light's intensity may be considered to have reached zero.

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

Detailed Description

A directional, point, or spot light.

Definition at line 17 of file Light.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::Light::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 95 of file Light.h.

Member Data Documentation

◆ color

std::vector<double> CesiumGltf::Light::color = {1, 1, 1}

Color of the light source.

Definition at line 61 of file Light.h.

◆ intensity

double CesiumGltf::Light::intensity = 1

Intensity of the light source. point and spot lights use luminous intensity in candela (lm/sr) while directional lights use illuminance in lux (lm/m^2)

Definition at line 68 of file Light.h.

◆ range

std::optional<double> CesiumGltf::Light::range

A distance cutoff at which the light's intensity may be considered to have reached zero.

Definition at line 87 of file Light.h.

◆ spot

std::optional<CesiumGltf::Spotlight> CesiumGltf::Light::spot

spot

Definition at line 73 of file Light.h.

◆ type

std::string CesiumGltf::Light::type = Type::directional

Specifies the light type.

Known values are defined in Type.

Definition at line 81 of file Light.h.

◆ TypeName

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

staticconstexpr

The original name of this type.

Definition at line 21 of file Light.h.

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

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

Classes

Public Member Functions

Public Attributes

Static Public Attributes