HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX > Class Template Reference

Partial template specialization of DenseBase. More...

#include <Dense.h>

Public Member Functions

size_t coordToOffset (size_t i, size_t j, size_t k) const
 Return the linear offset into this grid's value array given by unsigned coordinates (i, j, k), i.e., coordinates relative to the origin of this grid's bounding box. More...
 
Coord offsetToLocalCoord (size_t n) const
 Return the local coordinate corresponding to the specified linear offset. More...
 
size_t xStride () const
 Return the stride of the array in the x direction ( = dimY*dimZ). More...
 
size_t yStride () const
 Return the stride of the array in the y direction ( = dimZ). More...
 

Static Public Member Functions

static size_t zStride ()
 Return the stride of the array in the z direction ( = 1). More...
 

Protected Member Functions

 DenseBase (const CoordBBox &bbox)
 Protected constructor so as to prevent direct instantiation. More...
 

Protected Attributes

const CoordBBox mBBox
 
const size_t mY
 
const size_t mX
 

Detailed Description

template<typename ValueT>
class openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >

Partial template specialization of DenseBase.

Note
ZYX is the memory-layout in VDB. It leads to nested for-loops of the order x, y, z which we find to be the most intuitive.

Definition at line 103 of file Dense.h.

Constructor & Destructor Documentation

template<typename ValueT >
openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::DenseBase ( const CoordBBox &  bbox)
inlineprotected

Protected constructor so as to prevent direct instantiation.

Definition at line 140 of file Dense.h.

Member Function Documentation

template<typename ValueT >
size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::coordToOffset ( size_t  i,
size_t  j,
size_t  k 
) const
inline

Return the linear offset into this grid's value array given by unsigned coordinates (i, j, k), i.e., coordinates relative to the origin of this grid's bounding box.

Warning
The input coordinates are assume to be relative to the grid's origin, i.e. minimum of its index bounding box!

Definition at line 112 of file Dense.h.

template<typename ValueT >
Coord openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::offsetToLocalCoord ( size_t  n) const
inline

Return the local coordinate corresponding to the specified linear offset.

Warning
The returned coordinate is relative to the origin of this grid's bounding box so add dense.origin() to get absolute coordinates.

Definition at line 118 of file Dense.h.

template<typename ValueT >
size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::xStride ( ) const
inline

Return the stride of the array in the x direction ( = dimY*dimZ).

Note
This method is required by both CopyToDense and CopyFromDense.

Definition at line 128 of file Dense.h.

template<typename ValueT >
size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::yStride ( ) const
inline

Return the stride of the array in the y direction ( = dimZ).

Note
This method is required by both CopyToDense and CopyFromDense.

Definition at line 132 of file Dense.h.

template<typename ValueT >
static size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::zStride ( )
inlinestatic

Return the stride of the array in the z direction ( = 1).

Note
This method is required by both CopyToDense and CopyFromDense.

Definition at line 136 of file Dense.h.

Member Data Documentation

template<typename ValueT >
const CoordBBox openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::mBBox
protected

Definition at line 142 of file Dense.h.

template<typename ValueT >
const size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::mX
protected

Definition at line 143 of file Dense.h.

template<typename ValueT >
const size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutZYX >::mY
protected

Definition at line 143 of file Dense.h.


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