MeVisLab Toolbox Reference
|
This class comprises some attributes that are common for a CSO and a CSOGroup. More...
#include <CSOAttributes.h>
Public Member Functions | |
CSOAttributes () | |
~CSOAttributes () | |
Destructor. More... | |
void | reset () |
Sets default values to all members. More... | |
bool | writeToStream (std::ostream &outStream, bool asBinary) const |
Writes the attribute values to the given stream. More... | |
bool | readFromStream (std::istream &inStream, bool asBinary, short version) |
Reads the attribute values from the given stream. More... | |
bool | saveTo (std::ostream &outStream) const |
Saves attributes to given stream and returns whether the saving was successful. More... | |
bool | saveToASCII (std::ostream &outStream) const |
Saves attributes to given stream in ASCII format. Returns whether saving was successful. More... | |
void | loadFrom (std::istream &inStream, short version, bool swapBytes) |
Loads attributes from given file stream. More... | |
void | loadFromASCII (std::istream &inStream, short version) |
Loads attributes from given file stream in ASCII format. More... | |
void | setCSO (CSO *cso) |
Sets a pointer to the associated CSO. More... | |
void | setCSOGroup (CSOGroup *group) |
Sets a pointer to the associated CSOGroup. More... | |
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 given name or an invalid value if the entry does not exist. More... | |
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. More... | |
void | removeUserData (const std::string &name) |
Removes a user data entry. More... | |
Public Attributes | |
std::string | label |
Label string for this contour. More... | |
std::string | description |
Description string for this contour. More... | |
int | timePointIndex |
The time point index of this contour. More... | |
bool | showState |
Should this CSO / Group be shown? More... | |
bool | voxelizeState |
Should this CSO / Group be voxelized? More... | |
bool | editableState |
Should this CSO / Group be editable? More... | |
Vector3 | pathPointColor |
The color of this CSO/Group. More... | |
float | pathPointAlpha |
The alpha value of this CSO/Group. More... | |
int | pathPointStyle |
The line style of this CSO/Group. More... | |
float | pathPointWidth |
The line width of this CSO/Group. More... | |
int | seedPointStyle |
The marker mode. More... | |
float | seedPointSize |
The marker's size. More... | |
Vector3 | seedPointColor |
The marker's color. More... | |
float | seedPointAlpha |
The marker's alpha value. More... | |
int | voxelWriteMode |
The write mode for voxel values. More... | |
float | voxelWriteValue |
The target voxel value. More... | |
This class comprises some attributes that are common for a CSO and a CSOGroup.
Definition at line 126 of file CSOAttributes.h.
ml::CSOAttributes::CSOAttributes | ( | ) |
ml::CSOAttributes::~CSOAttributes | ( | ) |
Destructor.
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::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.
std::string ml::CSOAttributes::description |
Description string for this contour.
Definition at line 162 of file CSOAttributes.h.
bool ml::CSOAttributes::editableState |
Should this CSO / Group be editable?
Definition at line 171 of file CSOAttributes.h.
std::string ml::CSOAttributes::label |
Label string for this contour.
Definition at line 160 of file CSOAttributes.h.
float ml::CSOAttributes::pathPointAlpha |
The alpha value of this CSO/Group.
Definition at line 176 of file CSOAttributes.h.
Vector3 ml::CSOAttributes::pathPointColor |
The color of this CSO/Group.
Definition at line 174 of file CSOAttributes.h.
int ml::CSOAttributes::pathPointStyle |
The line style of this CSO/Group.
Definition at line 178 of file CSOAttributes.h.
float ml::CSOAttributes::pathPointWidth |
The line width of this CSO/Group.
Definition at line 180 of file CSOAttributes.h.
float ml::CSOAttributes::seedPointAlpha |
The marker's alpha value.
Definition at line 189 of file CSOAttributes.h.
Vector3 ml::CSOAttributes::seedPointColor |
The marker's color.
Definition at line 187 of file CSOAttributes.h.
float ml::CSOAttributes::seedPointSize |
The marker's size.
Definition at line 185 of file CSOAttributes.h.
int ml::CSOAttributes::seedPointStyle |
The marker mode.
Definition at line 183 of file CSOAttributes.h.
bool ml::CSOAttributes::showState |
Should this CSO / Group be shown?
Definition at line 167 of file CSOAttributes.h.
int ml::CSOAttributes::timePointIndex |
The time point index of this contour.
Definition at line 165 of file CSOAttributes.h.
bool ml::CSOAttributes::voxelizeState |
Should this CSO / Group be voxelized?
Definition at line 169 of file CSOAttributes.h.
int ml::CSOAttributes::voxelWriteMode |
The write mode for voxel values.
Definition at line 192 of file CSOAttributes.h.
float ml::CSOAttributes::voxelWriteValue |
The target voxel value.
Definition at line 194 of file CSOAttributes.h.