ml::CSOGenerator Class Reference
The CSOGenerator is the base class for all modules that generate CSOs, be it automatically or interactive. More...
#include <CSOGenerator.h>
Public Member Functions | |
| CSOGenerator (std::string type="CSOGenerator", int numInImg=0, int numOutImg=0) | |
| Constructor. | |
| std::string | getType () |
| Returns the type of the CSOGenerator. | |
Static Public Attributes | |
| static const char * | addCSOToGroupModeStrings [3] |
| Strings for add to group mode enumerations. | |
Protected Member Functions | |
| CSO * | _addCSO (CSOList *csoList, std::string groupLabel, bool useUndoRedo=true) |
| Adds a new CSO to the CSOList and puts it into the group given by the label string. | |
| CSOGroup * | _getParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false) |
| Returns the parent group according to current group settings. | |
| void | _emptyGroupOnDemand (CSOList *csoList) |
| Empties a group on demand of the given CSOList with the set label. | |
| virtual | ~CSOGenerator () |
| Destructor. | |
Protected Attributes | |
| BoolField * | _emptyGroupBeforeGenerationFld |
| If checked and a group name is provided, the group is emptied before a new generation. | |
| EnumField * | _addCSOToGroupMode |
| Defines if the CSOs are added to a group and how the group is identified. | |
| StringField * | _addCSOToGroupWithLabelFld |
| This label defines the group the generator should add its created CSOs to. | |
| IntField * | _addCSOToGroupWithIdFld |
| This id defines the group the generator should add its created CSOs to. | |
| IntField * | _idFld |
| The id of this processor. | |
| EnumField * | _pathPointStyleFld |
| The path point's line style (none, solid, dashed, dotted). Default is 'solid'. | |
| FloatField * | _pathPointWidthFld |
| The path point's line width. Default is 1. | |
| ColorField * | _pathPointColorFld |
| The path point's color. Default is yellow. | |
| FloatField * | _pathPointAlphaFld |
| The path point's alpha value. Default is 1. | |
| EnumField * | _seedPointStyleFld |
| The marker's mode (none, rect, circle). Default is 'rect'. | |
| FloatField * | _seedPointSizeFld |
| The marker's size. Default is 3. | |
| ColorField * | _seedPointColorFld |
| The marker's color. Default is green. | |
| FloatField * | _seedPointAlphaFld |
| The marker's alpha value. Default is 1. | |
| EnumField * | _voxelWriteModeFld |
| The CSO's voxel write mode (module, const, const plus id, id). Default is 'module'. | |
| FloatField * | _voxelWriteValueFld |
| The CSO's voxel write value. Default is 1024. | |
Detailed Description
The CSOGenerator is the base class for all modules that generate CSOs, be it automatically or interactive.Basically it determines the type of the CSO and an id that can be used to associate CSOs with their generator.
Definition at line 31 of file CSOGenerator.h.
Constructor & Destructor Documentation
| ml::CSOGenerator::CSOGenerator | ( | std::string | type = "CSOGenerator", |
|
| int | numInImg = 0, |
|||
| int | numOutImg = 0 | |||
| ) |
Constructor.
| virtual ml::CSOGenerator::~CSOGenerator | ( | ) | [protected, virtual] |
Destructor.
Member Function Documentation
| CSO* ml::CSOGenerator::_addCSO | ( | CSOList * | csoList, | |
| std::string | groupLabel, | |||
| bool | useUndoRedo = true | |||
| ) | [protected] |
Adds a new CSO to the CSOList and puts it into the group given by the label string.
If the label string is empty, the new CSO is not put in any group. If no group exists with the given label, a new group is generated and the CSO gets associated with that. The method returns a pointer to the newly generated CSO if the according grouping rule allows that or NULL if no new CSO could be created for that particular group.
| void ml::CSOGenerator::_emptyGroupOnDemand | ( | CSOList * | csoList | ) | [protected] |
Empties a group on demand of the given CSOList with the set label.
| CSOGroup* ml::CSOGenerator::_getParentGroup | ( | CSOList * | csoList, | |
| bool | useUndoRedo = false, |
|||
| bool | generate = false | |||
| ) | [protected] |
Returns the parent group according to current group settings.
| std::string ml::CSOGenerator::getType | ( | ) | [inline] |
Member Data Documentation
EnumField* ml::CSOGenerator::_addCSOToGroupMode [protected] |
Defines if the CSOs are added to a group and how the group is identified.
Definition at line 54 of file CSOGenerator.h.
IntField* ml::CSOGenerator::_addCSOToGroupWithIdFld [protected] |
This id defines the group the generator should add its created CSOs to.
If leaved blank, the CSO is not added to any group
Definition at line 62 of file CSOGenerator.h.
StringField* ml::CSOGenerator::_addCSOToGroupWithLabelFld [protected] |
This label defines the group the generator should add its created CSOs to.
If leaved blank, the CSO is not added to any group
Definition at line 58 of file CSOGenerator.h.
If checked and a group name is provided, the group is emptied before a new generation.
Definition at line 51 of file CSOGenerator.h.
IntField* ml::CSOGenerator::_idFld [protected] |
The id of this processor.
This can be used to distinguish similar processors from each other.
Definition at line 66 of file CSOGenerator.h.
FloatField* ml::CSOGenerator::_pathPointAlphaFld [protected] |
ColorField* ml::CSOGenerator::_pathPointColorFld [protected] |
EnumField* ml::CSOGenerator::_pathPointStyleFld [protected] |
The path point's line style (none, solid, dashed, dotted). Default is 'solid'.
Definition at line 69 of file CSOGenerator.h.
FloatField* ml::CSOGenerator::_pathPointWidthFld [protected] |
FloatField* ml::CSOGenerator::_seedPointAlphaFld [protected] |
ColorField* ml::CSOGenerator::_seedPointColorFld [protected] |
FloatField* ml::CSOGenerator::_seedPointSizeFld [protected] |
EnumField* ml::CSOGenerator::_seedPointStyleFld [protected] |
The marker's mode (none, rect, circle). Default is 'rect'.
Definition at line 78 of file CSOGenerator.h.
EnumField* ml::CSOGenerator::_voxelWriteModeFld [protected] |
The CSO's voxel write mode (module, const, const plus id, id). Default is 'module'.
Definition at line 87 of file CSOGenerator.h.
FloatField* ml::CSOGenerator::_voxelWriteValueFld [protected] |
const char* ml::CSOGenerator::addCSOToGroupModeStrings[3] [static] |
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOModuleBase/CSOGenerator.h
