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

#include <CSOPathPoints.h>

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 specified `index`.

const Vector4 &	getPosValueAt (unsigned int index) const
	Returns a position with a value at a specified `index`.

Vector3	getPosAt (unsigned int index) const
	Returns a position at a specified index `index`.

void	getPosAt (unsigned int index, Vector3 &pos)
	Variants of getPosAt for use in templates.

void	getPosAt (unsigned int index, Vector4 &pos)

void	setAllValuesTo (float value)
	Sets all posValues to the specified 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 specified index.

void	setPosValueAt (const Vector4 &posVal, unsigned int index)
	Sets a position/value pair at the specified index.

void	setPosAt (const Vector3 &pos, unsigned int index)
	Sets the specified position at the specified index.

void	clearPositions ()
	Clears internal world positions.

double	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 specified 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 specified range.

void	getPositionValues (std::vector< Vector4 > &posValues) const
	Fills the specified vector with all position/value pairs.

void	getWorldPositions (std::vector< Vector3 > &positions) const
	Fills the specified vector with all the internal positions.

void	setPositionValues (const std::vector< Vector4 > &newPosValues)
	Sets the position/value pairs from the specified vector.

void	setWorldPositions (const std::vector< Vector3 > &newPositions)
	Sets the coordinates from the specified vector as the PathPoints world positions.

const CSOBoundingBox &	getWorldBoundingBox ()
	Returns the world bounding box for this PathPoints.

CSOBoundingBox	getVoxelBoundingBox (const Matrix4 &worldToVoxelMatrix, size_t hashKey)
	Returns the voxel bounding box for this PathPoints.

void	pathChanged ()
	Invalidates the world and voxel bounding boxes, so they are computed anew.

Public Attributes
CSOSeedPoint *	headSeedPoint
	A pointer to this path's head seed point.

CSOSeedPoint *	tailSeedPoint
	A pointer to this path's tail seed point.

Detailed Description

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

Definition at line 36 of file CSOPathPoints.h.

Constructor & Destructor Documentation

◆ CSOPathPoints() [1/2]

ml::CSOPathPoints::CSOPathPoints ( )

Standard constructor.

◆ CSOPathPoints() [2/2]

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

Copy constructor.

◆ ~CSOPathPoints()

virtual ml::CSOPathPoints::~CSOPathPoints ( )

virtual

Standard destructor.

Member Function Documentation

◆ appendPosition()

void ml::CSOPathPoints::appendPosition ( const Vector3 & pos )

inline

Adds a new position to the internal vector.

Definition at line 49 of file CSOPathPoints.h.

Referenced by ml::CSOReadValueFromStream< CSOPathPoints >().

◆ clearPositions()

void ml::CSOPathPoints::clearPositions ( )

inline

Clears internal world positions.

Definition at line 85 of file CSOPathPoints.h.

◆ getLength()

double ml::CSOPathPoints::getLength ( ) const

Returns the length of this path point list.

◆ getPosAt() [1/3]

Vector3 ml::CSOPathPoints::getPosAt ( unsigned int index ) const

inline

Returns a position at a specified index index.

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

Definition at line 61 of file CSOPathPoints.h.

Referenced by ml::CSOWriteValueToStream< CSOPathPoints >().

◆ getPosAt() [2/3]

void ml::CSOPathPoints::getPosAt	(	unsigned int	index,
		Vector3 &	pos
	)

inline

Variants of getPosAt for use in templates.

Definition at line 68 of file CSOPathPoints.h.

References getPosAt().

Referenced by getPosAt().

◆ getPosAt() [3/3]

void ml::CSOPathPoints::getPosAt	(	unsigned int	index,
		Vector4 &	pos
	)

inline

Definition at line 69 of file CSOPathPoints.h.

◆ getPositionValues()

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

Fills the specified vector with all position/value pairs.

◆ getPosValueAt()

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

inline

Returns a position with a value at a specified index.

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

Definition at line 58 of file CSOPathPoints.h.

◆ getValueAt()

float ml::CSOPathPoints::getValueAt ( unsigned int index ) const

inline

Returns a value at a specified index.

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

Definition at line 55 of file CSOPathPoints.h.

◆ getVoxelBoundingBox()

CSOBoundingBox ml::CSOPathPoints::getVoxelBoundingBox	(	const Matrix4 &	worldToVoxelMatrix,
		size_t	hashKey
	)

Returns the voxel bounding box for this PathPoints.

◆ getWorldBoundingBox()

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

Returns the world bounding box for this PathPoints.

◆ getWorldPositions()

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

Fills the specified vector with all the internal positions.

◆ movePathPoints()

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

Moves all the path points by the specified offset.

◆ numPathPoints()

unsigned int ml::CSOPathPoints::numPathPoints ( ) const

inline

Returns the number of stored points.

Definition at line 52 of file CSOPathPoints.h.

Referenced by ml::CSOWriteValueToStream< CSOPathPoints >().

◆ pathChanged()

void ml::CSOPathPoints::pathChanged ( )

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

◆ removePositions() [1/2]

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.).

◆ removePositions() [2/2]

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

Removes positions from the internal vector in the specified range.

◆ setAllValuesTo() [1/2]

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

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

◆ setAllValuesTo() [2/2]

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

Sets all posValues to the specified value.

◆ setPosAt()

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

Sets the specified position at the specified index.

◆ setPositionValues()

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

Sets the position/value pairs from the specified vector.

◆ setPosValueAt()

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

Sets a position/value pair at the specified index.

◆ setValueAt()

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

Sets a value at the specified index.

◆ setWorldPositions()

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

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

Member Data Documentation

◆ headSeedPoint

CSOSeedPoint* ml::CSOPathPoints::headSeedPoint

A pointer to this path's head seed point.

Definition at line 118 of file CSOPathPoints.h.

◆ tailSeedPoint

CSOSeedPoint* ml::CSOPathPoints::tailSeedPoint

A pointer to this path's tail seed point.

Definition at line 120 of file CSOPathPoints.h.

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

MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOPathPoints.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CSOPathPoints() [1/2]

◆ CSOPathPoints() [2/2]

◆ ~CSOPathPoints()

Member Function Documentation

◆ appendPosition()

◆ clearPositions()

◆ getLength()

◆ getPosAt() [1/3]

◆ getPosAt() [2/3]

◆ getPosAt() [3/3]

◆ getPositionValues()

◆ getPosValueAt()

◆ getValueAt()

◆ getVoxelBoundingBox()

◆ getWorldBoundingBox()

◆ getWorldPositions()

◆ movePathPoints()

◆ numPathPoints()

◆ pathChanged()

◆ removePositions() [1/2]

◆ removePositions() [2/2]

◆ setAllValuesTo() [1/2]

◆ setAllValuesTo() [2/2]

◆ setPosAt()

◆ setPositionValues()

◆ setPosValueAt()

◆ setValueAt()

◆ setWorldPositions()

Member Data Documentation

◆ headSeedPoint

◆ tailSeedPoint