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

#include <CSOManager.h>

Inheritance diagram for ml::CSOManager:

Public Member Functions
	CSOManager (int numInImages=0, int numOutImages=0)
	Standard constructor.

void	updateManager ()
	Updates the tree views and the single CSO/Group fields.

void	updateCSOManager ()
	Updates the CSO list view and the single CSO fields.

void	updateGroupManager ()
	Updates the Group list view and the single Group fields.

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

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

void	getSelectionPathPointColor (Vector3 &origColor)
	Returns the selection color (on base of the given color if in 'brighten' mode).

void	getSelectionPathPointWidth (float &origLineWidth)
	Returns the selection line width (on base of the given line width if in 'widen' mode).

Vector3	getSelectedPathPointsFixedColor () const
	Returns the fixed color for selected path points without regarding the coloring mode.

float	getSelectedPathPointsBrightenValue () const
	Returns the brighten value for selected path points.

float	getSelectedPathPointsFixedLineWidth () const
	Returns the fixed line width value for selected path points.

float	getSelectedPathPointsWidenValue () const
	Returns the widen value for selected path points.

Vector3	getSelectedSeedPointFixedColor () const
	Returns the fixed color for selected seed points.

float	getSelectedSeedPointBrightenValue () const
	Returns the brighten value for selected seed points.

float	getSelectedSeedPointFixedSize () const
	Returns the fixed size value for selected seed points.

float	getSelectedSeedPointEnlargeValue () const
	Returns the value for selected seed points.

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

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

void	getSelectedSeedPointColor (Vector3 &origColor)
	Returns the selected seed point color (on base of the given color if in 'brighten' mode).

void	getSelectedSeedPointSize (float &origSize)
	Returns the selected seed point size (on base of the given size if in 'enlarge' mode).

std::string	getCSODefaultLabel ()
	Returns the default label for CSOs.

std::string	getCSODefaultDescription () const
	Returns the default description for CSOs.

bool	getCSODefaultShowState () const
	Returns the default show state for CSOs.

bool	getCSODefaultVoxelizeState () const
	Returns the default voxelize state for CSOs.

bool	getCSODefaultEditableState () const
	Returns the default editable state for CSOs.

std::string	getGroupDefaultLabel ()
	Returns the default label for CSOGroups.

std::string	getGroupDefaultDescription () const
	Returns the default description for CSOGroups.

bool	getGroupDefaultUseTimePointIndex () const
	Returns whether the member CSOs shall use the CSOGroup's time point index by default.

int	getGroupDefaultTimePointIndex () const
	Returns the default time point index for CSOGroups.

bool	getGroupDefaultUseShowState () const
	Returns whether the member CSOs shall use the CSOGroup's show state by default.

bool	getGroupDefaultShowState () const
	Returns the default show state for CSOGroups.

bool	getGroupDefaultUseVoxelizeState () const
	Returns whether the member CSOs shall use the CSOGroup's voxelize state by default.

bool	getGroupDefaultVoxelizeState () const
	Returns the default voxelize state for CSOGroups.

bool	getGroupDefaultUseEditableState () const
	Returns whether the member CSOs shall use the CSOGroup's editable state by default.

bool	getGroupDefaultEditableState () const
	Returns the default editable state for CSOGroups.

bool	getGroupDefaultUsePathPointStyle () const
	Returns the default line style for CSOGroups.

CSOPathPointsStyle	getGroupDefaultPathPointStyle () const

bool	getGroupDefaultUsePathPointWidth () const
	Returns the default line width for CSOGroups.

float	getGroupDefaultPathPointWidth () const

bool	getGroupDefaultUsePathPointColor () const
	Returns the default color for CSOGroups.

Vector3	getGroupDefaultPathPointColor () const

bool	getGroupDefaultUsePathPointAlpha () const
	Returns the default alpha value for CSOGroups.

float	getGroupDefaultPathPointAlpha () const

bool	getGroupDefaultUseSeedPointStyle () const
	Returns the default marker mode for CSOGroups.

int	getGroupDefaultSeedPointStyle () const

bool	getGroupDefaultUseSeedPointSize () const
	Returns the default marker size for CSOGroups.

float	getGroupDefaultSeedPointSize () const

bool	getGroupDefaultUseSeedPointColor () const
	Returns the default marker color for CSOGroups.

Vector3	getGroupDefaultSeedPointColor () const

bool	getGroupDefaultUseSeedPointAlpha () const
	Returns the default marker alpha value for CSOGroups.

float	getGroupDefaultSeedPointAlpha () const

bool	getGroupDefaultUseVoxelWriteMode () const
	Returns the default voxel write mode for CSOGroups.

int	getGroupDefaultVoxelWriteMode () const

bool	getGroupDefaultUseVoxelWriteValue () const
	Returns the default voxel write value for CSOGroups.

float	getGroupDefaultVoxelWriteValue () const

int	getGroupDefaultNumMaximumCSOs () const
	Returns the default maximum number of CSOs for CSOGroups.

CSOGroupOverflowHandling	getGroupDefaultOverflowHandling () const
	Returns the default overflow handling mode for CSOGroups.

CSORemoveHandling	getGroupDefaultRemoveFromGroupHandling () const
	Returns the default remove from group handling mode for CSOGroups.

CSORemoveHandling	getGroupDefaultDeleteGroupCSOHandling () const

CSORemoveEmptyGroupHandling	getDefaultRemoveEmptyGroupHandling () const
	Returns the default remove empty group handling mode for CSOLists.

Public Member Functions inherited from ml::Module
MLMetaProfilePtr &	getMetaProfile () const
	Returns the metaprofile for the base operator.

const char *	getTypeNameFast () const
	Macro to declare methods for the ML runtime type system (see mlRuntimeSubClass.h).

	Module (int numInputImages, int numOutputImages)
	Constructor: Initializes `numInputImages` input images and `numOutputImages` output images of the module.

	~Module () override
	Destructor: Destroys this module.

InputConnectorField *	getInputImageField (MLint i) const
	Returns the field representing input image `i`. `i` must be a valid index.

OutputConnectorField *	getOutputImageField (MLint i=0) const
	Returns the field representing output image `i`. `i` must be a valid index.

MLint	getNumInputImages () const
	Returns the number of input images of this module.

MLint	getNumOutputImages () const
	Returns the number of output images of this module.

PagedImage *	getOutputImage (MLint outputIndex=0) const
	Returns the output image `outputIndex`. The index needs to be in the range [0, getNumOutputImages()-1].

InputConnectorField *	addInputImage (const char *name=nullptr)
	Adds a new input image with `name` to the module.

OutputConnectorField *	addOutputImage (const char *name=nullptr)
	Adds a new output image with `name` to the module.

PagedImage *	getInputImage (MLint inputIndex, bool getReal=false) const
	Returns the output image of the module connected to input `inputIndex`.

PagedImage *	getUpdatedInputImage (MLint inputIndex, bool getReal=false) const
	Convenience method for a safe access to the input image at index `inputIndex`.

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.

MLErrorCode	processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
	Processes input images with a ProcessAllPagesHandler `handler` on a temporary output image (which allocates no data).

MLErrorCode	processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
	Processes all missing pages on the given output image.

void	clearOutputImage (MLint i=0)
	Clears cached output image pages of output image `i`.

MLint	getOutputImageInplace (MLint outputIndex=0) const
	Returns the optimization flag: returns the index of input image whose input tile is used also as output page for output `outputIndex` in calculateOutputSubImage() (instead of allocating its own memory).

MLint	getBypass (MLint outputIndex=0) const
	Returns the currently bypass index or -1 if bypassing if disabled (default).

THREAD_SUPPORT	getThreadSupport () const
	Returns the multithreading mode supported by this module, default is NO_THREAD_SUPPORT.

bool	areRecursiveHandleNotificationsPermitted () const
	Returns whether recursive entries in handleNotification are permitted.

MLint	getHandleNotificationEntryCounter () const
	A counter returning the current number of (recursive re-)entries in handleNotification.

PERMITTED_TYPES	getVoxelDataTypeSupport () const
	Returns the current state of supported voxel datatypes.

bool	isSupportedVoxelDataType (MLDataType dt) const
	Checks whether a given data type is supported on the module as configured with setVoxelDataTypeSupport.

virtual INPUT_HANDLE	handleInput (int, INPUT_STATE) const
	This method may be reimplemented to enable support for invalid input images on the module.

INPUT_STATE	getInputState (MLint index)
	Returns the current state of the input connection.

INPUT_STATE	getUpdatedInputState (MLint index)
	Returns the updated state of the input image by calling updateImageProperties(index) and returning getInputState(index) afterwards.

bool	isInputImageField (Field *field) const
	Returns whether the given field is an input image field.

void	touchOutputImageFields () const
	Touches all output image fields to indicate that the images have changed.

virtual void	beginSaveFields ()
	Called before all fields data contents of this modules are saved.

virtual void	endSaveFields ()
	Called after saving all field contents of this module.

Public Member Functions inherited from ml::FieldContainer
	FieldContainer ()
	Constructor.

	~FieldContainer () override
	Destructor: Deletes all added fields.

std::string	whoAmI (bool withInstanceName=true) const
	Returns the type and the instance name of format 'ClassTypeName(instanceName)' if the instance name is not empty and `withInstanceName` is `true`.

Field *	addField (const char name, const char type, const char *value)
	Adds a new field with name `name`, type `type`, and value `value` (encoded as string) to the container.

Field *	addField (Field *field)
	Adds a `field`, the ownership of the field is passed to the FieldContainer.

BoolField *	addBool (const char *name)
	Creates a BoolField with `name` and adds it to the container. Default value is `false`.

BoolField *	addBool (const char *name, bool value)
	Creates a BoolField with `name` and adds it to the container.

IntField *	addInt (const char *name)
	Creates an IntField with `name` and adds it to the container. Default value is 0.

IntField *	addInt (const char *name, MLint value)
	Creates an IntField with `name` and adds it to the container.

EnumField *	addEnum (const char name, const char const *enumerationItemNames, MLint numEnumerationItems)
	Creates an EnumField field with `name` and adds it to the container.

EnumField *	addEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
	Creates an EnumField field with `name` and adds it to the container.

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.

FloatField *	addFloat (const char *name)
	Creates a FloatField with `name` and adds it to the container. Default value is 0.f.

FloatField *	addFloat (const char *name, float value)
	Creates a FloatField with `name` and adds it to the container.

ProgressField *	addProgress (const char *name)
	Creates a float ProgressField with `name` and adds it to the container. Default value is 0.f.

ProgressField *	addProgress (const char *name, float value)
	Creates a float ProgressField with `name` and adds it to the container.

DoubleField *	addDouble (const char *name)
	Creates a DoubleField with `name` and adds it to the container. Default value is 0.

DoubleField *	addDouble (const char *name, double value)
	Creates a DoubleField with `name` and adds it to the container.

StringField *	addString (const char *name)
	Creates a StringField with `name` and adds it to the container. Default value is empty string.

StringField *	addString (const char *name, const std::string &value)
	Creates a StringField with `name` and adds it to the container.

NotifyField *	addNotify (const char *name)
	Creates a NotifyField field with `name` and adds it to the container.

TriggerField *	addTrigger (const char *name)
	Creates a TriggerField field with `name` and adds it to the container.

BaseField *	addBase (const char *name)
	Creates a Base field with `name` and adds it to the container. Default value is NULL.

BaseField *	addBase (const char name, Base value)
	Creates a Base field with `name` and adds it to the container.

BaseField *	addBase (const char *name, const RefCountedBasePtr &value)
	Creates a Base field with `name` and adds it to the container. Sets the value from intrusive pointer.

template<typename T >
BaseField *	addBaseWithAllowedType (const char name, T value=nullptr)
	As above, but also sets the allowed type of the field.

template<typename T >
BaseField *	addBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
	As above, but also sets the allowed type of the field.

template<typename T >
TypedBaseField< T > *	addTypedBase (const char *name)
	Creates a TypedBaseField with `name` and adds it to the container. Default value is NULL.

template<typename T >
TypedBaseField< T > *	addTypedBase (const char name, T value)
	Creates a TypedBaseField with `name` and adds it to the container.

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.

SoNodeField *	addSoNode (const char *name)
	Creates a SoNodeField with `name` and adds it to the container. Default value is NULL.

SoNodeField *	addSoNode (const char name, SoNode value)
	Creates a SoNodeField with `name` and adds it to the container.

PointerField *	addPointer (const char *name)
	Creates a PointerField with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name)
	Creates a Vector2Field with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name, const Vector2 &value)
	Creates a Vector2Field with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name, double x, double y)
	Creates a Vector2Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name)
	Creates a Vector3Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name, const Vector3 &value)
	Creates a Vector3Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name, double x, double y, double z)
	Creates a Vector3Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name)
	Creates a Vector4Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name, const Vector4 &value)
	Creates a Vector4Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name, double x, double y, double z, double w)
	Creates a Vector4Field with `name` and adds it to the container.

Vector5Field *	addVector5 (const char *name)
	Creates a Vector5Field with `name` and adds it to the container.

Vector5Field *	addVector5 (const char *name, const Vector5 &value)
	Creates a Vector5Field with `name` and adds it to the container.

Vector6Field *	addVector6 (const char *name)
	Creates a Vector6Field with `name` and adds it to the container.

Vector6Field *	addVector6 (const char *name, const Vector6 &value)
	Creates a Vector6Field with `name` and adds it to the container.

Vector10Field *	addVector10 (const char *name)
	Creates a Vector10Field with `name` and adds it to the container.

Vector10Field *	addVector10 (const char *name, const Vector10 &value)
	Creates a Vector10Field with `name` and adds it to the container.

ImageVectorField *	addImageVector (const char *name)
	Creates a ImageVectorField with `name` and adds it to the container.

ImageVectorField *	addImageVector (const char *name, const ImageVector &value)
	Creates a ImageVectorField with `name` and adds it to the container.

ImageVectorField *	addImageVector (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.

SubImageBoxField *	addSubImageBox (const char *name)
	Creates a SubImageBoxField with `name` and adds it to the container.

SubImageBoxField *	addSubImageBox (const char *name, const SubImageBox &value)
	Creates a SubImageBoxField with `name` and adds it to the container.

SubImageBoxdField *	addSubImageBoxd (const char *name)
	Creates a SubImageBoxd field with `name` and adds it to the container.

SubImageBoxdField *	addSubImageBoxd (const char *name, const SubImageBoxd &value)
	Creates a SubImageBoxd field with `name` and adds it to the container.

ColorField *	addColor (const char *name)
	Creates a ColorField with `name` and adds it to the container.

ColorField *	addColor (const char *name, float r, float g, float b)
	Creates a ColorField with `name` and adds it to the container.

ColorField *	addColor (const char *name, const Vector3 &value)
	Creates a ColorField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name)
	Creates a PlaneField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name, double f0, double f1, double f2, double f3)
	Creates a PlaneField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name, const Plane &value)
	Creates a PlaneField with `name` and adds it to the container.

RotationField *	addRotation (const char *name)
	Creates a RotationField with `name` and adds it to the container.

RotationField *	addRotation (const char *name, const Rotation &value)
	Creates a RotationField with `name` and adds it to the container.

Matrix2Field *	addMatrix2 (const char *name)
	Creates a Matrix2Field with `name` and adds it to the container.

Matrix2Field *	addMatrix2 (const char *name, const Matrix2 &value)
	Creates a Matrix2Field with `name` and adds it to the container.

Matrix3Field *	addMatrix3 (const char *name)
	Creates a Matrix3Field with `name` and adds it to the container.

Matrix3Field *	addMatrix3 (const char *name, const Matrix3 &value)
	Creates a Matrix3Field with `name` and adds it to the container.

Matrix4Field *	addMatrix4 (const char *name)
	Creates a Matrix4Field with `name` and adds it to the container.

Matrix4Field *	addMatrix4 (const char *name, const Matrix4 &value)
	Creates a Matrix4Field with `name` and adds it to the container.

Matrix5Field *	addMatrix5 (const char *name)
	Creates a Matrix5Field with `name` and adds it to the container.

Matrix5Field *	addMatrix5 (const char *name, const Matrix5 &value)
	Creates a Matrix5Field with `name` and adds it to the container.

Matrix6Field *	addMatrix6 (const char *name)
	Creates a Matrix6Field with `name` and adds it to the container.

Matrix6Field *	addMatrix6 (const char *name, const Matrix6 &value)
	Creates a Matrix6Field with `name` and adds it to the container.

MatrixField *	addMatrix (const char *name)
	Creates a MatrixField with `name` and adds it to the container.

MatrixField *	addMatrix (const char *name, const Matrix4 &value)
	Creates a MatrixField with `name` and adds it to the container.

MLDataTypeField *	addMLDataType (const char *name)
	Creates a MTDataTypeField with `name` and adds it to the container.

MLDataTypeField *	addMLDataType (const char *name, MLDataType value)
	Creates a MTDataTypeField with `name` and adds it to the container.

UniversalTypeField *	addUniversalType (const char *name)
	Creates an UniversalTypeField field with `name` and adds it to the container.

IntListField *	addIntList (const char *name)
	Creates an IntListField field with `name` and empty list value and adds it to the container.

IntListField *	addIntList (const char *name, const std::vector< MLint > &value)
	Creates an IntListField field with `name` and given list value and adds it to the container.

DoubleListField *	addDoubleList (const char *name)
	Creates an DoubleListField field with `name` and empty list value and adds it to the container.

DoubleListField *	addDoubleList (const char *name, const std::vector< double > &value)
	Creates an DoubleListField field with `name` and given list value and adds it to the container.

Vector2ListField *	addVector2List (const char *name)
	Creates an Vector2ListField field with `name` and empty list value and adds it to the container.

Vector2ListField *	addVector2List (const char *name, const std::vector< Vector2 > &value)
	Creates an Vector2ListField field with `name` and given list value and adds it to the container.

Vector3ListField *	addVector3List (const char *name)
	Creates an Vector3ListField field with `name` and empty list value and adds it to the container.

Vector3ListField *	addVector3List (const char *name, const std::vector< Vector3 > &value)
	Creates an Vector3ListField field with `name` and given list value and adds it to the container.

Vector4ListField *	addVector4List (const char *name)
	Creates an Vector4ListField field with `name` and empty list value and adds it to the container.

Vector4ListField *	addVector4List (const char *name, const std::vector< Vector4 > &value)
	Creates an Vector4ListField field with `name` and given list value and adds it to the container.

size_t	getNumFields () const
	Returns the number of added fields.

bool	hasField (const std::string &name) const
	Returns `true` if the field with name `name` exists; otherwise, `false` is returned.

Field *	getField (const std::string &name) const
	Returns the pointer to the field with name `name`.

Field *	getField (MLint index) const
	Returns pointer of field at `index` if it exists. If not, -1 is returned.

MLint	getFieldIndex (Field *field) const
	Returns index of `field` if it exists. If not, -1 is returned.

void	setFieldStringValue (const std::string &name, const std::string &value)
	Sets the `value` of the field with `name` if it exists.

std::string	getFieldStringValue (const std::string &name) const
	Returns the string value of the field with `name` if it is found.

virtual void	deactivateAttachments ()
	Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields anymore if their values are set or changed.

Public Member Functions inherited from ml::Base
	Base ()
	Constructor.

virtual	~Base ()
	Destructor.

virtual Base *	deepCopy () const
	Creates a deep copy of the given object.

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Checks whether this object's type is equal to or derived from one of the types given in the argument.

virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.

virtual std::string	detailString () const
	Returns a string describing this object.

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.

virtual std::string	persistentState () const
	Returns a string describing the object's internal state.

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using persistentState().

virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node.

virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node.

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Writes the objects state to the data stream object.

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Reads the objects state from the data stream object.

Protected Member Functions
	~CSOManager () override
	Standard destructor.

void	activateAttachments () override
	Initialize module after loading.

void	handleNotification (Field *field) override
	Called when input changes.

void	setInternalVariables ()
	Sets internal state variables.

Protected Member Functions inherited from ml::Module
void	handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
	Called from FieldContainer whenever a field changes.

virtual CalculateOutputImageHandler *	createCalculateOutputImageHandler (PagedImage *outputImage)
	Creates the CalculateOutputImageHandler for the given output image `outputImage`.

virtual void	calculateOutputImageProperties (int outputIndex, PagedImage *outputImage)
	Set properties of output image `outputImage` with output index `outputIndex`.

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`.

virtual void	calculateOutputSubImage (SubImage outputSubImage, int outputIndex, SubImage inputSubImages)
	Calculates page `outputSubImage` of output image with index `outputIndex` given the input image tiles in array `inputSubImages`.

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.

void	handleNotificationOff ()
	Decreases lock counter for handleNotification calls.

void	handleNotificationOn ()
	Increases lock counter for handleNotification calls.

bool	isHandleNotificationOn ()
	Returns `true` if handleNotification calls are permitted; otherwise, it returns `false`.

void	setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
	Sets the 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`.

void	unsetOutputImageInplace (MLint outputIndex=0)
	Clears the optimization flag: output page of output at `outputIndex` and input tile shall use different memory buffers in calculateOutputSubImage().

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.

void	setClampPagesToImageExtent (bool flag=true)
	Enables/disables page clamping on all output images.

void	setThreadSupport (THREAD_SUPPORT supportMode)
	Passes any THREAD_SUPPORT `supportMode` to decide whether and what type of multithreading is supported by this module.

void	permitRecursiveHandleNotifications (bool enable)
	If this flag is set to `enable` =true, recursive entries in handleNotification are permitted.

void	setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)
	Specifies which types this module supports.

Additional Inherited Members
Public Types inherited from ml::Module
enum	PERMITTED_TYPES { ONLY_SCALAR_TYPES , ONLY_DEFAULT_TYPES , 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.

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.

static MLErrorCode	updateImageProperties (PagedImage *image)
	For documentation see Host::updateImageProperties() function with same signature.

static void	freeTile (void *data)
	For documentation see Host::freeTile().

static void	updateProgress (const char info1, const char info2)
	For documentation see Host::updateProgress().

static bool	shouldTerminate ()
	For documentation see Host::shouldTerminate().

static Field *	getPressedNotifyField ()
	For documentation see Host::getPressedNotifyField().

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.

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`.

static size_t	getNumModules ()
	Returns the number of instantiated modules.

static Module *	getModule (size_t index)
	Returns a pointer to instantiated module `index`.

static MLint	findModuleIndex (Module &module)
	Returns the index of Module `module`. If not found, -1 is returned.

static void	destroyModule ()
	Destroys static allocated tables to avoid memory leaks.

Protected Types inherited from ml::Module
enum	THREAD_SUPPORT { NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD }
	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:

MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOManager/CSOManager.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSOManager()

◆ ~CSOManager()

Member Function Documentation

◆ activateAttachments()

◆ getCSODefaultDescription()

◆ getCSODefaultEditableState()

◆ getCSODefaultLabel()

◆ getCSODefaultShowState()

◆ getCSODefaultVoxelizeState()

◆ getDefaultRemoveEmptyGroupHandling()

◆ getGroupDefaultDeleteGroupCSOHandling()

◆ getGroupDefaultDescription()

◆ getGroupDefaultEditableState()

◆ getGroupDefaultLabel()

◆ getGroupDefaultNumMaximumCSOs()

◆ getGroupDefaultOverflowHandling()

◆ getGroupDefaultPathPointAlpha()

◆ getGroupDefaultPathPointColor()

◆ getGroupDefaultPathPointStyle()

◆ getGroupDefaultPathPointWidth()

◆ getGroupDefaultRemoveFromGroupHandling()

◆ getGroupDefaultSeedPointAlpha()

◆ getGroupDefaultSeedPointColor()

◆ getGroupDefaultSeedPointSize()

◆ getGroupDefaultSeedPointStyle()

◆ getGroupDefaultShowState()

◆ getGroupDefaultTimePointIndex()

◆ getGroupDefaultUseEditableState()

◆ getGroupDefaultUsePathPointAlpha()

◆ getGroupDefaultUsePathPointColor()

◆ getGroupDefaultUsePathPointStyle()

◆ getGroupDefaultUsePathPointWidth()

◆ getGroupDefaultUseSeedPointAlpha()

◆ getGroupDefaultUseSeedPointColor()

◆ getGroupDefaultUseSeedPointSize()

◆ getGroupDefaultUseSeedPointStyle()

◆ getGroupDefaultUseShowState()

◆ getGroupDefaultUseTimePointIndex()

◆ getGroupDefaultUseVoxelizeState()

◆ getGroupDefaultUseVoxelWriteMode()

◆ getGroupDefaultUseVoxelWriteValue()

◆ getGroupDefaultVoxelizeState()

◆ getGroupDefaultVoxelWriteMode()

◆ getGroupDefaultVoxelWriteValue()

◆ getSelectedPathPointsBrightenValue()

◆ getSelectedPathPointsFixedColor()

◆ getSelectedPathPointsFixedLineWidth()

◆ getSelectedPathPointsWidenValue()

◆ getSelectedSeedPointBrightenValue()

◆ getSelectedSeedPointColor()

◆ getSelectedSeedPointColoringMode()

◆ getSelectedSeedPointEnlargeValue()

◆ getSelectedSeedPointFixedColor()

◆ getSelectedSeedPointFixedSize()

◆ getSelectedSeedPointSize()

◆ getSelectedSeedPointSizeMode()

◆ getSelectionPathPointColor()

◆ getSelectionPathPointColoringMode()

◆ getSelectionPathPointWidth()

◆ getSelectionPathPointWidthMode()

◆ handleNotification()

◆ setInternalVariables()

◆ updateCSOManager()

◆ updateGroupManager()

◆ updateManager()