CesiumGltf::PropertyViewStatus Class Reference

Indicates the status of a property view. More...

#include <CesiumGltf/PropertyView.h>

Inheritance diagram for CesiumGltf::PropertyViewStatus:

Static Public Attributes
static const PropertyViewStatusType	Valid = 0
	This property view is valid and ready to use.
static const PropertyViewStatusType	EmptyPropertyWithDefault = 1
	This property view does not contain any data, but specifies a default value. This happens when a class property is defined with a default value and omitted from an instance of the class's collective properties. In this case, it is not possible to retrieve the raw data from a property, but its default value will be accessible.
static const PropertyViewStatusType	ErrorNonexistentProperty = 2
	This property view is trying to view a property that does not exist.
static const PropertyViewStatusType	ErrorTypeMismatch = 3
	This property view's type does not match what is specified in ClassProperty::type.
static const PropertyViewStatusType	ErrorComponentTypeMismatch = 4
	This property view's component type does not match what is specified in ClassProperty::componentType.
static const PropertyViewStatusType	ErrorArrayTypeMismatch = 5
	This property view differs from what is specified in ClassProperty::array.
static const PropertyViewStatusType	ErrorInvalidNormalization = 6
	This property says it is normalized, but it does not have an integer component type.
static const PropertyViewStatusType	ErrorNormalizationMismatch = 7
	This property view's normalization differs from what is specified in ClassProperty::normalized.
static const PropertyViewStatusType	ErrorInvalidOffset = 8
	The property provided an invalid offset value.
static const PropertyViewStatusType	ErrorInvalidScale = 9
	The property provided an invalid scale value.
static const PropertyViewStatusType	ErrorInvalidMax = 10
	The property provided an invalid maximum value.
static const PropertyViewStatusType	ErrorInvalidMin = 11
	The property provided an invalid minimum value.
static const PropertyViewStatusType	ErrorInvalidNoDataValue = 12
	The property provided an invalid "no data" value.
static const PropertyViewStatusType	ErrorInvalidDefaultValue = 13
	The property provided an invalid default value.

Detailed Description

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 30 of file PropertyView.h.

Member Data Documentation

EmptyPropertyWithDefault

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::EmptyPropertyWithDefault = 1

static

This property view does not contain any data, but specifies a default value. This happens when a class property is defined with a default value and omitted from an instance of the class's collective properties. In this case, it is not possible to retrieve the raw data from a property, but its default value will be accessible.

Definition at line 44 of file PropertyView.h.

ErrorArrayTypeMismatch

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorArrayTypeMismatch = 5

static

This property view differs from what is specified in ClassProperty::array.

Definition at line 68 of file PropertyView.h.

ErrorComponentTypeMismatch

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorComponentTypeMismatch = 4

static

This property view's component type does not match what is specified in ClassProperty::componentType.

Definition at line 62 of file PropertyView.h.

ErrorInvalidDefaultValue

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorInvalidDefaultValue = 13

static

The property provided an invalid default value.

Definition at line 110 of file PropertyView.h.

ErrorInvalidMax

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorInvalidMax = 10

static

The property provided an invalid maximum value.

Definition at line 95 of file PropertyView.h.

ErrorInvalidMin

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorInvalidMin = 11

static

The property provided an invalid minimum value.

Definition at line 100 of file PropertyView.h.

ErrorInvalidNoDataValue

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorInvalidNoDataValue = 12

static

The property provided an invalid "no data" value.

Definition at line 105 of file PropertyView.h.

ErrorInvalidNormalization

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorInvalidNormalization = 6

static

This property says it is normalized, but it does not have an integer component type.

Definition at line 74 of file PropertyView.h.

ErrorInvalidOffset

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorInvalidOffset = 8

static

The property provided an invalid offset value.

Definition at line 85 of file PropertyView.h.

ErrorInvalidScale

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorInvalidScale = 9

static

The property provided an invalid scale value.

Definition at line 90 of file PropertyView.h.

ErrorNonexistentProperty

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorNonexistentProperty = 2

static

This property view is trying to view a property that does not exist.

Definition at line 50 of file PropertyView.h.

ErrorNormalizationMismatch

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorNormalizationMismatch = 7

static

This property view's normalization differs from what is specified in ClassProperty::normalized.

Definition at line 80 of file PropertyView.h.

ErrorTypeMismatch

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::ErrorTypeMismatch = 3

static

This property view's type does not match what is specified in ClassProperty::type.

Definition at line 56 of file PropertyView.h.

Valid

const PropertyViewStatusType CesiumGltf::PropertyViewStatus::Valid = 0

static

This property view is valid and ready to use.

Definition at line 35 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