Represents a string array metadata property in EXT_structural_metadata. More...

#include <CesiumGltf/PropertyView.h>

Public Member Functions
	PropertyView ()
	Constructs an empty property instance.

	PropertyView (const ClassProperty &classProperty)
	Constructs a property instance from a class definition only.

PropertyViewStatusType	status () const noexcept
	Constructs an empty property instance. false>status

const std::optional< std::string > &	name () const noexcept
	Constructs an empty property instance. false>name

const std::optional< std::string > &	semantic () const noexcept
	Constructs an empty property instance. false>semantic

const std::optional< std::string > &	description () const noexcept
	Constructs an empty property instance. false>description

int64_t	arrayCount () const noexcept
	Constructs an empty property instance. false>arrayCount

bool	normalized () const noexcept
	Constructs an empty property instance. false>normalized

std::optional< PropertyArrayView< std::string_view > >	offset () const noexcept
	Constructs an empty property instance. false>offset

std::optional< PropertyArrayView< std::string_view > >	scale () const noexcept
	Constructs an empty property instance. false>scale

std::optional< PropertyArrayView< std::string_view > >	max () const noexcept
	Constructs an empty property instance. false>max

std::optional< PropertyArrayView< std::string_view > >	min () const noexcept
	Constructs an empty property instance. false>min

bool	required () const noexcept
	Constructs an empty property instance. false>required

std::optional< PropertyArrayView< std::string_view > >	noData () const noexcept
	Constructs an empty property instance. false>noData

std::optional< PropertyArrayView< std::string_view > >	defaultValue () const noexcept
	Constructs an empty property instance. false>defaultValue

PropertyType	propertyType () const noexcept
	Returns the PropertyType of the property this view is accessing.

Protected Member Functions
	PropertyView (PropertyViewStatusType status)
	Constructs an invalid instance for an erroneous property.

	PropertyView (const ClassProperty &classProperty, const PropertyTableProperty &, const CesiumGltf::Enum *)
	Constructs a property instance from a property table property and its class definition.

Protected Attributes
PropertyViewStatusType	_status
	Indicates the status of a property view.

Detailed Description

Represents a string array metadata property in EXT_structural_metadata.

Definition at line 2495 of file PropertyView.h.

Constructor & Destructor Documentation

◆ PropertyView() [1/4]

CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::PropertyView ( )

inline

Constructs an empty property instance.

Definition at line 2500 of file PropertyView.h.

◆ PropertyView() [2/4]

CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::PropertyView ( const ClassProperty & classProperty )

inline

Constructs a property instance from a class definition only.

Definition at line 2513 of file PropertyView.h.

◆ PropertyView() [3/4]

CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::PropertyView ( PropertyViewStatusType status )

inlineprotected

Constructs an invalid instance for an erroneous property.

Parameters

status The value of PropertyViewStatus indicating the error with the property.

Definition at line 2560 of file PropertyView.h.

◆ PropertyView() [4/4]

CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::PropertyView	(	const ClassProperty &	classProperty,
		const PropertyTableProperty &	,
		const CesiumGltf::Enum *	)

inlineprotected

Constructs a property instance from a property table property and its class definition.

Definition at line 2574 of file PropertyView.h.

Member Function Documentation

◆ arrayCount()

int64_t CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::arrayCount ( ) const

inlinenoexcept

Constructs an empty property instance. false>arrayCount

false>arrayCount

Definition at line 2608 of file PropertyView.h.

◆ defaultValue()

std::optional< PropertyArrayView< std::string_view > > CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::defaultValue ( ) const

inlinenoexcept

Constructs an empty property instance. false>defaultValue

false>defaultValue

Definition at line 2660 of file PropertyView.h.

◆ description()

const std::optional< std::string > & CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::description ( ) const

inlinenoexcept

Constructs an empty property instance. false>description

false>description

Definition at line 2601 of file PropertyView.h.

◆ max()

std::optional< PropertyArrayView< std::string_view > > CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::max ( ) const

inlinenoexcept

Constructs an empty property instance. false>max

false>max

Definition at line 2632 of file PropertyView.h.

◆ min()

std::optional< PropertyArrayView< std::string_view > > CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::min ( ) const

inlinenoexcept

Constructs an empty property instance. false>min

false>min

Definition at line 2639 of file PropertyView.h.

◆ name()

const std::optional< std::string > & CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::name ( ) const

inlinenoexcept

Constructs an empty property instance. false>name

false>name

Definition at line 2589 of file PropertyView.h.

◆ noData()

std::optional< PropertyArrayView< std::string_view > > CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::noData ( ) const

inlinenoexcept

Constructs an empty property instance. false>noData

false>noData

Definition at line 2651 of file PropertyView.h.

◆ normalized()

bool CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::normalized ( ) const

inlinenoexcept

Constructs an empty property instance. false>normalized

false>normalized

Definition at line 2613 of file PropertyView.h.

◆ offset()

std::optional< PropertyArrayView< std::string_view > > CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::offset ( ) const

inlinenoexcept

Constructs an empty property instance. false>offset

false>offset

Definition at line 2618 of file PropertyView.h.

◆ propertyType()

PropertyType CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::propertyType ( ) const

inlinenoexcept

Returns the PropertyType of the property this view is accessing.

Definition at line 2670 of file PropertyView.h.

◆ required()

bool CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::required ( ) const

inlinenoexcept

Constructs an empty property instance. false>required

false>required

Definition at line 2646 of file PropertyView.h.

◆ scale()

std::optional< PropertyArrayView< std::string_view > > CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::scale ( ) const

inlinenoexcept

Constructs an empty property instance. false>scale

false>scale

Definition at line 2625 of file PropertyView.h.

◆ semantic()

const std::optional< std::string > & CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::semantic ( ) const

inlinenoexcept

Constructs an empty property instance. false>semantic

false>semantic

Definition at line 2594 of file PropertyView.h.

◆ status()

PropertyViewStatusType CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::status ( ) const

inlinenoexcept

Constructs an empty property instance. false>status

false>status

Definition at line 2584 of file PropertyView.h.

Member Data Documentation

◆ _status

PropertyViewStatusType CesiumGltf::PropertyView< PropertyArrayView< std::string_view > >::_status

protected

Indicates the status of a property view.

The PropertyView constructor always completes successfully. However, there may be fundamental errors with the property definition. In such cases, this enumeration provides the reason.

This is defined with a class of static consts as opposed to an enum, so that derived property view classes can extend the statuses with their own specific errors.

Definition at line 2674 of file PropertyView.h.

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

/home/runner/work/cesium-native/cesium-native/CesiumGltf/include/CesiumGltf/PropertyView.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PropertyView() [1/4]

◆ PropertyView() [2/4]

◆ PropertyView() [3/4]

◆ PropertyView() [4/4]

Member Function Documentation

◆ arrayCount()

◆ defaultValue()

◆ description()

◆ max()

◆ min()

◆ name()

◆ noData()

◆ normalized()

◆ offset()

◆ propertyType()

◆ required()

◆ scale()

◆ semantic()

◆ status()

Member Data Documentation

◆ _status