LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType > Class Template Reference

Represents a single volumetric data partition. More...

#include <VolumeSegment.hpp>

Inheritance diagram for LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >:

Collaboration diagram for LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >:

Public Types
typedef VolumeGrid< SegmentIntensityVolumeType, SegmentNormalsVolumeType >	Grid
	Reflects the type to use for representation of the whole volumetric data partitioning.
typedef SegmentIntensityVolumeType	IntensityVolume
	Reflects the type to use for storing the intensity volume of a single partition.
typedef SegmentNormalsVolumeType	NormalsVolume
	Reflects the type to use for storing the normal map of a single partition.

Public Member Functions
	VolumeSegment (Grid &grid)
	Instantiates.
void	setIntensities (Association< SegmentIntensityVolumeType > *intensities)
	Sets the intensity volume data of this partition.
SegmentIntensityVolumeType &	intensities ()
	References the intensity volume data of this partition.
const SegmentIntensityVolumeType &	intensities () const
bool	hasIntensities () const
	Tells whether this partition has intensity volume data associated.
Public Member Functions inherited from LibCarna::base::VolumeSegmentNormalsComponent< SegmentNormalsVolumeType >
virtual	~VolumeSegmentNormalsComponent ()
	Deletes.
void	setNormals (Association< SegmentNormalsVolumeType > *volume)
	Sets the normal map of this partition.
SegmentNormalsVolumeType &	normals ()
	References the normal map of this partition.
const SegmentNormalsVolumeType &	normals () const
bool	hasNormals () const
	Tells whether this partition has a normal map associated.

Public Attributes
Grid &	grid
	References the volumetric data partitioning this partition belongs to.
math::Vector3ui	offset
	Holds the coordinate offset this partition within the whole volumetric data partitioning.

Detailed Description

template<typename SegmentIntensityVolumeType, typename SegmentNormalsVolumeType>
class LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >

Represents a single volumetric data partition.

Author

Leonid Kostrykin

Definition at line 160 of file VolumeSegment.hpp.

Member Typedef Documentation

Grid

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

typedef VolumeGrid< SegmentIntensityVolumeType, SegmentNormalsVolumeType > LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::Grid

Reflects the type to use for representation of the whole volumetric data partitioning.

Definition at line 171 of file VolumeSegment.hpp.

IntensityVolume

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

typedef SegmentIntensityVolumeType LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::IntensityVolume

Reflects the type to use for storing the intensity volume of a single partition.

Definition at line 176 of file VolumeSegment.hpp.

NormalsVolume

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

typedef SegmentNormalsVolumeType LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::NormalsVolume

Reflects the type to use for storing the normal map of a single partition.

Definition at line 181 of file VolumeSegment.hpp.

Constructor & Destructor Documentation

VolumeSegment()

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::VolumeSegment

(

Grid &

grid

)

Instantiates.

Parameters

grid	references the volumetric data partitioning this partition belongs to.

Definition at line 232 of file VolumeSegment.hpp.

Member Function Documentation

hasIntensities()

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

bool LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::hasIntensities

(

)

const

Tells whether this partition has intensity volume data associated.

Definition at line 263 of file VolumeSegment.hpp.

intensities() [1/2]

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

SegmentIntensityVolumeType & LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::intensities

(

)

References the intensity volume data of this partition.

Precondition

hasIntensities() == true

Definition at line 247 of file VolumeSegment.hpp.

intensities() [2/2]

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

const SegmentIntensityVolumeType & LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::intensities

(

)

const

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

Definition at line 255 of file VolumeSegment.hpp.

setIntensities()

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

void LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::setIntensities

(

Association< SegmentIntensityVolumeType > *

intensities

)

Sets the intensity volume data of this partition.

Definition at line 240 of file VolumeSegment.hpp.

Member Data Documentation

grid

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

Grid& LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::grid

References the volumetric data partitioning this partition belongs to.

Definition at line 187 of file VolumeSegment.hpp.

offset

template<typename SegmentIntensityVolumeType , typename SegmentNormalsVolumeType >

math::Vector3ui LibCarna::base::VolumeSegment< SegmentIntensityVolumeType, SegmentNormalsVolumeType >::offset

Holds the coordinate offset this partition within the whole volumetric data partitioning.

Definition at line 222 of file VolumeSegment.hpp.

---

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

• include/LibCarna/base/VolumeSegment.hpp