UT_PointGridVector3ArrayAccessor< INDEX, KEY > Class Template Reference

Generic UT_Vector3Array based accessor for UT_PointGrid. More...

#include <UT_PointGrid.h>

Public Types
typedef INDEX	indextype
typedef KEY	keytype

Public Member Functions
	UT_PointGridVector3ArrayAccessor (const UT_Vector3Array &positions, const UT_ValArray< keytype > &keys, const UT_BitArray *valid=NULL)
indextype	entries () const
	Returns the number of points. More...
UT_Vector3	getPos (indextype idx) const
	Returns the position for a given index. More...
keytype	getKey (indextype idx) const
	Gets the key for a given index. More...
exint	maxKeyValue () const
int64	getMemoryUsage () const
void	build ()

Static Public Attributes
static const keytype	INVALIDKEY = std::numeric_limits<KEY>::max()
	Invalid key value. More...

Protected Attributes
const UT_Vector3Array &	myV3Array
const UT_ValArray< keytype > &	myKeyArray
const UT_BitArray *	myValidArray

Detailed Description

template<typename INDEX, typename KEY>
class UT_PointGridVector3ArrayAccessor< INDEX, KEY >

Generic UT_Vector3Array based accessor for UT_PointGrid.

This class provides the required functions to serve as an accessor for building a UT_PointGrid over the points provided in the UT_Vector3Array passed to the constructor. See GEO_PointGrid for an accessor over the points in a GEO_Detail.

Definition at line 296 of file UT_PointGrid.h.

Member Typedef Documentation

template<typename INDEX , typename KEY >

typedef INDEX UT_PointGridVector3ArrayAccessor< INDEX, KEY >::indextype

Definition at line 300 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

typedef KEY UT_PointGridVector3ArrayAccessor< INDEX, KEY >::keytype

Definition at line 301 of file UT_PointGrid.h.

Constructor & Destructor Documentation

template<typename INDEX , typename KEY >

UT_PointGridVector3ArrayAccessor< INDEX, KEY >::UT_PointGridVector3ArrayAccessor ( const UT_Vector3Array &  positions, const UT_ValArray< keytype > &  keys, const UT_BitArray *  valid = NULL  )

inline

Create an accessor for the provided array of positions and keys.

Note

This class will not take ownership of the provided arrays; it merely provides an interface for UT_PointGrid::build().

Definition at line 309 of file UT_PointGrid.h.

Member Function Documentation

template<typename INDEX , typename KEY >

void UT_PointGridVector3ArrayAccessor< INDEX, KEY >::build ( )

inline

Definition at line 354 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

indextype UT_PointGridVector3ArrayAccessor< INDEX, KEY >::entries ( ) const

inline

Returns the number of points.

Definition at line 322 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

keytype UT_PointGridVector3ArrayAccessor< INDEX, KEY >::getKey ( indextype  idx ) const

inline

Gets the key for a given index.

Definition at line 334 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

int64 UT_PointGridVector3ArrayAccessor< INDEX, KEY >::getMemoryUsage ( ) const

inline

Definition at line 348 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

UT_Vector3 UT_PointGridVector3ArrayAccessor< INDEX, KEY >::getPos ( indextype  idx ) const

inline

Returns the position for a given index.

Definition at line 328 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

exint UT_PointGridVector3ArrayAccessor< INDEX, KEY >::maxKeyValue ( ) const

inline

Returns the maximum possible key value, used by UT_PointGrid::canBuild().

Definition at line 343 of file UT_PointGrid.h.

Member Data Documentation

template<typename INDEX , typename KEY >

const KEY UT_PointGridVector3ArrayAccessor< INDEX, KEY >::INVALIDKEY = std::numeric_limits<KEY>::max()

static

Invalid key value.

Definition at line 304 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

const UT_ValArray<keytype>& UT_PointGridVector3ArrayAccessor< INDEX, KEY >::myKeyArray

protected

Definition at line 358 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

const UT_Vector3Array& UT_PointGridVector3ArrayAccessor< INDEX, KEY >::myV3Array

protected

Definition at line 357 of file UT_PointGrid.h.

template<typename INDEX , typename KEY >

const UT_BitArray* UT_PointGridVector3ArrayAccessor< INDEX, KEY >::myValidArray

protected

Definition at line 359 of file UT_PointGrid.h.

---

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

• UT/UT_PointGrid.h
• UT/UT_PointGridImpl.h