MeVisLabToolboxReference
ml::CSOPathPoints Class Reference

The CSOPathPoints is a list of world coordinates which are interpolated by a certain interpolation scheme between seed points of a CSO. More...

#include <CSOPathPoints.h>

List of all members.

Public Member Functions

 CSOPathPoints ()
 Standard constructor.
 CSOPathPoints (const CSOPathPoints &pathPoints)
 Copy constructor.
virtual ~CSOPathPoints ()
 Standard destructor.
void appendPosition (const Vector3 &pos)
 Adds a new position to the internal vector.
unsigned int numPathPoints () const
 Returns the number of stored points.
float getValueAt (unsigned int index) const
 Returns a value at a given index.
const Vector4getPosValueAt (unsigned int index) const
 Returns a positions with a value at a given index.
Vector3 getPosAt (unsigned int index) const
 Returns a position at a given index index.
void setAllValuesTo (float value)
 Sets all posValues to the given value.
void setAllValuesTo (float startVal, float endVal)
 Sets all posValues from first pos:startVal to last pos-:endVal.
void setValueAt (const float value, unsigned int index)
 Sets a value at the given index.
void setPosValueAt (const Vector4 &posVal, unsigned int index)
 Sets a position/value pair at the given index.
void setPosAt (const Vector3 &pos, unsigned int index)
 Sets the given position at the given index.
void clearPositions ()
 Clears internal world positions.
float getLength () const
 Returns the length of this path point list.
void movePathPoints (double x, double y, double z)
 Moves all the path points by the given offset.
void removePositions ()
 Removes all positions from the internal vector and marks this path point list as being changed (for bounding box computations etc.).
void removePositions (unsigned int startIndex, unsigned int endIndex)
 Removes positions from the internal vector in the given range.
void getPositionValues (std::vector< Vector4 > &posValues) const
 Fills the given vector with all position/value pairs.
void getWorldPositions (std::vector< Vector3 > &positions) const
 Fills the given vector with all the internal positions.
void setPositionValues (const std::vector< Vector4 > &newPosValues)
 Sets the position/value pairs from the given vector.
void setWorldPositions (const std::vector< Vector3 > &newPositions)
 Sets the coordinates from the given vector as the PathPoints world positions.
const CSOBoundingBoxgetWorldBoundingBox ()
 Returns the world bounding box for this PathPoints.
const CSOBoundingBoxgetVoxelBoundingBox (const Matrix4 &worldToVoxelMatrix)
 Returns the voxel bounding box for this PathPoints.
void invalidateBoundingBoxes ()
 Invalidates the world and voxel bounding boxes, so they are computed anew.

Public Attributes

CSOSeedPointheadSeedPoint
 A pointer to this path's head seed point.
CSOSeedPointtailSeedPoint
 A pointer to this path's tail seed point.

Detailed Description

The CSOPathPoints is a list of world coordinates which are interpolated by a certain interpolation scheme between seed points of a CSO.

Definition at line 31 of file CSOPathPoints.h.


Constructor & Destructor Documentation

ml::CSOPathPoints::CSOPathPoints ( )

Standard constructor.

ml::CSOPathPoints::CSOPathPoints ( const CSOPathPoints pathPoints)

Copy constructor.

virtual ml::CSOPathPoints::~CSOPathPoints ( ) [virtual]

Standard destructor.


Member Function Documentation

void ml::CSOPathPoints::appendPosition ( const Vector3 pos) [inline]

Adds a new position to the internal vector.

Definition at line 44 of file CSOPathPoints.h.

void ml::CSOPathPoints::clearPositions ( ) [inline]

Clears internal world positions.

Definition at line 76 of file CSOPathPoints.h.

float ml::CSOPathPoints::getLength ( ) const

Returns the length of this path point list.

Vector3 ml::CSOPathPoints::getPosAt ( unsigned int  index) const [inline]

Returns a position at a given index index.

For performance reasons this function does not check if the index is valid.

Definition at line 56 of file CSOPathPoints.h.

void ml::CSOPathPoints::getPositionValues ( std::vector< Vector4 > &  posValues) const

Fills the given vector with all position/value pairs.

const Vector4& ml::CSOPathPoints::getPosValueAt ( unsigned int  index) const [inline]

Returns a positions with a value at a given index.

For performance reasons this function does not check if the index is valid.

Definition at line 53 of file CSOPathPoints.h.

float ml::CSOPathPoints::getValueAt ( unsigned int  index) const [inline]

Returns a value at a given index.

For performance reasons this function does not check if the index is valid.

Definition at line 50 of file CSOPathPoints.h.

const CSOBoundingBox& ml::CSOPathPoints::getVoxelBoundingBox ( const Matrix4 worldToVoxelMatrix)

Returns the voxel bounding box for this PathPoints.

const CSOBoundingBox& ml::CSOPathPoints::getWorldBoundingBox ( )

Returns the world bounding box for this PathPoints.

void ml::CSOPathPoints::getWorldPositions ( std::vector< Vector3 > &  positions) const

Fills the given vector with all the internal positions.

void ml::CSOPathPoints::invalidateBoundingBoxes ( ) [inline]

Invalidates the world and voxel bounding boxes, so they are computed anew.

Definition at line 106 of file CSOPathPoints.h.

void ml::CSOPathPoints::movePathPoints ( double  x,
double  y,
double  z 
)

Moves all the path points by the given offset.

unsigned int ml::CSOPathPoints::numPathPoints ( ) const [inline]

Returns the number of stored points.

Definition at line 47 of file CSOPathPoints.h.

void ml::CSOPathPoints::removePositions ( unsigned int  startIndex,
unsigned int  endIndex 
)

Removes positions from the internal vector in the given range.

void ml::CSOPathPoints::removePositions ( )

Removes all positions from the internal vector and marks this path point list as being changed (for bounding box computations etc.).

void ml::CSOPathPoints::setAllValuesTo ( float  startVal,
float  endVal 
)

Sets all posValues from first pos:startVal to last pos-:endVal.

void ml::CSOPathPoints::setAllValuesTo ( float  value)

Sets all posValues to the given value.

void ml::CSOPathPoints::setPosAt ( const Vector3 pos,
unsigned int  index 
)

Sets the given position at the given index.

void ml::CSOPathPoints::setPositionValues ( const std::vector< Vector4 > &  newPosValues)

Sets the position/value pairs from the given vector.

void ml::CSOPathPoints::setPosValueAt ( const Vector4 posVal,
unsigned int  index 
)

Sets a position/value pair at the given index.

void ml::CSOPathPoints::setValueAt ( const float  value,
unsigned int  index 
)

Sets a value at the given index.

void ml::CSOPathPoints::setWorldPositions ( const std::vector< Vector3 > &  newPositions)

Sets the coordinates from the given vector as the PathPoints world positions.


Member Data Documentation

A pointer to this path's head seed point.

Definition at line 109 of file CSOPathPoints.h.

A pointer to this path's tail seed point.

Definition at line 111 of file CSOPathPoints.h.


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