MeVisLab Toolbox Reference
|
A CSOGroup comprises a number of CSOs, which themselves can be in a number of different CSOGroups. More...
#include <CSOGroup.h>
Public Member Functions | |
CSOGroup () | |
Constructor. More... | |
CSOGroup (CSOList *csoList) | |
Constructor, takes a pointer to the embracing CSOList as an argument. More... | |
CSOGroup (const CSOGroup &group, int groupId=-1, CSOList *csoList=nullptr) | |
Copy constructor. More... | |
~CSOGroup () | |
Destructor. More... | |
CSOGroupRules & | getRules () |
Return the rules for this CSOGroup. More... | |
bool | isSelected () const |
Returns whether this group is selected in its enclosing CSOList. More... | |
void | groupChanged () |
Marks this Group as changed (e.g. if a CSO has been added, removed or changed). More... | |
bool | saveAttributes (std::ostream &outStream, bool useAscii=false) |
Save attributes to stream and returns whether the saving was successful. More... | |
void | loadAttributes (std::istream &inStream, short version, bool swapBytes, bool useAscii=false) |
Load attributes from stream. More... | |
Methods concerning member CSOs. | |
bool | addCSO (CSO &cso, bool useUndoRedo=true) |
void | removeCSO (CSO &cso, bool useUndoRedo=true) |
removes given CSO from this group More... | |
void | removeAllCSO (bool useUndoRedo=true, bool shouldApplyRemoveFromGroupRule=true) |
Removes all CSOs from this group. More... | |
bool | contains (const CSO *cso) const |
Returns if this group contains the given CSO. More... | |
unsigned int | numCSOs () const |
Returns the number of CSOs in this group. More... | |
CSO * | getCSOAt (unsigned int index) const |
Returns a pointer to the CSO at the given index. Beware: no index check. More... | |
unsigned int | getCSOIdAt (unsigned int index) const |
Returns the id of an associated CSO at the given index. Beware: no index check. More... | |
MLCSO-internal Methods concerning member CSOs. | |
void | _addReferenceToCSO (const CSO &cso) |
void | _removeReferenceToCSO (const CSO &cso) |
Removes a reference to a CSO from this group. More... | |
Maintenance methods. | |
unsigned int | getId () const |
void | setId (unsigned int id) |
Sets the Id of this group. More... | |
void | setCSOList (CSOList *csoList) |
Sets the embracing CSOList for this Group. More... | |
CSOList * | getCSOList () const |
Returns a pointer to the embracing CSOList of this Group. More... | |
Methods for getting / setting attributes. | |
void | setLabel (const std::string &label) |
const std::string & | getLabel () const |
Returns the group label. More... | |
void | setDescription (const std::string &description) |
Sets the group description. More... | |
const std::string & | getDescription () const |
Returns the group description. More... | |
int | getTimePointIndex () const |
Returns the time point index of this group. More... | |
void | setTimePointIndex (MLint timePointIndex) |
Sets the time point index of this group. More... | |
void | setShowState (bool state) |
Sets the 'show' status of this Group. More... | |
bool | getShowState () const |
Returns the 'show' status of this Group. More... | |
void | setVoxelizeState (bool state) |
Sets the 'voxelize' status of this Group. More... | |
bool | getVoxelizeState () const |
Returns the 'voxelize' status of this Group. More... | |
void | setEditableState (bool state) |
Sets the 'editable' status of this Group. More... | |
bool | getEditableState () const |
Returns the 'editable' status of this Group. More... | |
CSOPathPointsStyle | getPathPointStyle () const |
Returns the path point style. More... | |
void | setPathPointStyle (CSOPathPointsStyle style) |
Sets the path point style. More... | |
void | setPathPointStyle (int style) |
Sets the path point style as an int. More... | |
float | getPathPointWidth () const |
Returns the width of the path points. More... | |
void | setPathPointWidth (float width) |
Sets the width of the path points. More... | |
const Vector3 & | getPathPointColor () const |
Returns the color of the path points. More... | |
void | setPathPointColor (const Vector3 &color) |
Sets the color of the path points. More... | |
float | getPathPointAlpha () const |
Returns the alpha value of the path points. More... | |
void | setPathPointAlpha (float alpha) |
Sets the alpha value of the path points. More... | |
int | getSeedPointStyle () const |
Returns the style of the seed points. More... | |
void | setSeedPointStyle (int seedPointStyle) |
Sets the style of the seed points. More... | |
float | getSeedPointSize () const |
Returns the size of the seed points. More... | |
void | setSeedPointSize (float size) |
Sets the size of the seed points. More... | |
const Vector3 & | getSeedPointColor () const |
Returns the color of the seed points. More... | |
void | setSeedPointColor (const Vector3 &color) |
Sets the color of the seed points. More... | |
float | getSeedPointAlpha () const |
Returns the alpha value of the seed points. More... | |
void | setSeedPointAlpha (float alpha) |
Sets the alpha value of the seed points. More... | |
int | getVoxelWriteMode () const |
Returns the voxel write mode of this Group. More... | |
void | setVoxelWriteMode (int mode) |
Sets the voxel write mode of this Group. More... | |
float | getVoxelWriteValue () const |
Returns the voxel write value of this Group. More... | |
void | setVoxelWriteValue (float value) |
Sets the voxel write value of this Group. 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... | |
Methods for getting / setting the use of attributes. | |
bool | getUseTimePointIndex () const |
void | setUseTimePointIndex (bool state) |
Sets whether the time point index of this Group should be used. More... | |
bool | getUseShowState () const |
Returns if this Group overrides the show state of its CSOs. More... | |
void | setUseShowState (bool state) |
Sets whether this Group overrides the show state of its CSOs. More... | |
bool | getUseVoxelizeState () const |
Returns whether this Group overrides the voxelize state of its CSOs. More... | |
void | setUseVoxelizeState (bool state) |
Sets whether this Group overrides the voxelize state of its CSOs. More... | |
bool | getUseEditableState () const |
Returns whether this Group overrides the editable state of its CSOs. More... | |
void | setUseEditableState (bool state) |
Sets whether this Group overrides the editable state of its CSOs. More... | |
bool | getUseSeedPointStyle () const |
Returns whether this Group overrides the seed point style of its CSOs. More... | |
void | setUseSeedPointStyle (bool state) |
Sets whether this Group overrides the seed point style of its CSOs. More... | |
bool | getUseSeedPointSize () const |
Returns whether this Group overrides the seed point size of its CSOs. More... | |
void | setUseSeedPointSize (bool state) |
Sets whether this Group overrides the seed point size of its CSOs. More... | |
bool | getUseSeedPointColor () const |
Returns whether this Group overrides the seed point color of its CSOs. More... | |
void | setUseSeedPointColor (bool state) |
Sets whether this Group overrides the seed point color of its CSOs. More... | |
bool | getUseSeedPointAlpha () const |
Returns whether this Group overrides the seed point alpha of its CSOs. More... | |
void | setUseSeedPointAlpha (bool state) |
Sets whether this Group overrides the seed point alpha of its CSOs. More... | |
bool | getUsePathPointStyle () const |
Returns whether this Group overrides the path point style of its CSOs. More... | |
void | setUsePathPointStyle (bool state) |
Sets whether this Group overrides the path point style of its CSOs. More... | |
bool | getUsePathPointWidth () const |
Returns whether this Group overrides the path point width of its CSOs. More... | |
void | setUsePathPointWidth (bool state) |
Sets whether this Group overrides the path point width of its CSOs. More... | |
bool | getUsePathPointColor () const |
Returns whether this Group overrides the path point color of its CSOs. More... | |
void | setUsePathPointColor (bool state) |
Sets whether this Group overrides the path point color of its CSOs. More... | |
bool | getUsePathPointAlpha () const |
Returns whether this Group overrides the path point alpha of its CSOs. More... | |
void | setUsePathPointAlpha (bool state) |
Sets whether this Group overrides the path point alpha of its CSOs. More... | |
bool | getUseVoxelWriteMode () const |
Returns whether this Group overrides the voxel write mode of its CSOs. More... | |
void | setUseVoxelWriteMode (bool state) |
Sets whether this Group overrides the voxel write mode of its CSOs. More... | |
bool | getUseVoxelWriteValue () const |
Returns whether this Group overrides the voxel write value of its CSOs. More... | |
void | setUseVoxelWriteValue (bool state) |
Sets whether this Group overrides the voxel write value of its CSOs. More... | |
Methods for handling the bounding box. | |
const CSOBoundingBox & | getBoundingBox () |
CSOBoundingBox | getVoxelBoundingBox (const Matrix4 &worldToVoxelMatrix, size_t hashKey) |
Returns the unified voxel bounding box of all contained CSOs. More... | |
Friends | |
class | CSOList |
A CSOGroup comprises a number of CSOs, which themselves can be in a number of different CSOGroups.
Some visualization parameters can be controlled by a CSOGroup, and some processing modules can apply special functions for groups only.
Definition at line 37 of file CSOGroup.h.
ml::CSOGroup::CSOGroup | ( | ) |
Constructor.
ml::CSOGroup::CSOGroup | ( | CSOList * | csoList | ) |
Constructor, takes a pointer to the embracing CSOList as an argument.
Copy constructor.
ml::CSOGroup::~CSOGroup | ( | ) |
Destructor.
void ml::CSOGroup::_removeReferenceToCSO | ( | const CSO & | cso | ) |
Removes a reference to a CSO from this group.
bool ml::CSOGroup::addCSO | ( | CSO & | cso, |
bool | useUndoRedo = true |
||
) |
adds given CSO to this group Returns whether the operation was successful.
const CSOBoundingBox& ml::CSOGroup::getBoundingBox | ( | ) |
Returns the unified bounding box of all contained CSOs.
CSO* ml::CSOGroup::getCSOAt | ( | unsigned int | index | ) | const |
Returns a pointer to the CSO at the given index. Beware: no index check.
|
inline |
Returns the id of an associated CSO at the given index. Beware: no index check.
Definition at line 75 of file CSOGroup.h.
|
inline |
Returns a pointer to the embracing CSOList of this Group.
Definition at line 101 of file CSOGroup.h.
|
inline |
Returns the group description.
Definition at line 119 of file CSOGroup.h.
|
inline |
Returns the 'editable' status of this Group.
Definition at line 136 of file CSOGroup.h.
|
inline |
Returns the Id of this group.
Definition at line 93 of file CSOGroup.h.
|
inline |
Returns the group label.
Definition at line 115 of file CSOGroup.h.
|
inline |
Returns the alpha value of the path points.
Definition at line 152 of file CSOGroup.h.
|
inline |
Returns the color of the path points.
Definition at line 148 of file CSOGroup.h.
|
inline |
Returns the path point style.
Definition at line 138 of file CSOGroup.h.
|
inline |
Returns the width of the path points.
Definition at line 144 of file CSOGroup.h.
|
inline |
Return the rules for this CSOGroup.
Definition at line 55 of file CSOGroup.h.
|
inline |
Returns the alpha value of the seed points.
Definition at line 168 of file CSOGroup.h.
|
inline |
Returns the color of the seed points.
Definition at line 164 of file CSOGroup.h.
|
inline |
Returns the size of the seed points.
Definition at line 160 of file CSOGroup.h.
|
inline |
Returns the style of the seed points.
Definition at line 156 of file CSOGroup.h.
|
inline |
Returns the 'show' status of this Group.
Definition at line 128 of file CSOGroup.h.
|
inline |
Returns the time point index of this group.
Definition at line 122 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the editable state of its CSOs.
Definition at line 212 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the path point alpha of its CSOs.
Definition at line 244 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the path point color of its CSOs.
Definition at line 240 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the path point style of its CSOs.
Definition at line 232 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the path point width of its CSOs.
Definition at line 236 of file CSOGroup.h.
|
inline |
Returns the user data under the given name or an invalid value if the entry does not exist.
Definition at line 188 of file CSOGroup.h.
|
inline |
Fills the given vector with the keys/name under which user data are stored for this CSO.
Definition at line 190 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the seed point alpha of its CSOs.
Definition at line 228 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the seed point color of its CSOs.
Definition at line 224 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the seed point size of its CSOs.
Definition at line 220 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the seed point style of its CSOs.
Definition at line 216 of file CSOGroup.h.
|
inline |
Returns if this Group overrides the show state of its CSOs.
Definition at line 204 of file CSOGroup.h.
|
inline |
Returns if the time point index of this Group should be used.
Definition at line 200 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the voxelize state of its CSOs.
Definition at line 208 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the voxel write mode of its CSOs.
Definition at line 248 of file CSOGroup.h.
|
inline |
Returns whether this Group overrides the voxel write value of its CSOs.
Definition at line 252 of file CSOGroup.h.
CSOBoundingBox ml::CSOGroup::getVoxelBoundingBox | ( | const Matrix4 & | worldToVoxelMatrix, |
size_t | hashKey | ||
) |
Returns the unified voxel bounding box of all contained CSOs.
|
inline |
Returns the 'voxelize' status of this Group.
Definition at line 132 of file CSOGroup.h.
|
inline |
Returns the voxel write mode of this Group.
Definition at line 172 of file CSOGroup.h.
|
inline |
Returns the voxel write value of this Group.
Definition at line 176 of file CSOGroup.h.
void ml::CSOGroup::groupChanged | ( | ) |
Marks this Group as changed (e.g. if a CSO has been added, removed or changed).
bool ml::CSOGroup::isSelected | ( | ) | const |
void ml::CSOGroup::loadAttributes | ( | std::istream & | inStream, |
short | version, | ||
bool | swapBytes, | ||
bool | useAscii = false |
||
) |
Load attributes from stream.
|
inline |
Returns the number of CSOs in this group.
Definition at line 71 of file CSOGroup.h.
void ml::CSOGroup::removeAllCSO | ( | bool | useUndoRedo = true , |
bool | shouldApplyRemoveFromGroupRule = true |
||
) |
Removes all CSOs from this group.
void ml::CSOGroup::removeCSO | ( | CSO & | cso, |
bool | useUndoRedo = true |
||
) |
removes given CSO from this group
|
inline |
Removes a user data entry.
Definition at line 192 of file CSOGroup.h.
bool ml::CSOGroup::saveAttributes | ( | std::ostream & | outStream, |
bool | useAscii = false |
||
) |
Save attributes to stream and returns whether the saving was successful.
void ml::CSOGroup::setCSOList | ( | CSOList * | csoList | ) |
void ml::CSOGroup::setDescription | ( | const std::string & | description | ) |
Sets the group description.
void ml::CSOGroup::setEditableState | ( | bool | state | ) |
Sets the 'editable' status of this Group.
|
inline |
Sets the Id of this group.
Definition at line 95 of file CSOGroup.h.
void ml::CSOGroup::setLabel | ( | const std::string & | label | ) |
Sets the group label.
void ml::CSOGroup::setPathPointAlpha | ( | float | alpha | ) |
Sets the alpha value of the path points.
void ml::CSOGroup::setPathPointColor | ( | const Vector3 & | color | ) |
Sets the color of the path points.
void ml::CSOGroup::setPathPointStyle | ( | CSOPathPointsStyle | style | ) |
Sets the path point style.
|
inline |
Sets the path point style as an int.
Definition at line 142 of file CSOGroup.h.
References setPathPointStyle().
Referenced by setPathPointStyle().
void ml::CSOGroup::setPathPointWidth | ( | float | width | ) |
Sets the width of the path points.
void ml::CSOGroup::setSeedPointAlpha | ( | float | alpha | ) |
Sets the alpha value of the seed points.
void ml::CSOGroup::setSeedPointColor | ( | const Vector3 & | color | ) |
Sets the color of the seed points.
void ml::CSOGroup::setSeedPointSize | ( | float | size | ) |
Sets the size of the seed points.
void ml::CSOGroup::setSeedPointStyle | ( | int | seedPointStyle | ) |
Sets the style of the seed points.
void ml::CSOGroup::setShowState | ( | bool | state | ) |
Sets the 'show' status of this Group.
void ml::CSOGroup::setTimePointIndex | ( | MLint | timePointIndex | ) |
Sets the time point index of this group.
|
inline |
Sets whether this Group overrides the editable state of its CSOs.
Definition at line 214 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the path point alpha of its CSOs.
Definition at line 246 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the path point color of its CSOs.
Definition at line 242 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the path point style of its CSOs.
Definition at line 234 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the path point width of its CSOs.
Definition at line 238 of file CSOGroup.h.
|
inline |
Sets or adds a user data value under the given name.
Definition at line 186 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the seed point alpha of its CSOs.
Definition at line 230 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the seed point color of its CSOs.
Definition at line 226 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the seed point size of its CSOs.
Definition at line 222 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the seed point style of its CSOs.
Definition at line 218 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the show state of its CSOs.
Definition at line 206 of file CSOGroup.h.
|
inline |
Sets whether the time point index of this Group should be used.
Definition at line 202 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the voxelize state of its CSOs.
Definition at line 210 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the voxel write mode of its CSOs.
Definition at line 250 of file CSOGroup.h.
|
inline |
Sets whether this Group overrides the voxel write value of its CSOs.
Definition at line 254 of file CSOGroup.h.
void ml::CSOGroup::setVoxelizeState | ( | bool | state | ) |
Sets the 'voxelize' status of this Group.
void ml::CSOGroup::setVoxelWriteMode | ( | int | mode | ) |
Sets the voxel write mode of this Group.
void ml::CSOGroup::setVoxelWriteValue | ( | float | value | ) |
Sets the voxel write value of this Group.
|
friend |
Definition at line 41 of file CSOGroup.h.