Ocean
Public Member Functions | Protected Attributes
Ocean::Rendering::QuadFace Class Reference
Ocean Rendering Abstraction Library

Definition of a quad face with four vertex indices. More...

Public Member Functions

 QuadFace ()
 Creates a new quad face object with undefined indices. More...
 
 QuadFace (const VertexIndex startIndex)
 Creates a new quad face object with successive indices. More...
 
 QuadFace (const VertexIndex first, const VertexIndex second, const VertexIndex third, const VertexIndex fourth)
 Creates a new quad face object with four given indices. More...
 
 QuadFace (const VertexIndex *arrayValue)
 Creates a new quad face object by an array of at least four indices. More...
 
VertexIndex index (const unsigned int index) const
 Returns a specific vertex index specified by it's index inside the face. More...
 
VertexIndex & index (const unsigned int index)
 Returns a specific vertex index specified by it's index inside the face. More...
 
VertexIndex operator[] (const unsigned int index) const
 Returns a specific vertex index specified by it's index inside the face. More...
 
VertexIndex & operator[] (const unsigned int index)
 Returns a specific vertex index specified by it's index inside the face. More...
 
const VertexIndex * operator() () const
 Returns the pointer to the first element of the vertex indices. More...
 
VertexIndex * operator() ()
 Returns the pointer to the first element of the vertex indices. More...
 

Protected Attributes

VertexIndex faceIndices [4]
 The four vertex indices. More...
 

Detailed Description

Definition of a quad face with four vertex indices.

Constructor & Destructor Documentation

◆ QuadFace() [1/4]

Ocean::Rendering::QuadFace::QuadFace ( )
inline

Creates a new quad face object with undefined indices.

◆ QuadFace() [2/4]

Ocean::Rendering::QuadFace::QuadFace ( const VertexIndex  startIndex)
inlineexplicit

Creates a new quad face object with successive indices.


The first index is given, the following indices will be set to successive values.

Parameters
startIndexIndex of the first vertex

◆ QuadFace() [3/4]

Ocean::Rendering::QuadFace::QuadFace ( const VertexIndex  first,
const VertexIndex  second,
const VertexIndex  third,
const VertexIndex  fourth 
)
inline

Creates a new quad face object with four given indices.

Parameters
firstFirst vertex index
secondSecond vertex index
thirdThird vertex index
fourthFourth vertex index

◆ QuadFace() [4/4]

Ocean::Rendering::QuadFace::QuadFace ( const VertexIndex *  arrayValue)
inlineexplicit

Creates a new quad face object by an array of at least four indices.

Parameters
arrayValueArray with at least four vertex indices

Member Function Documentation

◆ index() [1/2]

VertexIndex & Ocean::Rendering::QuadFace::index ( const unsigned int  index)
inline

Returns a specific vertex index specified by it's index inside the face.

Beware: No range check will be done!

Parameters
indexIndex of the vertex index with range [0, 3]
Returns
Specified vertex index

◆ index() [2/2]

VertexIndex Ocean::Rendering::QuadFace::index ( const unsigned int  index) const
inline

Returns a specific vertex index specified by it's index inside the face.

Beware: No range check will be done!

Parameters
indexIndex of the vertex index with range [0, 3]
Returns
Specified vertex index

◆ operator()() [1/2]

VertexIndex * Ocean::Rendering::QuadFace::operator() ( )
inline

Returns the pointer to the first element of the vertex indices.

Returns
Array with vertex indices

◆ operator()() [2/2]

const VertexIndex * Ocean::Rendering::QuadFace::operator() ( ) const
inline

Returns the pointer to the first element of the vertex indices.

Returns
Array with vertex indices

◆ operator[]() [1/2]

VertexIndex & Ocean::Rendering::QuadFace::operator[] ( const unsigned int  index)
inline

Returns a specific vertex index specified by it's index inside the face.

Beware: No range check will be done!

Parameters
indexIndex of the vertex index with range [0, 3]
Returns
Specified vertex index

◆ operator[]() [2/2]

VertexIndex Ocean::Rendering::QuadFace::operator[] ( const unsigned int  index) const
inline

Returns a specific vertex index specified by it's index inside the face.

Beware: No range check will be done!

Parameters
indexIndex of the vertex index with range [0, 3]
Returns
Specified vertex index

Field Documentation

◆ faceIndices

VertexIndex Ocean::Rendering::QuadFace::faceIndices[4]
protected

The four vertex indices.

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