Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
accessor Class Reference

glTF accessor More...

Inheritance diagram for accessor:
Inheritance graph
[legend]
Collaboration diagram for accessor:
Collaboration graph
[legend]

Public Member Functions

 accessor ()
 Default construct. More...
 
 accessor (const word &name)
 Construct from name. More...
 
 ~accessor ()=default
 Destructor. More...
 
label & bufferViewId () noexcept
 Return the buffer view index. More...
 
label & byteOffset () noexcept
 Return the byte offset. More...
 
label & componentType () noexcept
 Return the component type. More...
 
label & count () noexcept
 Return the data size. More...
 
string & type () noexcept
 Return the type. More...
 
template<class Type >
void set (const Field< Type > &fld, bool calcMinMax=true)
 Set the accessor. More...
 
void write (Ostream &os) const
 Write. More...
 
template<class Type >
Foam::string getValueType ()
 
template<class Type >
Foam::string toString (const Type &val)
 
- Public Member Functions inherited from base
 base ()
 Default construct. More...
 
 base (const word &name)
 Construct with name. More...
 
 ~base ()=default
 Destructor. More...
 
label & id () noexcept
 Return access to the ID. More...
 
const word & name () const noexcept
 Return const access to the name. More...
 
void write (Ostream &os) const
 Write. More...
 
void operator= (const base &gltf)
 

Static Protected Member Functions

template<class Type >
static string getValueType ()
 Return the glTF value type for the given OpenFOAM type. More...
 
template<class Type >
static string toString (const Type &val)
 Stringify the value. More...
 

Protected Attributes

label bufferViewId_
 Buffer view index. More...
 
label byteOffset_
 Byte offset. More...
 
label componentType_
 Component type. More...
 
label count_
 Data size. More...
 
string type_
 Data type. More...
 
string max_
 Max value. Note: stored as a string for convenience. More...
 
string min_
 Min value. Note: stored as a string for convenience. More...
 
bool minMax_
 Flag to indicate whether min and max values are available. More...
 
- Protected Attributes inherited from base
word name_
 Name. More...
 
label id_
 ID. More...
 

Detailed Description

glTF accessor

Note
Implements the glTF v2 specification
Source files

Definition at line 62 of file foamGltfAccessor.H.

Constructor & Destructor Documentation

◆ accessor() [1/2]

accessor ( )

Default construct.

Definition at line 25 of file foamGltfAccessor.C.

◆ accessor() [2/2]

accessor ( const word &  name)
explicit

Construct from name.

Definition at line 39 of file foamGltfAccessor.C.

◆ ~accessor()

~accessor ( )
default

Destructor.

Member Function Documentation

◆ getValueType() [1/2]

static string getValueType ( )
staticprotected

Return the glTF value type for the given OpenFOAM type.

◆ toString() [1/2]

static string toString ( const Type &  val)
staticprotected

Stringify the value.

Referenced by accessor::set().

Here is the caller graph for this function:

◆ bufferViewId()

Foam::label & bufferViewId ( )
noexcept

Return the buffer view index.

Definition at line 55 of file foamGltfAccessor.C.

◆ byteOffset()

Foam::label & byteOffset ( )
noexcept

Return the byte offset.

Definition at line 61 of file foamGltfAccessor.C.

◆ componentType()

Foam::label & componentType ( )
noexcept

Return the component type.

Definition at line 67 of file foamGltfAccessor.C.

◆ count()

Foam::label & count ( )
noexcept

Return the data size.

Definition at line 73 of file foamGltfAccessor.C.

◆ type()

Foam::string & type ( )
noexcept

Return the type.

Definition at line 79 of file foamGltfAccessor.C.

◆ set()

void set ( const Field< Type > &  fld,
bool  calcMinMax = true 
)

Set the accessor.

Definition at line 79 of file foamGltfAccessorTemplates.C.

References fld, Foam::glTF::FLOAT, Foam::glTF::key(), Foam::max(), maxValue, Foam::min(), minValue, and accessor::toString().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 85 of file foamGltfAccessor.C.

References Foam::indent(), Foam::nl, os(), and base::write().

Referenced by Foam::operator<<().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getValueType() [2/2]

Foam::string getValueType ( )

Definition at line 27 of file foamGltfAccessorTemplates.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ toString() [2/2]

Foam::string toString ( const Type &  val)

Definition at line 61 of file foamGltfAccessorTemplates.C.

References Foam::component(), Foam::expressions::Detail::nComponents(), and StringStreamAllocator< StreamType >::str().

Here is the call graph for this function:

Member Data Documentation

◆ bufferViewId_

label bufferViewId_
protected

Buffer view index.

Definition at line 73 of file foamGltfAccessor.H.

◆ byteOffset_

label byteOffset_
protected

Byte offset.

Definition at line 78 of file foamGltfAccessor.H.

◆ componentType_

label componentType_
protected

Component type.

Definition at line 83 of file foamGltfAccessor.H.

◆ count_

label count_
protected

Data size.

Definition at line 88 of file foamGltfAccessor.H.

◆ type_

string type_
protected

Data type.

Definition at line 93 of file foamGltfAccessor.H.

◆ max_

string max_
protected

Max value. Note: stored as a string for convenience.

Definition at line 98 of file foamGltfAccessor.H.

◆ min_

string min_
protected

Min value. Note: stored as a string for convenience.

Definition at line 103 of file foamGltfAccessor.H.

◆ minMax_

bool minMax_
protected

Flag to indicate whether min and max values are available.

Definition at line 108 of file foamGltfAccessor.H.

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