vlSliceVoxelInfo Class Reference

The purpose of this class is to store information about a certain voxel on a vlSlice. More...

#include <vlslicevoxelinfo.h>

List of all members.

Public Member Functions
	vlSliceVoxelInfo ()
	Default constructor.
	~vlSliceVoxelInfo ()
	Defautl destructor.
vlTriple< float >	pos () const
	Get voxel position wrt the volume.
uint16	sliceXPos () const
	Get voxel's X position wrt slice.
uint16	sliceYPos () const
	Get voxel's Y position wrt slice.
void *	value () const
	Get the value of the voxel.
vlDataType	dataType () const
	Get the datatype of the voxel.
bool	isValid () const
	Check if data is valid.
void	setValid (bool valid=true)
	Set the (in)validity of the stored information.
void	setPos (const vlPoint3f pos)
	Set the position wrt volume.
void	setSlicePos (const uint16 x, const uint16 y)
	Set the position wrt slice.
void	setValue (void *voxel)
	Set the value of the voxel.
void	setDataType (const vlDataType type)
Protected Attributes
vlTriple< float >	m_pos
	Position of the voxel in the volume.
uint16	m_sliceXPos
	Position of the voxel on a slice (optional).
uint16	m_sliceYPos
	Position of the voxel on a slice (optional).
void *	m_pValue
	Value of the voxel.
std::string	m_displayValue
	Displayable value of the voxel data.
bool	m_bValid
	Status of the stored data.
vlDataType	m_dataType
	The datatype of the voxel.

---

Detailed Description

Objects of this class can be used to move around information regarding a voxel.

Definition at line 41 of file vlslicevoxelinfo.h.

---

Constructor & Destructor Documentation

vlSliceVoxelInfo::vlSliceVoxelInfo (   )

Definition at line 29 of file vlslicevoxelinfo.cpp.

vlSliceVoxelInfo::~vlSliceVoxelInfo (   )

Definition at line 37 of file vlslicevoxelinfo.cpp.

---

Member Function Documentation

vlDataType vlSliceVoxelInfo::dataType (   )  const [inline]

Definition at line 64 of file vlslicevoxelinfo.h. References m_dataType, and vlDataType.

bool vlSliceVoxelInfo::isValid (   )  const [inline]

Definition at line 67 of file vlslicevoxelinfo.h. References m_bValid.

vlTriple<float> vlSliceVoxelInfo::pos (   )  const [inline]

Definition at line 52 of file vlslicevoxelinfo.h. References m_pos.

void vlSliceVoxelInfo::setDataType (  const vlDataType  type  )  [inline]

Definition at line 81 of file vlslicevoxelinfo.h. References m_dataType. Referenced by vlSlice::getVoxelInfo().

void vlSliceVoxelInfo::setPos (  const vlPoint3f  pos  )  [inline]

Definition at line 73 of file vlslicevoxelinfo.h. References m_pos. Referenced by vlSlice::getVoxelInfo().

void vlSliceVoxelInfo::setSlicePos (  const uint16  x, const uint16  y )  [inline]

Definition at line 76 of file vlslicevoxelinfo.h. References m_sliceXPos, m_sliceYPos, x, and y. Referenced by vlSlice::getVoxelInfo().

void vlSliceVoxelInfo::setValid (  bool  valid = true  )  [inline]

Definition at line 70 of file vlslicevoxelinfo.h. References m_bValid. Referenced by vlSlice::getVoxelInfo().

void vlSliceVoxelInfo::setValue (  void *  voxel  )  [inline]

Definition at line 79 of file vlslicevoxelinfo.h. References m_pValue. Referenced by vlSlice::getVoxelInfo().

uint16 vlSliceVoxelInfo::sliceXPos (   )  const [inline]

Definition at line 55 of file vlslicevoxelinfo.h. References m_sliceXPos, and uint16.

uint16 vlSliceVoxelInfo::sliceYPos (   )  const [inline]

Definition at line 58 of file vlslicevoxelinfo.h. References m_sliceYPos, and uint16.

void* vlSliceVoxelInfo::value (   )  const [inline]

Definition at line 61 of file vlslicevoxelinfo.h. References m_pValue.

---

Member Data Documentation

bool vlSliceVoxelInfo::m_bValid [protected]

Definition at line 106 of file vlslicevoxelinfo.h. Referenced by isValid(), and setValid().

vlDataType vlSliceVoxelInfo::m_dataType [protected]

Definition at line 109 of file vlslicevoxelinfo.h. Referenced by dataType(), and setDataType().

std::string vlSliceVoxelInfo::m_displayValue [protected]

Definition at line 103 of file vlslicevoxelinfo.h.

vlTriple<float> vlSliceVoxelInfo::m_pos [protected]

Definition at line 94 of file vlslicevoxelinfo.h. Referenced by pos(), and setPos().

void* vlSliceVoxelInfo::m_pValue [protected]

Definition at line 100 of file vlslicevoxelinfo.h. Referenced by setValue(), and value().

uint16 vlSliceVoxelInfo::m_sliceXPos [protected]

Definition at line 97 of file vlslicevoxelinfo.h. Referenced by setSlicePos(), and sliceXPos().

uint16 vlSliceVoxelInfo::m_sliceYPos [protected]

Definition at line 97 of file vlslicevoxelinfo.h. Referenced by setSlicePos(), and sliceYPos().

---

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

• vlslicevoxelinfo.h
• vlslicevoxelinfo.cpp

---