This class comprises some attributes that are common for a CSO and a CSOGroup. More...

#include <CSOAttributes.h>

Public Member Functions
	CSOAttributes ()

	~CSOAttributes ()
	Destructor.

void	reset ()
	Sets default values to all members.

bool	writeToStream (std::ostream &outStream, bool asBinary) const
	Writes the attribute values to the specified stream.

bool	readFromStream (std::istream &inStream, bool asBinary, short version)
	Reads the attribute values from the specified stream.

bool	saveTo (std::ostream &outStream) const
	Saves attributes to specified stream and returns whether the saving was successful.

bool	saveToASCII (std::ostream &outStream) const
	Saves attributes to specified stream in ASCII format. Returns whether saving was successful.

void	loadFrom (std::istream &inStream, short version, bool swapBytes)
	Loads attributes from specified file stream.

void	loadFromASCII (std::istream &inStream, short version)
	Loads attributes from specified file stream in ASCII format.

void	setCSO (CSO *cso)
	Sets a pointer to the associated CSO.

void	setCSOGroup (CSOGroup *group)
	Sets a pointer to the associated CSOGroup.

Methods setting / reading out the user data values.
void	setUserData (const std::string &name, Variant value)

Variant	getUserData (const std::string &name) const
	Returns the user data under the specified name or an invalid value if the entry does not exist.

void	getUserDataNames (std::vector< std::string > &names) const
	Fills the specified vector with the keys/name under which user data are stored for this CSO.

void	removeUserData (const std::string &name)
	Removes a user data entry.

Public Attributes
std::string	label
	Label string for this contour.

std::string	description
	Description string for this contour.

int	timePointIndex
	The time point index of this contour.

bool	showState
	Should this CSO or CSOGroup be shown?

bool	voxelizeState
	Should this CSO or CSOGroup be voxelized?

bool	editableState
	Should this CSO or CSOGroup be editable?

Vector3	pathPointColor
	The color of this CSO or CSOGroup.

float	pathPointAlpha
	The alpha value of this CSO or CSOGroup.

int	pathPointStyle
	The line style of this CSO or CSOGroup.

float	pathPointWidth
	The line width of this CSO or CSOGroup.

int	seedPointStyle
	The marker mode.

float	seedPointSize
	The marker's size.

Vector3	seedPointColor
	The marker's color.

float	seedPointAlpha
	The marker's alpha value.

int	voxelWriteMode
	The write mode for voxel values.

float	voxelWriteValue
	The target voxel value.

Detailed Description

This class comprises some attributes that are common for a CSO and a CSOGroup.

Definition at line 126 of file CSOAttributes.h.

Constructor & Destructor Documentation

◆ CSOAttributes()

ml::CSOAttributes::CSOAttributes ( )

◆ ~CSOAttributes()

ml::CSOAttributes::~CSOAttributes ( )

Destructor.

Member Function Documentation

◆ getUserData()

Variant ml::CSOAttributes::getUserData ( const std::string & name ) const

Returns the user data under the specified name or an invalid value if the entry does not exist.

◆ getUserDataNames()

void ml::CSOAttributes::getUserDataNames ( std::vector< std::string > & names ) const

Fills the specified vector with the keys/name under which user data are stored for this CSO.

◆ loadFrom()

void ml::CSOAttributes::loadFrom	(	std::istream &	inStream,
		short	version,
		bool	swapBytes
	)

Loads attributes from specified file stream.

◆ loadFromASCII()

void ml::CSOAttributes::loadFromASCII	(	std::istream &	inStream,
		short	version
	)

Loads attributes from specified file stream in ASCII format.

◆ readFromStream()

bool ml::CSOAttributes::readFromStream	(	std::istream &	inStream,
		bool	asBinary,
		short	version
	)

Reads the attribute values from the specified stream.

◆ removeUserData()

void ml::CSOAttributes::removeUserData ( const std::string & name )

Removes a user data entry.

◆ reset()

void ml::CSOAttributes::reset ( )

Sets default values to all members.

◆ saveTo()

bool ml::CSOAttributes::saveTo ( std::ostream & outStream ) const

Saves attributes to specified stream and returns whether the saving was successful.

◆ saveToASCII()

bool ml::CSOAttributes::saveToASCII ( std::ostream & outStream ) const

Saves attributes to specified stream in ASCII format. Returns whether saving was successful.

◆ setCSO()

void ml::CSOAttributes::setCSO ( CSO * cso )

Sets a pointer to the associated CSO.

◆ setCSOGroup()

void ml::CSOAttributes::setCSOGroup ( CSOGroup * group )

Sets a pointer to the associated CSOGroup.

◆ setUserData()

void ml::CSOAttributes::setUserData	(	const std::string &	name,
		Variant	value
	)

Sets or adds a user data value under the specified name.

◆ writeToStream()

bool ml::CSOAttributes::writeToStream	(	std::ostream &	outStream,
		bool	asBinary
	)		const

Writes the attribute values to the specified stream.

Member Data Documentation

◆ description

std::string ml::CSOAttributes::description

Description string for this contour.

Definition at line 162 of file CSOAttributes.h.

◆ editableState

bool ml::CSOAttributes::editableState

Should this CSO or CSOGroup be editable?

Definition at line 171 of file CSOAttributes.h.

◆ label

std::string ml::CSOAttributes::label

Label string for this contour.

Definition at line 160 of file CSOAttributes.h.

◆ pathPointAlpha

float ml::CSOAttributes::pathPointAlpha

The alpha value of this CSO or CSOGroup.

Definition at line 176 of file CSOAttributes.h.

◆ pathPointColor

Vector3 ml::CSOAttributes::pathPointColor

The color of this CSO or CSOGroup.

Definition at line 174 of file CSOAttributes.h.

◆ pathPointStyle

int ml::CSOAttributes::pathPointStyle

The line style of this CSO or CSOGroup.

Definition at line 178 of file CSOAttributes.h.

◆ pathPointWidth

float ml::CSOAttributes::pathPointWidth

The line width of this CSO or CSOGroup.

Definition at line 180 of file CSOAttributes.h.

◆ seedPointAlpha

float ml::CSOAttributes::seedPointAlpha

The marker's alpha value.

Definition at line 189 of file CSOAttributes.h.

◆ seedPointColor

Vector3 ml::CSOAttributes::seedPointColor

The marker's color.

Definition at line 187 of file CSOAttributes.h.

◆ seedPointSize

float ml::CSOAttributes::seedPointSize

The marker's size.

Definition at line 185 of file CSOAttributes.h.

◆ seedPointStyle

int ml::CSOAttributes::seedPointStyle

The marker mode.

Definition at line 183 of file CSOAttributes.h.

◆ showState

bool ml::CSOAttributes::showState

Should this CSO or CSOGroup be shown?

Definition at line 167 of file CSOAttributes.h.

◆ timePointIndex

int ml::CSOAttributes::timePointIndex

The time point index of this contour.

Definition at line 165 of file CSOAttributes.h.

◆ voxelizeState

bool ml::CSOAttributes::voxelizeState

Should this CSO or CSOGroup be voxelized?

Definition at line 169 of file CSOAttributes.h.

◆ voxelWriteMode

int ml::CSOAttributes::voxelWriteMode

The write mode for voxel values.

Definition at line 192 of file CSOAttributes.h.

◆ voxelWriteValue

float ml::CSOAttributes::voxelWriteValue

The target voxel value.

Definition at line 194 of file CSOAttributes.h.

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

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

Public Member Functions

Public Attributes