openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ > 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 index coordinate corresponding to the specified linear offset. More...
size_t	yStride () const
	Return the stride of the array in the y direction ( = dimX). More...
size_t	zStride () const
	Return the stride of the array in the y direction ( = dimX*dimY). More...

Static Public Member Functions
static size_t	xStride ()
	Return the stride of the array in the x 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	mZ

Detailed Description

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

Partial template specialization of DenseBase.

Note

This is the memory-layout employed in Houdini and Maya. It leads to nested for-loops of the order z, y, x.

Definition at line 126 of file Dense.h.

Constructor & Destructor Documentation

template<typename ValueT >

openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::DenseBase ( const CoordBBox &  bbox )

inlineprotected

Protected constructor so as to prevent direct instantiation.

Definition at line 163 of file Dense.h.

Member Function Documentation

template<typename ValueT >

size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::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 135 of file Dense.h.

template<typename ValueT >

Coord openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::offsetToLocalCoord ( size_t  n ) const

inline

Return the index 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 141 of file Dense.h.

template<typename ValueT >

static size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::xStride ( )

inlinestatic

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

Note

This method is required by both CopyToDense and CopyFromDense.

Definition at line 151 of file Dense.h.

template<typename ValueT >

size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::yStride ( ) const

inline

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

Note

This method is required by both CopyToDense and CopyFromDense.

Definition at line 155 of file Dense.h.

template<typename ValueT >

size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::zStride ( ) const

inline

Return the stride of the array in the y direction ( = dimX*dimY).

Note

This method is required by both CopyToDense and CopyFromDense.

Definition at line 159 of file Dense.h.

Member Data Documentation

template<typename ValueT >

const CoordBBox openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::mBBox

protected

Definition at line 165 of file Dense.h.

template<typename ValueT >

const size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::mY

protected

Definition at line 166 of file Dense.h.

template<typename ValueT >

const size_t openvdb::OPENVDB_VERSION_NAME::tools::DenseBase< ValueT, LayoutXYZ >::mZ

protected

Definition at line 166 of file Dense.h.

---

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

• openvdb/tools/Dense.h