MeVisLabToolboxReference
Public Member Functions | Public Attributes
ml::CSOAttributes Class Reference

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

#include <CSOAttributes.h>

List of all members.

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 given stream.
bool readFromStream (std::istream &inStream, bool asBinary, short version)
 Reads the attribute values from the given stream.
bool saveTo (std::ostream &outStream) const
 Saves attributes to given stream and returns whether the saving was successful.
bool saveToASCII (std::ostream &outStream) const
 Saves attributes to given stream in ASCII format. Returns whether saving was successful.
void loadFrom (std::istream &inStream, short version, bool swapBytes)
 Loads attributes from given file stream.
void loadFromASCII (std::istream &inStream, short version)
 Loads attributes from given 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)
 Sets or adds a user data value under the given name.
Variant getUserData (const std::string &name) const
 Returns the user data under the given name or an invalid value if the entry does not exist.
void getUserDataNames (std::vector< std::string > &names) const
 Fills the given 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 / Group be shown?
bool voxelizeState
 Should this CSO / Group be voxelized?
bool editableState
 Should this CSO / Group be editable?
Vector3 pathPointColor
 The color of this CSO/Group.
float pathPointAlpha
 The alpha value of this CSO/Group.
int pathPointStyle
 The line style of this CSO/Group.
float pathPointWidth
 The line width of this CSO/Group.
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 122 of file CSOAttributes.h.

Constructor & Destructor Documentation

ml::CSOAttributes::CSOAttributes ( )
ml::CSOAttributes::~CSOAttributes ( )

Destructor.

Member Function Documentation

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

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

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

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

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

Loads attributes from given file stream.

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

Loads attributes from given file stream in ASCII format.

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

Reads the attribute values from the given stream.

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

Removes a user data entry.

void ml::CSOAttributes::reset ( )

Sets default values to all members.

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

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

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

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

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

Sets a pointer to the associated CSO.

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

Sets a pointer to the associated CSOGroup.

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

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

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

Writes the attribute values to the given stream.

Member Data Documentation

std::string ml::CSOAttributes::description

Description string for this contour.

Definition at line 158 of file CSOAttributes.h.

bool ml::CSOAttributes::editableState

Should this CSO / Group be editable?

Definition at line 167 of file CSOAttributes.h.

std::string ml::CSOAttributes::label

Label string for this contour.

Definition at line 156 of file CSOAttributes.h.

float ml::CSOAttributes::pathPointAlpha

The alpha value of this CSO/Group.

Definition at line 172 of file CSOAttributes.h.

Vector3 ml::CSOAttributes::pathPointColor

The color of this CSO/Group.

Definition at line 170 of file CSOAttributes.h.

int ml::CSOAttributes::pathPointStyle

The line style of this CSO/Group.

Definition at line 174 of file CSOAttributes.h.

float ml::CSOAttributes::pathPointWidth

The line width of this CSO/Group.

Definition at line 176 of file CSOAttributes.h.

float ml::CSOAttributes::seedPointAlpha

The marker's alpha value.

Definition at line 185 of file CSOAttributes.h.

Vector3 ml::CSOAttributes::seedPointColor

The marker's color.

Definition at line 183 of file CSOAttributes.h.

float ml::CSOAttributes::seedPointSize

The marker's size.

Definition at line 181 of file CSOAttributes.h.

int ml::CSOAttributes::seedPointStyle

The marker mode.

Definition at line 179 of file CSOAttributes.h.

bool ml::CSOAttributes::showState

Should this CSO / Group be shown?

Definition at line 163 of file CSOAttributes.h.

int ml::CSOAttributes::timePointIndex

The time point index of this contour.

Definition at line 161 of file CSOAttributes.h.

bool ml::CSOAttributes::voxelizeState

Should this CSO / Group be voxelized?

Definition at line 165 of file CSOAttributes.h.

int ml::CSOAttributes::voxelWriteMode

The write mode for voxel values.

Definition at line 188 of file CSOAttributes.h.

float ml::CSOAttributes::voxelWriteValue

The target voxel value.

Definition at line 190 of file CSOAttributes.h.

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