A perspective camera containing properties to create a perspective projection matrix. More...

#include <CesiumGltf/CameraPerspective.h>

Inheritance diagram for CesiumGltf::CameraPerspective:

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
std::optional< double >	aspectRatio
	The floating-point aspect ratio of the field of view.

double	yfov = double()
	The floating-point vertical field of view in radians. This value SHOULD be less than π.

std::optional< double >	zfar
	The floating-point distance to the far clipping plane.

double	znear = double()
	The floating-point distance to the near clipping plane.

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

Detailed Description

A perspective camera containing properties to create a perspective projection matrix.

Definition at line 15 of file CameraPerspective.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::CameraPerspective::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 56 of file CameraPerspective.h.

Member Data Documentation

◆ aspectRatio

std::optional<double> CesiumGltf::CameraPerspective::aspectRatio

The floating-point aspect ratio of the field of view.

When undefined, the aspect ratio of the rendering viewport MUST be used.

Definition at line 28 of file CameraPerspective.h.

◆ TypeName

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

staticconstexpr

The original name of this type.

Definition at line 20 of file CameraPerspective.h.

◆ yfov

double CesiumGltf::CameraPerspective::yfov = double()

The floating-point vertical field of view in radians. This value SHOULD be less than π.

Definition at line 34 of file CameraPerspective.h.

◆ zfar

std::optional<double> CesiumGltf::CameraPerspective::zfar

The floating-point distance to the far clipping plane.

When defined, zfar MUST be greater than znear. If zfar is undefined, client implementations SHOULD use infinite projection matrix.

Definition at line 43 of file CameraPerspective.h.

◆ znear

double CesiumGltf::CameraPerspective::znear = double()

The floating-point distance to the near clipping plane.

Definition at line 48 of file CameraPerspective.h.

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

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

Public Member Functions

Public Attributes

Static Public Attributes