cesium-native  0.41.0
CesiumGltf::AccessorWriter< T > Class Template Referencefinal

Provides write access to an AccessorView. More...

#include <CesiumGltf/AccessorWriter.h>

Public Member Functions

 AccessorWriter (const AccessorView< T > &accessorView)
 Constructs a new instance from an AccessorView.
 
 AccessorWriter (std::byte *pData, int64_t stride, int64_t offset, int64_t size)
 
 AccessorWriter (Model &model, const Accessor &accessor)
 Creates a new instance from a given model and Accessor. More...
 
 AccessorWriter (Model &model, int32_t accessorIndex) noexcept
 Creates a new instance from a given model and accessor index. More...
 
const T & operator[] (int64_t i) const
 Provides the specified accessor element. More...
 
T & operator[] (int64_t i)
 Provides the specified accessor element. More...
 
int64_t size () const noexcept
 Returns the size (number of elements) of this accessor. More...
 
AccessorViewStatus status () const noexcept
 Gets the status of this accessor writer. More...
 

Detailed Description

template<class T>
class CesiumGltf::AccessorWriter< T >

Provides write access to an AccessorView.

Definition at line 10 of file AccessorWriter.h.

Constructor & Destructor Documentation

◆ AccessorWriter() [1/3]

template<class T >
CesiumGltf::AccessorWriter< T >::AccessorWriter ( std::byte *  pData,
int64_t  stride,
int64_t  offset,
int64_t  size 
)
inline

Definition at line 25 of file AccessorWriter.h.

◆ AccessorWriter() [2/3]

template<class T >
CesiumGltf::AccessorWriter< T >::AccessorWriter ( Model model,
const Accessor accessor 
)
inline

Creates a new instance from a given model and Accessor.

If the accessor cannot be viewed, the construct will still complete successfully without throwing an exception. However, size will return 0 and status will indicate what went wrong.

Parameters
modelThe model to access.
accessorThe accessor to view.

Definition at line 29 of file AccessorWriter.h.

◆ AccessorWriter() [3/3]

template<class T >
CesiumGltf::AccessorWriter< T >::AccessorWriter ( Model model,
int32_t  accessorIndex 
)
inlinenoexcept

Creates a new instance from a given model and accessor index.

If the accessor cannot be viewed, the construct will still complete successfully without throwing an exception. However, size will return 0 and status will indicate what went wrong.

Parameters
modelThe model to access.
accessorIndexThe index of the accessor to view in the model's Model::accessors list.

Definition at line 33 of file AccessorWriter.h.

Member Function Documentation

◆ operator[]() [1/2]

template<class T >
T& CesiumGltf::AccessorWriter< T >::operator[] ( int64_t  i)
inline

Provides the specified accessor element.

Parameters
iThe index of the element.
Returns
The constant reference to the accessor element.
Exceptions
Astd::range_error if the given index is negative or not smaller than the size of this accessor.

Definition at line 40 of file AccessorWriter.h.

◆ operator[]() [2/2]

template<class T >
const T& CesiumGltf::AccessorWriter< T >::operator[] ( int64_t  i) const
inline

Provides the specified accessor element.

Parameters
iThe index of the element.
Returns
The constant reference to the accessor element.
Exceptions
Astd::range_error if the given index is negative or not smaller than the size of this accessor.

Definition at line 37 of file AccessorWriter.h.

◆ size()

template<class T >
int64_t CesiumGltf::AccessorWriter< T >::size ( ) const
inlinenoexcept

Returns the size (number of elements) of this accessor.

This is the number of elements of type T that this accessor contains.

Returns
The size.

Definition at line 43 of file AccessorWriter.h.

◆ status()

template<class T >
AccessorViewStatus CesiumGltf::AccessorWriter< T >::status ( ) const
inlinenoexcept

Gets the status of this accessor writer.

Indicates whether the writer accurately reflects the accessor's data, or whether an error occurred.

Definition at line 51 of file AccessorWriter.h.


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