cesium-native 0.44.2
Loading...
Searching...
No Matches
PropertyAttributePropertyView.h
1#pragma once
2
3#include <CesiumGltf/AccessorView.h>
4#include <CesiumGltf/PropertyAttributeProperty.h>
5#include <CesiumGltf/PropertyTransformations.h>
6#include <CesiumGltf/PropertyTypeTraits.h>
7#include <CesiumGltf/PropertyView.h>
8#include <CesiumUtility/Assert.h>
9
10#include <cmath>
11#include <cstdint>
12
13namespace CesiumGltf {
23public:
28 static const int ErrorInvalidPropertyAttribute = 14;
29
34 static const int ErrorUnsupportedProperty = 15;
35
40 static const int ErrorMissingAttribute = 16;
41
45 static const int ErrorInvalidAccessor = 17;
46
51 static const int ErrorAccessorTypeMismatch = 18;
52
58
64
69 static const int ErrorInvalidBufferView = 21;
70
75 static const int ErrorInvalidBuffer = 22;
76
82
88};
89
103template <typename ElementType, bool Normalized = false>
105
117template <typename ElementType>
118class PropertyAttributePropertyView<ElementType, false>
119 : public PropertyView<ElementType, false> {
120public:
125 : PropertyView<ElementType, false>(), _accessor{}, _size{0} {}
126
133 : PropertyView<ElementType, false>(status), _accessor{}, _size{0} {
134 CESIUM_ASSERT(
136 "An empty property view should not be constructed with a valid status");
137 }
138
150 const ClassProperty& classProperty,
151 int64_t size) noexcept
152 : PropertyView<ElementType, false>(classProperty), _accessor{}, _size{0} {
153 if (this->_status != PropertyAttributePropertyViewStatus::Valid) {
154 // Don't override the status / size if something is wrong with the class
155 // property's definition.
156 return;
157 }
158
159 if (!classProperty.defaultProperty) {
160 // This constructor should only be called if the class property *has* a
161 // default value. But in the case that it does not, this property view
162 // becomes invalid.
163 this->_status =
165 return;
166 }
167
168 this->_status =
170 this->_size = size;
171 }
172
182 const PropertyAttributeProperty& property,
183 const ClassProperty& classProperty,
184 const AccessorView<ElementType>& accessorView) noexcept
185 : PropertyView<ElementType, false>(classProperty, property),
186 _accessor{accessorView},
187 _size{
189 ? accessorView.size()
190 : 0} {}
191
207 std::optional<ElementType> get(int64_t index) const noexcept {
208 if (this->_status ==
210 return this->defaultValue();
211 }
212
213 ElementType value = getRaw(index);
214
215 if (value == this->noData()) {
216 return this->defaultValue();
217 }
218
219 return transformValue(value, this->offset(), this->scale());
220 }
221
232 ElementType getRaw(int64_t index) const noexcept {
233 CESIUM_ASSERT(
235 "Check the status() first to make sure view is valid");
236 CESIUM_ASSERT(
237 size() > 0 &&
238 "Check the size() of the view to make sure it's not empty");
239 CESIUM_ASSERT(index >= 0 && "index must be non-negative");
240 CESIUM_ASSERT(index < size() && "index must be less than size");
241
242 return _accessor[index];
243 }
244
252 int64_t size() const noexcept { return _size; }
253
254private:
256 int64_t _size;
257};
258
270template <typename ElementType>
271class PropertyAttributePropertyView<ElementType, true>
272 : public PropertyView<ElementType, true> {
273private:
274 using NormalizedType = typename TypeToNormalizedType<ElementType>::type;
275
276public:
281 : PropertyView<ElementType, true>(), _accessor{}, _size{0} {}
282
289 : PropertyView<ElementType, true>(status), _accessor{}, _size{0} {
290 CESIUM_ASSERT(
292 "An empty property view should not be constructed with a valid status");
293 }
294
305 const ClassProperty& classProperty,
306 int64_t size) noexcept
307 : PropertyView<ElementType, true>(classProperty), _accessor{}, _size{0} {
308 if (this->_status != PropertyAttributePropertyViewStatus::Valid) {
309 // Don't override the status / size if something is wrong with the class
310 // property's definition.
311 return;
312 }
313
314 if (!classProperty.defaultProperty) {
315 // This constructor should only be called if the class property *has* a
316 // default value. But in the case that it does not, this property view
317 // becomes invalid.
318 this->_status =
320 return;
321 }
322
323 this->_status =
325 this->_size = size;
326 }
327
337 const PropertyAttributeProperty& property,
338 const ClassProperty& classProperty,
339 const AccessorView<ElementType>& accessorView) noexcept
340 : PropertyView<ElementType, true>(classProperty, property),
341 _accessor{accessorView},
342 _size{
344 ? accessorView.size()
345 : 0} {}
346
362 std::optional<NormalizedType> get(int64_t index) const noexcept {
363 if (this->_status ==
365 return this->defaultValue();
366 }
367
368 ElementType value = getRaw(index);
369
370 if (value == this->noData()) {
371 return this->defaultValue();
372 }
373
377 this->offset(),
378 this->scale());
379 }
380
382 constexpr glm::length_t N = ElementType::length();
383 using T = typename ElementType::value_type;
384 using NormalizedT = typename NormalizedType::value_type;
386 normalize<N, T>(value),
387 this->offset(),
388 this->scale());
389 }
390
392 constexpr glm::length_t N = ElementType::length();
393 using T = typename ElementType::value_type;
394 using NormalizedT = typename NormalizedType::value_type;
396 normalize<N, T>(value),
397 this->offset(),
398 this->scale());
399 }
400 }
401
412 ElementType getRaw(int64_t index) const noexcept {
413 CESIUM_ASSERT(
415 "Check the status() first to make sure view is valid");
416 CESIUM_ASSERT(
417 size() > 0 &&
418 "Check the size() of the view to make sure it's not empty");
419 CESIUM_ASSERT(index >= 0 && "index must be non-negative");
420 CESIUM_ASSERT(index < size() && "index must be less than size");
421
422 return _accessor[index];
423 }
424
432 int64_t size() const noexcept { return _size; }
433
434private:
436 int64_t _size;
437};
438
439} // namespace CesiumGltf
A view on the data of one accessor of a glTF asset.
Indicates the status of a property attribute property view.
static const int ErrorInvalidBufferView
This property view uses an accessor that does not have a valid buffer view index.
static const int ErrorInvalidBuffer
This property view uses a buffer view that does not have a valid buffer index.
static const int ErrorAccessorNormalizationMismatch
This property view's normalization does not match the normalization of the accessor it uses.
static const int ErrorInvalidAccessor
This property view's attribute does not have a valid accessor index.
static const int ErrorMissingAttribute
This property view was initialized with a primitive that does not contain the specified attribute.
static const int ErrorAccessorComponentTypeMismatch
This property view's component type does not match the type of the accessor it uses.
static const int ErrorUnsupportedProperty
This property view is associated with a ClassProperty of an unsupported type.
static const int ErrorAccessorTypeMismatch
This property view's type does not match the type of the accessor it uses.
static const int ErrorInvalidPropertyAttribute
This property view was initialized from an invalid PropertyAttribute.
static const PropertyViewStatusType ErrorAccessorOutOfBounds
This property view uses an accessor that points outside the bounds of its target buffer view.
static const PropertyViewStatusType ErrorBufferViewOutOfBounds
This property view uses a buffer view that points outside the bounds of its target buffer.
std::optional< ElementType > get(int64_t index) const noexcept
Gets the value of the property for the given vertex index with all value transforms applied....
PropertyAttributePropertyView(PropertyViewStatusType status) noexcept
Constructs an invalid instance for an erroneous property.
ElementType getRaw(int64_t index) const noexcept
Gets the raw value of the property for the given vertex index.
PropertyAttributePropertyView() noexcept
Constructs an invalid instance for a non-existent property.
PropertyAttributePropertyView(const ClassProperty &classProperty, int64_t size) noexcept
Constructs an instance of an empty property that specifies a default value. Although this property ha...
int64_t size() const noexcept
Get the number of elements in this PropertyAttributePropertyView. If the view is valid,...
PropertyAttributePropertyView(const PropertyAttributeProperty &property, const ClassProperty &classProperty, const AccessorView< ElementType > &accessorView) noexcept
Construct a view of the data specified by a PropertyAttributeProperty.
ElementType getRaw(int64_t index) const noexcept
Gets the raw value of the property for the given vertex index.
PropertyAttributePropertyView(const PropertyAttributeProperty &property, const ClassProperty &classProperty, const AccessorView< ElementType > &accessorView) noexcept
Construct a view of the data specified by a PropertyAttributeProperty.
int64_t size() const noexcept
Get the number of elements in this PropertyAttributePropertyView. If the view is valid,...
std::optional< NormalizedType > get(int64_t index) const noexcept
Gets the value of the property for the given vertex index with all value transforms applied....
PropertyAttributePropertyView(PropertyViewStatusType status) noexcept
Constructs an invalid instance for an erroneous property.
PropertyAttributePropertyView() noexcept
Constructs an invalid instance for a non-existent property.
PropertyAttributePropertyView(const ClassProperty &classProperty, int64_t size) noexcept
Constructs an instance of an empty property that specifies a default value. Although this property ha...
A view of the data specified by a PropertyAttributeProperty.
Indicates the status of a property view.
static const PropertyViewStatusType Valid
This property view is valid and ready to use.
static const PropertyViewStatusType ErrorNonexistentProperty
This property view is trying to view a property that does not exist.
static const PropertyViewStatusType EmptyPropertyWithDefault
This property view does not contain any data, but specifies a default value. This happens when a clas...
Represents a metadata property in EXT_structural_metadata.
Classes for working with glTF models.
T transformValue(const T &value, const std::optional< T > &offset, const std::optional< T > &scale)
Transforms the value by optional offset and scale factors.
double normalize(T value)
Normalizes the given value between [0, 1] if unsigned or [-1, 1] if signed, based on the type's maxim...
int32_t PropertyViewStatusType
The type used for fields of PropertyViewStatus.
Check if a C++ type can be represented as a matN type.
Check if a C++ type can be represented as a scalar property type.
Check if a C++ type can be represented as a vecN type.
An attribute containing property values.
Convert an integer numeric type to the corresponding representation as a double type....