LibCarna::base::math::VectorField< ValueType > Class Template Reference

Abstract definition of an \(\mathbb Z_0^3 \to T\) vector field where \(T\) is ValueType. More...

#include <VectorField.hpp>

Public Types
typedef ValueType	Value
	Holds the co-domain type of the vector field.

Public Member Functions
virtual	~VectorField ()
	Does nothing.
virtual ValueType	operator() (unsigned int x, unsigned int y, unsigned int z) const =0
	Returns value of specified voxel.
virtual ValueType	operator() (const Vector3ui &at) const

Detailed Description

template<typename ValueType>
class LibCarna::base::math::VectorField< ValueType >

Abstract definition of an \(\mathbb Z_0^3 \to T\) vector field where \(T\) is ValueType.

Author

Leonid Kostrykin

Definition at line 48 of file VectorField.hpp.

Member Typedef Documentation

Value

template<typename ValueType >

typedef ValueType LibCarna::base::math::VectorField< ValueType >::Value

Holds the co-domain type of the vector field.

Definition at line 56 of file VectorField.hpp.

Constructor & Destructor Documentation

~VectorField()

template<typename ValueType >

virtual LibCarna::base::math::VectorField< ValueType >::~VectorField ( )

inlinevirtual

Does nothing.

Definition at line 61 of file VectorField.hpp.

Member Function Documentation

operator()() [1/2]

template<typename ValueType >

ValueType LibCarna::base::math::VectorField< ValueType >::operator() ( const Vector3ui &  at ) const

virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Reimplemented in LibCarna::base::BufferedIntensityVolume< VoxelType, BufferType >, LibCarna::base::IntensityVolume, and LibCarna::base::BufferedNormalMap3D< BufferedVectorComponentType, BufferType >.

Definition at line 81 of file VectorField.hpp.

operator()() [2/2]

template<typename ValueType >

virtual ValueType LibCarna::base::math::VectorField< ValueType >::operator() ( unsigned int  x, unsigned int  y, unsigned int  z  ) const

pure virtual

Returns value of specified voxel.

Implemented in LibCarna::base::BufferedIntensityVolume< VoxelType, BufferType >, LibCarna::base::BufferedNormalMap3D< BufferedVectorComponentType, BufferType >, and LibCarna::base::IntensityVolume.

---

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

• include/LibCarna/base/math/VectorField.hpp