MeVisLab Toolbox Reference
ml::CSOManager Class Reference

The CSOManager allows for storing and iterating CSOs, and implements an undo/redo mechanism. More...

#include <CSOManager.h>

Inheritance diagram for ml::CSOManager:
ml::Module ml::FieldContainer ml::Base

Public Member Functions

 CSOManager (int numInImages=0, int numOutImages=0)
 Standard constructor. More...
 
void updateManager ()
 Updates the tree views and the single CSO/Group fields. More...
 
void updateCSOManager ()
 Updates the CSO list view and the single CSO fields. More...
 
void updateGroupManager ()
 Updates the Group list view and the single Group fields. More...
 
int getSelectionPathPointColoringMode ()
 Returns the coloring mode for selected CSOs (brighten / fixed color). More...
 
int getSelectionPathPointWidthMode ()
 Returns the line width mode for selected CSOs (widen / fixed width). More...
 
void getSelectionPathPointColor (Vector3 &origColor)
 Returns the selection color (on base of the given color if in 'brighten' mode). More...
 
void getSelectionPathPointWidth (float &origLineWidth)
 Returns the selection line width (on base of the given line width if in 'widen' mode). More...
 
Vector3 getSelectedPathPointsFixedColor () const
 Returns the fixed color for selected path points without regarding the coloring mode. More...
 
float getSelectedPathPointsBrightenValue () const
 Returns the brighten value for selected path points. More...
 
float getSelectedPathPointsFixedLineWidth () const
 Returns the fixed line width value for selected path points. More...
 
float getSelectedPathPointsWidenValue () const
 Returns the widen value for selected path points. More...
 
Vector3 getSelectedSeedPointFixedColor () const
 Returns the fixed color for selected seed points. More...
 
float getSelectedSeedPointBrightenValue () const
 Returns the brighten value for selected seed points. More...
 
float getSelectedSeedPointFixedSize () const
 Returns the fixed size value for selected seed points. More...
 
float getSelectedSeedPointEnlargeValue () const
 Returns the value for selected seed points. More...
 
int getSelectedSeedPointColoringMode ()
 Returns the coloring mode for selected seed points (brighten / fixed color). More...
 
int getSelectedSeedPointSizeMode ()
 Returns the size mode for selected seed points (enlarge / fixed size). More...
 
void getSelectedSeedPointColor (Vector3 &origColor)
 Returns the selected seed point color (on base of the given color if in 'brighten' mode). More...
 
void getSelectedSeedPointSize (float &origSize)
 Returns the selected seed point size (on base of the given size if in 'enlarge' mode). More...
 
std::string getCSODefaultLabel ()
 Returns the default label for CSOs. More...
 
std::string getCSODefaultDescription () const
 Returns the default description for CSOs. More...
 
bool getCSODefaultShowState () const
 Returns the default show state for CSOs. More...
 
bool getCSODefaultVoxelizeState () const
 Returns the default voxelize state for CSOs. More...
 
bool getCSODefaultEditableState () const
 Returns the default editable state for CSOs. More...
 
std::string getGroupDefaultLabel ()
 Returns the default label for CSOGroups. More...
 
std::string getGroupDefaultDescription () const
 Returns the default description for CSOGroups. More...
 
bool getGroupDefaultUseTimePointIndex () const
 Returns whether the member CSOs shall use the CSOGroup's time point index by default. More...
 
int getGroupDefaultTimePointIndex () const
 Returns the default time point index for CSOGroups. More...
 
bool getGroupDefaultUseShowState () const
 Returns whether the member CSOs shall use the CSOGroup's show state by default. More...
 
bool getGroupDefaultShowState () const
 Returns the default show state for CSOGroups. More...
 
bool getGroupDefaultUseVoxelizeState () const
 Returns whether the member CSOs shall use the CSOGroup's voxelize state by default. More...
 
bool getGroupDefaultVoxelizeState () const
 Returns the default voxelize state for CSOGroups. More...
 
bool getGroupDefaultUseEditableState () const
 Returns whether the member CSOs shall use the CSOGroup's editable state by default. More...
 
bool getGroupDefaultEditableState () const
 Returns the default editable state for CSOGroups. More...
 
bool getGroupDefaultUsePathPointStyle () const
 Returns the default line style for CSOGroups. More...
 
CSOPathPointsStyle getGroupDefaultPathPointStyle () const
 
bool getGroupDefaultUsePathPointWidth () const
 Returns the default line width for CSOGroups. More...
 
float getGroupDefaultPathPointWidth () const
 
bool getGroupDefaultUsePathPointColor () const
 Returns the default color for CSOGroups. More...
 
Vector3 getGroupDefaultPathPointColor () const
 
bool getGroupDefaultUsePathPointAlpha () const
 Returns the default alpha value for CSOGroups. More...
 
float getGroupDefaultPathPointAlpha () const
 
bool getGroupDefaultUseSeedPointStyle () const
 Returns the default marker mode for CSOGroups. More...
 
int getGroupDefaultSeedPointStyle () const
 
bool getGroupDefaultUseSeedPointSize () const
 Returns the default marker size for CSOGroups. More...
 
float getGroupDefaultSeedPointSize () const
 
bool getGroupDefaultUseSeedPointColor () const
 Returns the default marker color for CSOGroups. More...
 
Vector3 getGroupDefaultSeedPointColor () const
 
bool getGroupDefaultUseSeedPointAlpha () const
 Returns the default marker alpha value for CSOGroups. More...
 
float getGroupDefaultSeedPointAlpha () const
 
bool getGroupDefaultUseVoxelWriteMode () const
 Returns the default voxel write mode for CSOGroups. More...
 
int getGroupDefaultVoxelWriteMode () const
 
bool getGroupDefaultUseVoxelWriteValue () const
 Returns the default voxel write value for CSOGroups. More...
 
float getGroupDefaultVoxelWriteValue () const
 
int getGroupDefaultNumMaximumCSOs () const
 Returns the default maximum number of CSOs for CSOGroups. More...
 
CSOGroupOverflowHandling getGroupDefaultOverflowHandling () const
 Returns the default overflow handling mode for CSOGroups. More...
 
CSORemoveHandling getGroupDefaultRemoveFromGroupHandling () const
 Returns the default remove from group handling mode for CSOGroups. More...
 
CSORemoveHandling getGroupDefaultDeleteGroupCSOHandling () const
 
CSORemoveEmptyGroupHandling getDefaultRemoveEmptyGroupHandling () const
 Returns the default remove empty group handling mode for CSOLists. More...
 
- Public Member Functions inherited from ml::Module
MLMetaProfilePtrgetMetaProfile () const
 Returns the meta profile for the base operator. More...
 
const char * getTypeNameFast () const
 Macro to declare methods for the ML runtime type system (see mlRuntimeSubClass.h). More...
 
 Module (int numInputImages, int numOutputImages)
 Constructor: Initializes numInputImages input images and numOutputImages output images of the module. More...
 
 ~Module () override
 Destructor: Destroys this module. More...
 
InputConnectorFieldgetInputImageField (MLint i) const
 Returns the field representing input image i. i must be a valid index. More...
 
OutputConnectorFieldgetOutputImageField (MLint i=0) const
 Returns field representing output image i. i must be a valid index. More...
 
MLint getNumInputImages () const
 Returns number of input images of this module. More...
 
MLint getNumOutputImages () const
 Returns number of output images of this module. More...
 
PagedImagegetOutputImage (MLint outputIndex=0) const
 Returns output image outputIndex. The index needs to be in the range [0, getNumOutputImages()-1]. More...
 
InputConnectorFieldaddInputImage (const char *name=nullptr)
 Adds a new input image with name to the module. More...
 
OutputConnectorFieldaddOutputImage (const char *name=nullptr)
 Adds a new output image with name to the module. More...
 
PagedImagegetInputImage (MLint inputIndex, bool getReal=false) const
 Returns the output image of the module connected to input inputIndex. More...
 
PagedImagegetUpdatedInputImage (MLint inputIndex, bool getReal=false) const
 Convenience method for safe access to the input image at index inputIndex. More...
 
MLErrorCode processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 Processes all pages of a module for easy implementation of page-based image processing of complete images. More...
 
MLErrorCode processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 Process input images with a ProcessAllPagesHandler handler on a temporary output image (which allocates no data) For details, see processAllPages(-1) above. More...
 
MLErrorCode processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 Processes all missing pages on the given output image. More...
 
void clearOutputImage (MLint i=0)
 Clear cached output image pages of output image i. More...
 
InputConnectorFieldaddInputConnector (const char *name, Module *module, MLint i) override
 
OutputConnectorFieldaddOutputConnector (const char *name, Module *module, MLint i) override
 
MLint getOutputImageInplace (MLint outputIndex=0) const
 Return optimization flag: Return index of input image whose input tile is used also as output page for output outputIndex in calculateOutputSubImage() (instead of allocating its own memory). More...
 
MLint getBypass (MLint outputIndex=0) const
 Returns the currently bypass index or -1 if bypassing is disabled (default). More...
 
THREAD_SUPPORT getThreadSupport () const
 Returns the multithreading mode supported by this module, default is NO_THREAD_SUPPORT. More...
 
bool areRecursiveHandleNotificationsPermitted () const
 Returns if recursive entries in handleNotification are permitted. More...
 
MLint getHandleNotificationEntryCounter () const
 A counter returning the current number of (recursive re)entries in handleNotification. More...
 
PERMITTED_TYPES getVoxelDataTypeSupport () const
 Returns the current state of supported voxel data types. More...
 
bool isSupportedVoxelDataType (MLDataType dt) const
 Check if a given data type is supported on the module as configured with setVoxelDataTypeSupport. More...
 
virtual INPUT_HANDLE handleInput (int, INPUT_STATE) const
 This method may be reimplemented to enable support for invalid input images on the module. More...
 
INPUT_STATE getInputState (MLint index)
 Returns the current state of the input connection. More...
 
INPUT_STATE getUpdatedInputState (MLint index)
 Returns the updated state of the input image by calling updateImageProperties(index) and returning getInputState(index) afterwards. More...
 
bool isInputImageField (Field *field) const
 Returns if the given field is an input image field. This can be used in handleNotification(), to check if one of the input images has changed. More...
 
void touchOutputImageFields () const
 Touch all output image fields to indicate that the images have changed. More...
 
FieldContainergetFieldContainer ()
 Returns a pointer to the container of all the module's fields. More...
 
const FieldContainergetFieldContainer () const
 Returns a constant pointer to the container of all the module's fields. More...
 
virtual void beginSaveFields ()
 Called before all fields data contents of this modules are saved. More...
 
virtual void endSaveFields ()
 Called after saving all field contents of this module. More...
 
- Public Member Functions inherited from ml::FieldContainer
 FieldContainer ()
 Constructor. More...
 
 ~FieldContainer () override
 Destructor: Deletes all added fields. More...
 
std::string whoAmI (bool withInstanceName=true) const
 Returns type and instance name of format "ClassTypeName(instanceName)" if the instance name is not empty and withInstanceName is true. More...
 
FieldaddField (const char *name, const char *type, const char *value)
 Adds a new field with name name, type type and value value (coded as string) to the container. More...
 
FieldaddField (Field *field)
 Adds a field, the ownership of the field is passed to the FieldContainer. More...
 
BoolFieldaddBool (const char *name)
 Creates a BoolField with name and adds it to the container. Default value is false. More...
 
BoolFieldaddBool (const char *name, bool value)
 Creates a BoolField with name and adds it to the container. More...
 
IntFieldaddInt (const char *name)
 Creates an IntField with name and adds it to the container. Default value is 0. More...
 
IntFieldaddInt (const char *name, MLint value)
 Creates an IntField with name and adds it to the container. More...
 
EnumFieldaddEnum (const char *name, const char *const *enumerationItemNames, MLint numEnumerationItems)
 Creates an EnumField field with name and adds it to the container. More...
 
EnumFieldaddEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
 Creates an EnumField field with name and adds it to the container. More...
 
template<typename EnumType >
TypedEnumField< EnumType > * addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue)
 Creates a TypedEnumField field with name and adds it to the container. More...
 
FloatFieldaddFloat (const char *name)
 Creates a FloatField with name and adds it to the container. Default value is 0.f. More...
 
FloatFieldaddFloat (const char *name, float value)
 Creates a FloatField with name and adds it to the container. More...
 
ProgressFieldaddProgress (const char *name)
 Creates a float ProgressField with name and adds it to the container. Default value is 0.f. More...
 
ProgressFieldaddProgress (const char *name, float value)
 Creates a float ProgressField with name and adds it to the container. More...
 
DoubleFieldaddDouble (const char *name)
 Creates a DoubleField with name and adds it to the container. Default value is 0. More...
 
DoubleFieldaddDouble (const char *name, double value)
 Creates a DoubleField with name and adds it to the container. More...
 
StringFieldaddString (const char *name)
 Creates a StringField with name and adds it to the container. Default value is empty string. More...
 
StringFieldaddString (const char *name, const std::string &value)
 Creates a StringField with name and adds it to the container. More...
 
NotifyFieldaddNotify (const char *name)
 Creates a NotifyField field with name and adds it to the container. More...
 
TriggerFieldaddTrigger (const char *name)
 Creates a TriggerField field with name and adds it to the container. More...
 
BaseFieldaddBase (const char *name)
 Creates a Base field with name and adds it to the container. Default value is NULL. More...
 
BaseFieldaddBase (const char *name, Base *value)
 Creates a Base field with name and adds it to the container. More...
 
BaseFieldaddBase (const char *name, const RefCountedBasePtr &value)
 Creates a Base field with name and adds it to the container. Sets the value from intrusive pointer. More...
 
template<typename T >
BaseFieldaddBaseWithAllowedType (const char *name, T *value=nullptr)
 As above, but also sets the allowed type of the field. More...
 
template<typename T >
BaseFieldaddBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
 As above, but also sets the allowed type of the field. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name)
 Creates a TypedBaseField with name and adds it to the container. Default value is NULL. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name, T *value)
 Creates a TypedBaseField with name and adds it to the container. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name, const ::boost::intrusive_ptr< T > &value)
 Creates a TypedBaseField with name and adds it to the container. Sets the value from intrusive pointer. More...
 
SoNodeFieldaddSoNode (const char *name)
 Creates a SoNodeField with name and adds it to the container. Default value is NULL. More...
 
SoNodeFieldaddSoNode (const char *name, SoNode *value)
 Creates a SoNodeField with name and adds it to the container. More...
 
PointerFieldaddPointer (const char *name)
 Creates a PointerField with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name, const Vector2 &value)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name, double x, double y)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name, const Vector3 &value)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name, double x, double y, double z)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name, const Vector4 &value)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name, double x, double y, double z, double w)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector5FieldaddVector5 (const char *name)
 Creates a Vector5Field with name and adds it to the container. More...
 
Vector5FieldaddVector5 (const char *name, const Vector5 &value)
 Creates a Vector5Field with name and adds it to the container. More...
 
Vector6FieldaddVector6 (const char *name)
 Creates a Vector6Field with name and adds it to the container. More...
 
Vector6FieldaddVector6 (const char *name, const Vector6 &value)
 Creates a Vector6Field with name and adds it to the container. More...
 
Vector10FieldaddVector10 (const char *name)
 Creates a Vector10Field with name and adds it to the container. More...
 
Vector10FieldaddVector10 (const char *name, const Vector10 &value)
 Creates a Vector10Field with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name)
 Creates a ImageVectorField with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name, const ImageVector &value)
 Creates a ImageVectorField with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u)
 Creates a ImageVectorField with name and adds it to the container. More...
 
SubImageBoxFieldaddSubImageBox (const char *name)
 Creates a SubImageBoxField with name and adds it to the container. More...
 
SubImageBoxFieldaddSubImageBox (const char *name, const SubImageBox &value)
 Creates a SubImageBoxField with name and adds it to the container. More...
 
SubImageBoxdFieldaddSubImageBoxd (const char *name)
 Creates a SubImageBoxd field with name and adds it to the container. More...
 
SubImageBoxdFieldaddSubImageBoxd (const char *name, const SubImageBoxd &value)
 Creates a SubImageBoxd field with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name)
 Creates a ColorField with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name, float r, float g, float b)
 Creates a ColorField with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name, const Vector3 &value)
 Creates a ColorField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name)
 Creates a PlaneField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name, double f0, double f1, double f2, double f3)
 Creates a PlaneField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name, const Plane &value)
 Creates a PlaneField with name and adds it to the container. More...
 
RotationFieldaddRotation (const char *name)
 Creates a RotationField with name and adds it to the container. More...
 
RotationFieldaddRotation (const char *name, const Rotation &value)
 Creates a RotationField with name and adds it to the container. More...
 
Matrix2FieldaddMatrix2 (const char *name)
 Creates a Matrix2Field with name and adds it to the container. More...
 
Matrix2FieldaddMatrix2 (const char *name, const Matrix2 &value)
 Creates a Matrix2Field with name and adds it to the container. More...
 
Matrix3FieldaddMatrix3 (const char *name)
 Creates a Matrix3Field with name and adds it to the container. More...
 
Matrix3FieldaddMatrix3 (const char *name, const Matrix3 &value)
 Creates a Matrix3Field with name and adds it to the container. More...
 
Matrix4FieldaddMatrix4 (const char *name)
 Creates a Matrix4Field with name and adds it to the container. More...
 
Matrix4FieldaddMatrix4 (const char *name, const Matrix4 &value)
 Creates a Matrix4Field with name and adds it to the container. More...
 
Matrix5FieldaddMatrix5 (const char *name)
 Creates a Matrix5Field with name and adds it to the container. More...
 
Matrix5FieldaddMatrix5 (const char *name, const Matrix5 &value)
 Creates a Matrix5Field with name and adds it to the container. More...
 
Matrix6FieldaddMatrix6 (const char *name)
 Creates a Matrix6Field with name and adds it to the container. More...
 
Matrix6FieldaddMatrix6 (const char *name, const Matrix6 &value)
 Creates a Matrix6Field with name and adds it to the container. More...
 
MatrixFieldaddMatrix (const char *name)
 Creates a MatrixField with name and adds it to the container. More...
 
MatrixFieldaddMatrix (const char *name, const Matrix4 &value)
 Creates a MatrixField with name and adds it to the container. More...
 
MLDataTypeFieldaddMLDataType (const char *name)
 Creates a MTDataTypeField with name and adds it to the container. More...
 
MLDataTypeFieldaddMLDataType (const char *name, MLDataType value)
 Creates a MTDataTypeField with name and adds it to the container. More...
 
UniversalTypeFieldaddUniversalType (const char *name)
 Creates an UniversalTypeField field with name and adds it to the container. More...
 
IntListFieldaddIntList (const char *name)
 Creates an IntListField field with name and empty list value and adds it to the container. More...
 
IntListFieldaddIntList (const char *name, const std::vector< MLint > &value)
 Creates an IntListField field with name and given list value and adds it to the container. More...
 
DoubleListFieldaddDoubleList (const char *name)
 Creates an DoubleListField field with name and empty list value and adds it to the container. More...
 
DoubleListFieldaddDoubleList (const char *name, const std::vector< double > &value)
 Creates an DoubleListField field with name and given list value and adds it to the container. More...
 
Vector2ListFieldaddVector2List (const char *name)
 Creates an Vector2ListField field with name and empty list value and adds it to the container. More...
 
Vector2ListFieldaddVector2List (const char *name, const std::vector< Vector2 > &value)
 Creates an Vector2ListField field with name and given list value and adds it to the container. More...
 
Vector3ListFieldaddVector3List (const char *name)
 Creates an Vector3ListField field with name and empty list value and adds it to the container. More...
 
Vector3ListFieldaddVector3List (const char *name, const std::vector< Vector3 > &value)
 Creates an Vector3ListField field with name and given list value and adds it to the container. More...
 
Vector4ListFieldaddVector4List (const char *name)
 Creates an Vector4ListField field with name and empty list value and adds it to the container. More...
 
Vector4ListFieldaddVector4List (const char *name, const std::vector< Vector4 > &value)
 Creates an Vector4ListField field with name and given list value and adds it to the container. More...
 
size_t getNumFields () const
 Returns the number of added fields. More...
 
bool hasField (const std::string &name) const
 Returns true if the field with name name exists; otherwise false is returned. More...
 
FieldgetField (const std::string &name) const
 Returns the pointer to the field with name name. More...
 
FieldgetField (MLint index) const
 Returns pointer of field at index if it exists. If not, -1 is returned. More...
 
MLint getFieldIndex (Field *field) const
 Returns index of field if it exists. If not, -1 is returned. More...
 
void setFieldStringValue (const std::string &name, const std::string &value)
 Sets the value of the field with name if it exists. More...
 
std::string getFieldStringValue (const std::string &name) const
 Returns the string value of the field with name if it is found. More...
 
virtual void deactivateAttachments ()
 Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields any more if their values are set or changed. More...
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor. More...
 
virtual ~Base ()
 Destructor. More...
 
virtual BasedeepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion() More...
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument. More...
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase. More...
 
virtual std::string detailString () const
 Return a string describing this object. More...
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class. More...
 
virtual std::string persistentState () const
 Returns a string describing the object's internal state. More...
 
virtual void setPersistentState (const std::string &state)
 Restores the object's internal state from a string that had been previously generated using persistentState(). More...
 
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node. More...
 
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node. More...
 
virtual void writeTo (AbstractPersistenceOutputStream *) const
 Write the objects state to the data stream object. More...
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object. More...
 

Protected Member Functions

 ~CSOManager () override
 Standard destructor. More...
 
void activateAttachments () override
 Initialize module after loading. More...
 
void handleNotification (Field *field) override
 Called when input changes. More...
 
void setInternalVariables ()
 Sets internal state variables. More...
 
- Protected Member Functions inherited from ml::Module
void handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
 Called from FieldContainer whenever a field changes. More...
 
virtual void provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &)
 This method allows a Module to provide its own pages to the Host for the outputIndex output image. More...
 
void handleNotificationOff ()
 Decreases lock counter for handleNotification calls. More...
 
void handleNotificationOn ()
 Increases lock counter for handleNotification calls. More...
 
bool isHandleNotificationOn ()
 Returns true if handleNotification calls are permitted, otherwise false. More...
 
void setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
 Set optimization flag: If calculating a page in calculateOutputSubImage(), the output image page of output outputIndex shall use the same memory as the input page of input inputIndex. More...
 
void unsetOutputImageInplace (MLint outputIndex=0)
 Clear optimization flag: output page of output at outputIndex and input tile shall use different memory buffers in calculateOutputSubImage(). More...
 
void setBypass (MLint outputIndex=0, MLint inputIndex=0)
 Sets the input image whose pages can also be used instead of output pages for the output image at outputIndex to avoid recalculations. More...
 
void setClampPagesToImageExtent (bool flag=true)
 Enables/disables page clamping on all output images. More...
 
void setThreadSupport (THREAD_SUPPORT supportMode)
 Pass any THREAD_SUPPORT supportMode to decide whether and what type of multithreading is supported by this module. More...
 
void permitRecursiveHandleNotifications (bool enable)
 If this flag is set to enable =true, recursive entries in handleNotification are permitted. More...
 
void setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)
 Specifies which types this module supports. More...
 
virtual CalculateOutputImageHandlercreateCalculateOutputImageHandler (PagedImage *outputImage)
 Creates the CalculateOutputImageHandler for the given output image outputImage. More...
 
virtual void calculateOutputImageProperties (int outputIndex, PagedImage *)
 Set properties of output image outputImage with output index outputIndex. More...
 
virtual SubImageBox calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int)
 Called by the Host to determine which input image region (tile) of input inputIndex is required to calculate a certain output image region (page) of output outputIndex. More...
 
virtual void calculateOutputSubImage (SubImage *outputSubImage, int outputIndex, SubImage *inputSubImages)
 Calculate page outputSubImage of output image with index outputIndex given the input image tiles in array inputSubImages. More...
 
- Protected Member Functions inherited from ml::Base
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state. More...
 
virtual void setPersistentState (const char *)
 Restores the object's internal state from a string that had been previously generated using getPersistentState(). More...
 
virtual void clearPersistentState (char *) const
 Disposes a string previously allocated by getPersistentState(). More...
 

Additional Inherited Members

- Public Types inherited from ml::Module
enum  PERMITTED_TYPES {
  ONLY_SCALAR_TYPES , ONLY_DEFAULT_TYPES , ALL_REGISTERED_TYPES , ONLY_STANDARD_TYPES = ONLY_SCALAR_TYPES ,
  FULLY_OPERATIONAL = ONLY_DEFAULT_TYPES , MINIMUM_OPERATIONAL = ALL_REGISTERED_TYPES
}
 See documentation of setVoxelDataTypeSupport. More...
 
enum  INPUT_STATE { DISCONNECTED = 0 , CONNECTED_BUT_INVALID = 1 , CONNECTED_AND_VALID = 2 , CONNECTED_BUT_NEEDS_UPDATE = 3 }
 See documentation of handleInput. More...
 
enum  INPUT_HANDLE { INVALIDATE = 0 , ALLOW_INVALID_INPUT = 2 }
 See documentation of handleInput. More...
 
- Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
 
- Static Public Member Functions inherited from ml::Module
static MLErrorCode getTile (PagedImage *image, SubImageBox loc, MLDataType datatype, void **data, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 For documentation see Host::getTile() function with same signature. More...
 
static MLErrorCode getTile (PagedImage *image, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 For documentation see Host::getTile() function with same signature and Module passed as reference. More...
 
static MLErrorCode updateImageProperties (PagedImage *image)
 For documentation see Host::updateImageProperties() function with same signature. More...
 
static void freeTile (void *data)
 For documentation see Host::freeTile(). More...
 
static void updateProgress (const char *info1, const char *info2)
 For documentation see Host::updateProgress(). More...
 
static bool shouldTerminate ()
 For documentation see Host::shouldTerminate(). More...
 
static FieldgetPressedNotifyField ()
 For documentation see Host::getPressedNotifyField(). More...
 
static void adaptPageExtent (ImageVector &pageExtent, MLDataType imageType, const ImageVector &newImgExtent, const ImageVector &oldImgExtent, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExtent=ImageVector(0), const ImageVector &maxPageExtent=ImageVector(0))
 Adapt page size. More...
 
static std::string getVoxelValueAsString (PagedImage *image, const ImageVector &position, MLErrorCode *errorCode=nullptr, const std::string &errorResult="")
 Returns the voxel value at position position of the image image. More...
 
static size_t getNumModules ()
 Returns number of instantiated modules. More...
 
static ModulegetModule (size_t index)
 Returns pointer to instantiated module index. More...
 
static MLint findModuleIndex (Module &module)
 Returns index of Module module. If not found -1 is returned. More...
 
static void destroyModule ()
 Destroys static allocated tables to avoid memory leaks. More...
 
- Protected Types inherited from ml::Module
enum  THREAD_SUPPORT {
  NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD , ML_CALCULATEOUTPUTSUBIMAGE_ON_STD_TYPES = PagedImage::MULTITHREADED ,
  ML_CALCULATEOUTPUTSUBIMAGE_ON_ALL_TYPES = PagedImage::MULTITHREADED
}
 Enumerator deciding whether and which type of multithreading is supported by this module. More...
 

Detailed Description

The CSOManager allows for storing and iterating CSOs, and implements an undo/redo mechanism.

The manager also permits a group administration and an adjusting of visual parameters.

Definition at line 32 of file CSOManager.h.

Constructor & Destructor Documentation

◆ CSOManager()

ml::CSOManager::CSOManager ( int  numInImages = 0,
int  numOutImages = 0 
)

Standard constructor.

◆ ~CSOManager()

ml::CSOManager::~CSOManager ( )
overrideprotected

Standard destructor.

Member Function Documentation

◆ activateAttachments()

void ml::CSOManager::activateAttachments ( )
overrideprotectedvirtual

Initialize module after loading.

Reimplemented from ml::FieldContainer.

◆ getCSODefaultDescription()

std::string ml::CSOManager::getCSODefaultDescription ( ) const
inline

Returns the default description for CSOs.

Definition at line 91 of file CSOManager.h.

◆ getCSODefaultEditableState()

bool ml::CSOManager::getCSODefaultEditableState ( ) const
inline

Returns the default editable state for CSOs.

Definition at line 97 of file CSOManager.h.

◆ getCSODefaultLabel()

std::string ml::CSOManager::getCSODefaultLabel ( )

Returns the default label for CSOs.

◆ getCSODefaultShowState()

bool ml::CSOManager::getCSODefaultShowState ( ) const
inline

Returns the default show state for CSOs.

Definition at line 93 of file CSOManager.h.

◆ getCSODefaultVoxelizeState()

bool ml::CSOManager::getCSODefaultVoxelizeState ( ) const
inline

Returns the default voxelize state for CSOs.

Definition at line 95 of file CSOManager.h.

◆ getDefaultRemoveEmptyGroupHandling()

CSORemoveEmptyGroupHandling ml::CSOManager::getDefaultRemoveEmptyGroupHandling ( ) const
inline

Returns the default remove empty group handling mode for CSOLists.

Definition at line 165 of file CSOManager.h.

◆ getGroupDefaultDeleteGroupCSOHandling()

CSORemoveHandling ml::CSOManager::getGroupDefaultDeleteGroupCSOHandling ( ) const
inline

Definition at line 163 of file CSOManager.h.

◆ getGroupDefaultDescription()

std::string ml::CSOManager::getGroupDefaultDescription ( ) const
inline

Returns the default description for CSOGroups.

Definition at line 105 of file CSOManager.h.

◆ getGroupDefaultEditableState()

bool ml::CSOManager::getGroupDefaultEditableState ( ) const
inline

Returns the default editable state for CSOGroups.

Definition at line 121 of file CSOManager.h.

◆ getGroupDefaultLabel()

std::string ml::CSOManager::getGroupDefaultLabel ( )

Returns the default label for CSOGroups.

◆ getGroupDefaultNumMaximumCSOs()

int ml::CSOManager::getGroupDefaultNumMaximumCSOs ( ) const
inline

Returns the default maximum number of CSOs for CSOGroups.

Definition at line 158 of file CSOManager.h.

◆ getGroupDefaultOverflowHandling()

CSOGroupOverflowHandling ml::CSOManager::getGroupDefaultOverflowHandling ( ) const
inline

Returns the default overflow handling mode for CSOGroups.

Definition at line 160 of file CSOManager.h.

◆ getGroupDefaultPathPointAlpha()

float ml::CSOManager::getGroupDefaultPathPointAlpha ( ) const
inline

Definition at line 134 of file CSOManager.h.

◆ getGroupDefaultPathPointColor()

Vector3 ml::CSOManager::getGroupDefaultPathPointColor ( ) const
inline

Definition at line 131 of file CSOManager.h.

◆ getGroupDefaultPathPointStyle()

CSOPathPointsStyle ml::CSOManager::getGroupDefaultPathPointStyle ( ) const
inline

Definition at line 125 of file CSOManager.h.

◆ getGroupDefaultPathPointWidth()

float ml::CSOManager::getGroupDefaultPathPointWidth ( ) const
inline

Definition at line 128 of file CSOManager.h.

◆ getGroupDefaultRemoveFromGroupHandling()

CSORemoveHandling ml::CSOManager::getGroupDefaultRemoveFromGroupHandling ( ) const
inline

Returns the default remove from group handling mode for CSOGroups.

Definition at line 162 of file CSOManager.h.

◆ getGroupDefaultSeedPointAlpha()

float ml::CSOManager::getGroupDefaultSeedPointAlpha ( ) const
inline

Definition at line 147 of file CSOManager.h.

◆ getGroupDefaultSeedPointColor()

Vector3 ml::CSOManager::getGroupDefaultSeedPointColor ( ) const
inline

Definition at line 144 of file CSOManager.h.

◆ getGroupDefaultSeedPointSize()

float ml::CSOManager::getGroupDefaultSeedPointSize ( ) const
inline

Definition at line 141 of file CSOManager.h.

◆ getGroupDefaultSeedPointStyle()

int ml::CSOManager::getGroupDefaultSeedPointStyle ( ) const
inline

Definition at line 138 of file CSOManager.h.

◆ getGroupDefaultShowState()

bool ml::CSOManager::getGroupDefaultShowState ( ) const
inline

Returns the default show state for CSOGroups.

Definition at line 113 of file CSOManager.h.

◆ getGroupDefaultTimePointIndex()

int ml::CSOManager::getGroupDefaultTimePointIndex ( ) const
inline

Returns the default time point index for CSOGroups.

Definition at line 109 of file CSOManager.h.

◆ getGroupDefaultUseEditableState()

bool ml::CSOManager::getGroupDefaultUseEditableState ( ) const
inline

Returns whether the member CSOs shall use the CSOGroup's editable state by default.

Definition at line 119 of file CSOManager.h.

◆ getGroupDefaultUsePathPointAlpha()

bool ml::CSOManager::getGroupDefaultUsePathPointAlpha ( ) const
inline

Returns the default alpha value for CSOGroups.

Definition at line 133 of file CSOManager.h.

◆ getGroupDefaultUsePathPointColor()

bool ml::CSOManager::getGroupDefaultUsePathPointColor ( ) const
inline

Returns the default color for CSOGroups.

Definition at line 130 of file CSOManager.h.

◆ getGroupDefaultUsePathPointStyle()

bool ml::CSOManager::getGroupDefaultUsePathPointStyle ( ) const
inline

Returns the default line style for CSOGroups.

Definition at line 124 of file CSOManager.h.

◆ getGroupDefaultUsePathPointWidth()

bool ml::CSOManager::getGroupDefaultUsePathPointWidth ( ) const
inline

Returns the default line width for CSOGroups.

Definition at line 127 of file CSOManager.h.

◆ getGroupDefaultUseSeedPointAlpha()

bool ml::CSOManager::getGroupDefaultUseSeedPointAlpha ( ) const
inline

Returns the default marker alpha value for CSOGroups.

Definition at line 146 of file CSOManager.h.

◆ getGroupDefaultUseSeedPointColor()

bool ml::CSOManager::getGroupDefaultUseSeedPointColor ( ) const
inline

Returns the default marker color for CSOGroups.

Definition at line 143 of file CSOManager.h.

◆ getGroupDefaultUseSeedPointSize()

bool ml::CSOManager::getGroupDefaultUseSeedPointSize ( ) const
inline

Returns the default marker size for CSOGroups.

Definition at line 140 of file CSOManager.h.

◆ getGroupDefaultUseSeedPointStyle()

bool ml::CSOManager::getGroupDefaultUseSeedPointStyle ( ) const
inline

Returns the default marker mode for CSOGroups.

Definition at line 137 of file CSOManager.h.

◆ getGroupDefaultUseShowState()

bool ml::CSOManager::getGroupDefaultUseShowState ( ) const
inline

Returns whether the member CSOs shall use the CSOGroup's show state by default.

Definition at line 111 of file CSOManager.h.

◆ getGroupDefaultUseTimePointIndex()

bool ml::CSOManager::getGroupDefaultUseTimePointIndex ( ) const
inline

Returns whether the member CSOs shall use the CSOGroup's time point index by default.

Definition at line 107 of file CSOManager.h.

◆ getGroupDefaultUseVoxelizeState()

bool ml::CSOManager::getGroupDefaultUseVoxelizeState ( ) const
inline

Returns whether the member CSOs shall use the CSOGroup's voxelize state by default.

Definition at line 115 of file CSOManager.h.

◆ getGroupDefaultUseVoxelWriteMode()

bool ml::CSOManager::getGroupDefaultUseVoxelWriteMode ( ) const
inline

Returns the default voxel write mode for CSOGroups.

Definition at line 150 of file CSOManager.h.

◆ getGroupDefaultUseVoxelWriteValue()

bool ml::CSOManager::getGroupDefaultUseVoxelWriteValue ( ) const
inline

Returns the default voxel write value for CSOGroups.

Definition at line 153 of file CSOManager.h.

◆ getGroupDefaultVoxelizeState()

bool ml::CSOManager::getGroupDefaultVoxelizeState ( ) const
inline

Returns the default voxelize state for CSOGroups.

Definition at line 117 of file CSOManager.h.

◆ getGroupDefaultVoxelWriteMode()

int ml::CSOManager::getGroupDefaultVoxelWriteMode ( ) const
inline

Definition at line 151 of file CSOManager.h.

◆ getGroupDefaultVoxelWriteValue()

float ml::CSOManager::getGroupDefaultVoxelWriteValue ( ) const
inline

Definition at line 154 of file CSOManager.h.

◆ getSelectedPathPointsBrightenValue()

float ml::CSOManager::getSelectedPathPointsBrightenValue ( ) const
inline

Returns the brighten value for selected path points.

Definition at line 61 of file CSOManager.h.

◆ getSelectedPathPointsFixedColor()

Vector3 ml::CSOManager::getSelectedPathPointsFixedColor ( ) const
inline

Returns the fixed color for selected path points without regarding the coloring mode.

Definition at line 59 of file CSOManager.h.

◆ getSelectedPathPointsFixedLineWidth()

float ml::CSOManager::getSelectedPathPointsFixedLineWidth ( ) const
inline

Returns the fixed line width value for selected path points.

Definition at line 63 of file CSOManager.h.

◆ getSelectedPathPointsWidenValue()

float ml::CSOManager::getSelectedPathPointsWidenValue ( ) const
inline

Returns the widen value for selected path points.

Definition at line 65 of file CSOManager.h.

◆ getSelectedSeedPointBrightenValue()

float ml::CSOManager::getSelectedSeedPointBrightenValue ( ) const
inline

Returns the brighten value for selected seed points.

Definition at line 70 of file CSOManager.h.

◆ getSelectedSeedPointColor()

void ml::CSOManager::getSelectedSeedPointColor ( Vector3 origColor)

Returns the selected seed point color (on base of the given color if in 'brighten' mode).

◆ getSelectedSeedPointColoringMode()

int ml::CSOManager::getSelectedSeedPointColoringMode ( )
inline

Returns the coloring mode for selected seed points (brighten / fixed color).

Definition at line 77 of file CSOManager.h.

◆ getSelectedSeedPointEnlargeValue()

float ml::CSOManager::getSelectedSeedPointEnlargeValue ( ) const
inline

Returns the value for selected seed points.

Definition at line 74 of file CSOManager.h.

◆ getSelectedSeedPointFixedColor()

Vector3 ml::CSOManager::getSelectedSeedPointFixedColor ( ) const
inline

Returns the fixed color for selected seed points.

Definition at line 68 of file CSOManager.h.

◆ getSelectedSeedPointFixedSize()

float ml::CSOManager::getSelectedSeedPointFixedSize ( ) const
inline

Returns the fixed size value for selected seed points.

Definition at line 72 of file CSOManager.h.

◆ getSelectedSeedPointSize()

void ml::CSOManager::getSelectedSeedPointSize ( float &  origSize)

Returns the selected seed point size (on base of the given size if in 'enlarge' mode).

◆ getSelectedSeedPointSizeMode()

int ml::CSOManager::getSelectedSeedPointSizeMode ( )
inline

Returns the size mode for selected seed points (enlarge / fixed size).

Definition at line 79 of file CSOManager.h.

◆ getSelectionPathPointColor()

void ml::CSOManager::getSelectionPathPointColor ( Vector3 origColor)

Returns the selection color (on base of the given color if in 'brighten' mode).

◆ getSelectionPathPointColoringMode()

int ml::CSOManager::getSelectionPathPointColoringMode ( )
inline

Returns the coloring mode for selected CSOs (brighten / fixed color).

Definition at line 50 of file CSOManager.h.

◆ getSelectionPathPointWidth()

void ml::CSOManager::getSelectionPathPointWidth ( float &  origLineWidth)

Returns the selection line width (on base of the given line width if in 'widen' mode).

◆ getSelectionPathPointWidthMode()

int ml::CSOManager::getSelectionPathPointWidthMode ( )
inline

Returns the line width mode for selected CSOs (widen / fixed width).

Definition at line 52 of file CSOManager.h.

◆ handleNotification()

void ml::CSOManager::handleNotification ( Field field)
overrideprotectedvirtual

Called when input changes.

Reimplemented from ml::Module.

◆ setInternalVariables()

void ml::CSOManager::setInternalVariables ( )
protected

Sets internal state variables.

◆ updateCSOManager()

void ml::CSOManager::updateCSOManager ( )

Updates the CSO list view and the single CSO fields.

◆ updateGroupManager()

void ml::CSOManager::updateGroupManager ( )

Updates the Group list view and the single Group fields.

◆ updateManager()

void ml::CSOManager::updateManager ( )

Updates the tree views and the single CSO/Group fields.


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