The CSOGenerator is the base class for all modules that generate CSOs, be it automatically or interactive. More...

#include <CSOGenerator.h>

Inheritance diagram for ml::CSOGenerator:

Public Member Functions
	CSOGenerator (std::string type="CSOGenerator", int numInImg=0, int numOutImg=0)
	Constructor.
std::string	getType () const
	Returns the type of the CSOGenerator.
Public Member Functions inherited from ml::CSOBaseModule
	CSOBaseModule (const std::string &type="CSOBaseModule", int numInImages=0, int numOutImages=0)
	Standard constructor.
Public Member Functions inherited from ml::Module
MLMetaProfilePtr &	getMetaProfile () const
	Returns the metaprofile for the base operator.
const char *	getTypeNameFast () const
	Module (int numInputImages, int numOutputImages)
	~Module () override
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)
OutputConnectorField *	addOutputImage (const char *name=nullptr)
PagedImage *	getInputImage (MLint inputIndex, bool getReal=false) const
PagedImage *	getUpdatedInputImage (MLint inputIndex, bool getReal=false) const
MLErrorCode	processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
MLErrorCode	processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
MLErrorCode	processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
void	clearOutputImage (MLint i=0)
	Clears cached output image pages of output image `i`.
MLint	getOutputImageInplace (MLint outputIndex=0) const
MLint	getBypass (MLint outputIndex=0) const
THREAD_SUPPORT	getThreadSupport () const
bool	areRecursiveHandleNotificationsPermitted () const
MLint	getHandleNotificationEntryCounter () const
PERMITTED_TYPES	getVoxelDataTypeSupport () const
bool	isSupportedVoxelDataType (MLDataType dt) const
virtual INPUT_HANDLE	handleInput (int, INPUT_STATE) const
INPUT_STATE	getInputState (MLint index)
INPUT_STATE	getUpdatedInputState (MLint index)
bool	isInputImageField (Field *field) const
void	touchOutputImageFields () const
	Touches all output image fields to indicate that the images have changed.
virtual void	beginSaveFields ()
virtual void	endSaveFields ()
Public Member Functions inherited from ml::FieldContainer
	FieldContainer ()
	Constructor.
	~FieldContainer () override
	Destructor: Deletes all added fields.
std::string	whoAmI (bool withInstanceName=true) const
Field *	addField (const char name, const char type, const char *value)
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)
EnumField *	addEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
template<typename EnumType>
TypedEnumField< EnumType > *	addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue)
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)
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
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)
std::string	getFieldStringValue (const std::string &name) const
virtual void	deactivateAttachments ()
Public Member Functions inherited from ml::Base
	Base ()
	Constructor.
virtual	~Base ()
	Destructor.
virtual Base *	deepCopy () const
bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.
virtual std::string	detailString () const
virtual bool	implementsPersistence (PersistenceInterface) const
virtual std::string	persistentState () const
	Returns a string describing the object's internal state.
virtual void	setPersistentState (const std::string &state)
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
virtual void	readFrom (AbstractPersistenceInputStream *, int)
Public Member Functions inherited from ml::CSOGeneratorBase
	CSOGeneratorBase ()
	Default constructor.
virtual	~CSOGeneratorBase ()=default
CSO *	generatorAddCSO (CSOList *csoList, bool useUndoRedo=true)
CSO *	generatorAddCSONoEvent (CSOList *csoList, bool useUndoRedo=true, bool sendEvent=false)
	See generatorAddCSO, but no CSOGroup scope event is emitted. (So this method is faster!).
CSOGroup *	generatorGetParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false)
	Returns the parent CSOGroup according to current CSOGroup settings.
void	generatorEmptyGroupOnDemand (CSOList *csoList)
	Empties a CSOGroup on demand of the given CSOList with the set label.

Protected Member Functions
CSO *	_addCSO (CSOList *csoList, bool useUndoRedo=true)
CSO *	_addCSONoEvent (CSOList *csoList, bool useUndoRedo=true)
	See _addCSO, but without CSOGroup event. (This method is faster!).
CSOGroup *	_getParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false)
	Returns the parent CSOGroup according to current CSOGroup settings.
void	_emptyGroupOnDemand (CSOList *csoList)
	Empties a CSOGroup on demand of the given CSOList with the set label.
int	getModuleCreatorId () const override
	Returns the module's creator ID.
std::string	getModuleType () const override
	Returns the module's type string.
bool	getShouldEmptyBeforeGeneration () const override
int	getAddCSOToGroupMode () const override
	Returns the CSOGroup generation mode.
std::string	getAddCSOToGroupLabel () const override
	Returns the label string of a target CSOGroup.
int	getAddCSOToGroupId () const override
	Returns the ID of a target CSOGroup.
int	getDefaultPathPointStyle () const override
	Returns the set default path point style for a new CSO.
float	getDefaultPathPointWidth () const override
	Returns the set default path point width for a new CSO.
Vector3	getDefaultPathPointColor () const override
	Returns the set default path point color for a new CSO.
float	getDefaultPathPointAlpha () const override
	Returns the set default path point alpha for a new CSO.
int	getDefaultSeedPointStyle () const override
	Returns the set default seed point style for a new CSO.
float	getDefaultSeedPointSize () const override
	Returns the set default seed point size for a new CSO.
Vector3	getDefaultSeedPointColor () const override
	Returns the set default seed point color for a new CSO.
float	getDefaultSeedPointAlpha () const override
	Returns the set default seed point alpha for a new CSO.
int	getDefaultVoxelWriteMode () const override
	Returns the set default voxel write mode for a new CSO.
float	getDefaultVoxelWriteValue () const override
	Returns the set default voxel write value for a new CSO.
	~CSOGenerator () override
	Destructor.
Protected Member Functions inherited from ml::CSOBaseModule
	~CSOBaseModule () override
	Standard destructor.
void	activateAttachments () override
	Initializes the module after loading.
void	handleNotification (Field *field) override
	Called when input changes.
virtual bool	_useLegacyAutoApplyMode () const
void	_setIsProcessingFlag (bool newProcessingState)
	Sets the isProcessing field if the processing state has changed.
	ML_MODULE_CLASS_HEADER (CSOBaseModule)
Protected Member Functions inherited from ml::Module
void	handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
virtual CalculateOutputImageHandler *	createCalculateOutputImageHandler (PagedImage *outputImage)
virtual void	calculateOutputImageProperties (int outputIndex, PagedImage *outputImage)
virtual SubImageBox	calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int)
virtual void	calculateOutputSubImage (SubImage outputSubImage, int outputIndex, SubImage inputSubImages)
virtual void	provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &)
void	handleNotificationOff ()
void	handleNotificationOn ()
bool	isHandleNotificationOn ()
	Returns `true` if handleNotification calls are permitted; otherwise, it returns `false`.
void	setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
void	unsetOutputImageInplace (MLint outputIndex=0)
void	setBypass (MLint outputIndex=0, MLint inputIndex=0)
void	setClampPagesToImageExtent (bool flag=true)
void	setThreadSupport (THREAD_SUPPORT supportMode)
void	permitRecursiveHandleNotifications (bool enable)
void	setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)

Protected Attributes
BoolField *	_emptyGroupBeforeGenerationFld
TypedEnumField< CSOAddToGroupModes > *	_addCSOToGroupMode
	Defines whether the CSOs are added to a CSOGroup and how the CSOGroup is identified.
StringField *	_addCSOToGroupWithLabelFld
IntField *	_addCSOToGroupWithIdFld
IntField *	_idFld
TypedEnumField< CSOPathPointsStyle > *	_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.
TypedEnumField< CSOSeedPointStyle > *	_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.
TypedEnumField< CSOVoxelWriteModes > *	_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.
Protected Attributes inherited from ml::CSOBaseModule
TypedEnumField< CSOUpdateModes > *	_updateModeFld
	Enumeration field for update modes.
BoolField *	_autoApplyFld
NotifyField *	_applyFld
	Applies changes.
BoolField *	_isProcessingFld
	Field reflects whether the module is currently processing.
NotifyField *	_doneFld
	Notifies the application or other modules that the processing has ended.
std::string	_type

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)
static MLErrorCode	getTile (PagedImage image, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB progressCallback=nullptr, void *progressCallbackUserData=nullptr)
static MLErrorCode	updateImageProperties (PagedImage *image)
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))
static std::string	getVoxelValueAsString (PagedImage image, const ImageVector &position, MLErrorCode errorCode=nullptr, const std::string &errorResult="")
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 ()
Protected Types inherited from ml::Module
enum	THREAD_SUPPORT { NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD }

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 28 of file CSOGenerator.h.

Constructor & Destructor Documentation

◆ CSOGenerator()

ml::CSOGenerator::CSOGenerator	(	std::string	type = "CSOGenerator",
		int	numInImg = 0,
		int	numOutImg = 0 )

Constructor.

Referenced by ~CSOGenerator().

◆ ~CSOGenerator()

ml::CSOGenerator::~CSOGenerator ( )

overrideprotected

Destructor.

References CSOGenerator().

Member Function Documentation

◆ _addCSO()

CSO * ml::CSOGenerator::_addCSO	(	CSOList *	csoList,
		bool	useUndoRedo = true )

inlineprotected

Adds a new CSO to the CSOList. The method returns a pointer to the newly generated CSO if the according grouping rule allows that or nullptr if no new CSO could be created for that particular CSOGroup.

Definition at line 102 of file CSOGenerator.h.

References ml::CSOGeneratorBase::generatorAddCSO().

◆ _addCSONoEvent()

CSO * ml::CSOGenerator::_addCSONoEvent	(	CSOList *	csoList,
		bool	useUndoRedo = true )

inlineprotected

See _addCSO, but without CSOGroup event. (This method is faster!).

Definition at line 104 of file CSOGenerator.h.

References ml::CSOGeneratorBase::generatorAddCSONoEvent().

◆ _emptyGroupOnDemand()

void ml::CSOGenerator::_emptyGroupOnDemand ( CSOList * csoList )

inlineprotected

Empties a CSOGroup on demand of the given CSOList with the set label.

Definition at line 108 of file CSOGenerator.h.

References ml::CSOGeneratorBase::generatorEmptyGroupOnDemand().

◆ _getParentGroup()

CSOGroup * ml::CSOGenerator::_getParentGroup	(	CSOList *	csoList,
		bool	useUndoRedo = false,
		bool	generate = false )

inlineprotected

Returns the parent CSOGroup according to current CSOGroup settings.

Definition at line 106 of file CSOGenerator.h.

References ml::CSOGeneratorBase::generatorGetParentGroup().

◆ getAddCSOToGroupId()

int ml::CSOGenerator::getAddCSOToGroupId ( ) const

inlineoverrideprotectedvirtual

Returns the ID of a target CSOGroup.

Implements ml::CSOGeneratorBase.

Definition at line 123 of file CSOGenerator.h.

References _addCSOToGroupWithIdFld.

◆ getAddCSOToGroupLabel()

std::string ml::CSOGenerator::getAddCSOToGroupLabel ( ) const

inlineoverrideprotectedvirtual

Returns the label string of a target CSOGroup.

Implements ml::CSOGeneratorBase.

Definition at line 121 of file CSOGenerator.h.

References _addCSOToGroupWithLabelFld.

◆ getAddCSOToGroupMode()

int ml::CSOGenerator::getAddCSOToGroupMode ( ) const

inlineoverrideprotectedvirtual

Returns the CSOGroup generation mode.

Implements ml::CSOGeneratorBase.

Definition at line 119 of file CSOGenerator.h.

References _addCSOToGroupMode.

◆ getDefaultPathPointAlpha()

float ml::CSOGenerator::getDefaultPathPointAlpha ( ) const

inlineoverrideprotectedvirtual

Returns the set default path point alpha for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 132 of file CSOGenerator.h.

References _pathPointAlphaFld.

◆ getDefaultPathPointColor()

Vector3 ml::CSOGenerator::getDefaultPathPointColor ( ) const

inlineoverrideprotectedvirtual

Returns the set default path point color for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 130 of file CSOGenerator.h.

References _pathPointColorFld.

◆ getDefaultPathPointStyle()

int ml::CSOGenerator::getDefaultPathPointStyle ( ) const

inlineoverrideprotectedvirtual

Returns the set default path point style for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 126 of file CSOGenerator.h.

References _pathPointStyleFld.

◆ getDefaultPathPointWidth()

float ml::CSOGenerator::getDefaultPathPointWidth ( ) const

inlineoverrideprotectedvirtual

Returns the set default path point width for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 128 of file CSOGenerator.h.

References _pathPointWidthFld.

◆ getDefaultSeedPointAlpha()

float ml::CSOGenerator::getDefaultSeedPointAlpha ( ) const

inlineoverrideprotectedvirtual

Returns the set default seed point alpha for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 141 of file CSOGenerator.h.

References _seedPointAlphaFld.

◆ getDefaultSeedPointColor()

Vector3 ml::CSOGenerator::getDefaultSeedPointColor ( ) const

inlineoverrideprotectedvirtual

Returns the set default seed point color for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 139 of file CSOGenerator.h.

References _seedPointColorFld.

◆ getDefaultSeedPointSize()

float ml::CSOGenerator::getDefaultSeedPointSize ( ) const

inlineoverrideprotectedvirtual

Returns the set default seed point size for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 137 of file CSOGenerator.h.

References _seedPointSizeFld.

◆ getDefaultSeedPointStyle()

int ml::CSOGenerator::getDefaultSeedPointStyle ( ) const

inlineoverrideprotectedvirtual

Returns the set default seed point style for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 135 of file CSOGenerator.h.

References _seedPointStyleFld.

◆ getDefaultVoxelWriteMode()

int ml::CSOGenerator::getDefaultVoxelWriteMode ( ) const

inlineoverrideprotectedvirtual

Returns the set default voxel write mode for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 144 of file CSOGenerator.h.

References _voxelWriteModeFld.

◆ getDefaultVoxelWriteValue()

float ml::CSOGenerator::getDefaultVoxelWriteValue ( ) const

inlineoverrideprotectedvirtual

Returns the set default voxel write value for a new CSO.

Implements ml::CSOGeneratorBase.

Definition at line 146 of file CSOGenerator.h.

References _voxelWriteValueFld.

◆ getModuleCreatorId()

int ml::CSOGenerator::getModuleCreatorId ( ) const

inlineoverrideprotectedvirtual

Returns the module's creator ID.

Implements ml::CSOGeneratorBase.

Definition at line 111 of file CSOGenerator.h.

References _idFld.

◆ getModuleType()

std::string ml::CSOGenerator::getModuleType ( ) const

inlineoverrideprotectedvirtual

Returns the module's type string.

Implements ml::CSOGeneratorBase.

Definition at line 113 of file CSOGenerator.h.

References getType().

◆ getShouldEmptyBeforeGeneration()

bool ml::CSOGenerator::getShouldEmptyBeforeGeneration ( ) const

inlineoverrideprotectedvirtual

Returns whether the module should empty a CSOGroup before generating CSOs into it.

Implements ml::CSOGeneratorBase.

Definition at line 117 of file CSOGenerator.h.

References _emptyGroupBeforeGenerationFld.

◆ getType()

std::string ml::CSOGenerator::getType ( ) const

inline

Returns the type of the CSOGenerator.

Definition at line 37 of file CSOGenerator.h.

References ml::CSOBaseModule::_type.

Referenced by getModuleType().

Member Data Documentation

◆ _addCSOToGroupMode

TypedEnumField<CSOAddToGroupModes>* ml::CSOGenerator::_addCSOToGroupMode

protected

Defines whether the CSOs are added to a CSOGroup and how the CSOGroup is identified.

Definition at line 48 of file CSOGenerator.h.

Referenced by getAddCSOToGroupMode().

◆ _addCSOToGroupWithIdFld

IntField* ml::CSOGenerator::_addCSOToGroupWithIdFld

protected

This ID defines the CSOGroup the generator should add its created CSOs to. If left empty, the CSO is not added to any CSOGroup.

Definition at line 56 of file CSOGenerator.h.

Referenced by getAddCSOToGroupId().

◆ _addCSOToGroupWithLabelFld

StringField* ml::CSOGenerator::_addCSOToGroupWithLabelFld

protected

This label defines the CSOGroup the generator should add its created CSOs to. If left empty, the CSO is not added to any CSOGroup.

Definition at line 52 of file CSOGenerator.h.

Referenced by getAddCSOToGroupLabel().

◆ _emptyGroupBeforeGenerationFld

BoolField* ml::CSOGenerator::_emptyGroupBeforeGenerationFld

protected

If checked and a CSOGroup name is provided, the CSOGroup is emptied before a new generation.

Definition at line 45 of file CSOGenerator.h.

Referenced by getShouldEmptyBeforeGeneration().

◆ _idFld

IntField* ml::CSOGenerator::_idFld

protected

The ID of this processor. This can be used to differentiate similar generators from each other.

Definition at line 60 of file CSOGenerator.h.

Referenced by getModuleCreatorId().

◆ _pathPointAlphaFld

FloatField* ml::CSOGenerator::_pathPointAlphaFld

protected

The path point's alpha value. Default is 1.

Definition at line 69 of file CSOGenerator.h.

Referenced by getDefaultPathPointAlpha().

◆ _pathPointColorFld

ColorField* ml::CSOGenerator::_pathPointColorFld

protected

The path point's color. Default is yellow.

Definition at line 67 of file CSOGenerator.h.

Referenced by getDefaultPathPointColor().

◆ _pathPointStyleFld

TypedEnumField<CSOPathPointsStyle>* ml::CSOGenerator::_pathPointStyleFld

protected

The path point's line style (none, solid, dashed, dotted). Default is 'solid'.

Definition at line 63 of file CSOGenerator.h.

Referenced by getDefaultPathPointStyle().

◆ _pathPointWidthFld

FloatField* ml::CSOGenerator::_pathPointWidthFld

protected

The path point's line width. Default is 1.

Definition at line 65 of file CSOGenerator.h.

Referenced by getDefaultPathPointWidth().

◆ _seedPointAlphaFld

FloatField* ml::CSOGenerator::_seedPointAlphaFld

protected

The marker's alpha value. Default is 1.

Definition at line 78 of file CSOGenerator.h.

Referenced by getDefaultSeedPointAlpha().

◆ _seedPointColorFld

ColorField* ml::CSOGenerator::_seedPointColorFld

protected

The marker's color. Default is green.

Definition at line 76 of file CSOGenerator.h.

Referenced by getDefaultSeedPointColor().

◆ _seedPointSizeFld

FloatField* ml::CSOGenerator::_seedPointSizeFld

protected

The marker's size. Default is 3.

Definition at line 74 of file CSOGenerator.h.

Referenced by getDefaultSeedPointSize().

◆ _seedPointStyleFld

TypedEnumField<CSOSeedPointStyle>* ml::CSOGenerator::_seedPointStyleFld

protected

The marker's mode (none, rect, circle). Default is 'rect'.

Definition at line 72 of file CSOGenerator.h.

Referenced by getDefaultSeedPointStyle().

◆ _voxelWriteModeFld

TypedEnumField<CSOVoxelWriteModes>* ml::CSOGenerator::_voxelWriteModeFld

protected

The CSO's voxel write mode (module, const, const plus ID, ID). Default is 'module'.

Definition at line 81 of file CSOGenerator.h.

Referenced by getDefaultVoxelWriteMode().

◆ _voxelWriteValueFld

FloatField* ml::CSOGenerator::_voxelWriteValueFld

protected

The CSO's voxel write value. Default is 1024.

Definition at line 83 of file CSOGenerator.h.

Referenced by getDefaultVoxelWriteValue().

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

MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOModuleBase/CSOGenerator.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSOGenerator()

◆ ~CSOGenerator()

Member Function Documentation

◆ _addCSO()

◆ _addCSONoEvent()

◆ _emptyGroupOnDemand()

◆ _getParentGroup()

◆ getAddCSOToGroupId()

◆ getAddCSOToGroupLabel()

◆ getAddCSOToGroupMode()

◆ getDefaultPathPointAlpha()

◆ getDefaultPathPointColor()

◆ getDefaultPathPointStyle()

◆ getDefaultPathPointWidth()

◆ getDefaultSeedPointAlpha()

◆ getDefaultSeedPointColor()

◆ getDefaultSeedPointSize()

◆ getDefaultSeedPointStyle()

◆ getDefaultVoxelWriteMode()

◆ getDefaultVoxelWriteValue()

◆ getModuleCreatorId()

◆ getModuleType()

◆ getShouldEmptyBeforeGeneration()

◆ getType()

Member Data Documentation

◆ _addCSOToGroupMode

◆ _addCSOToGroupWithIdFld

◆ _addCSOToGroupWithLabelFld

◆ _emptyGroupBeforeGenerationFld

◆ _idFld

◆ _pathPointAlphaFld

◆ _pathPointColorFld

◆ _pathPointStyleFld

◆ _pathPointWidthFld

◆ _seedPointAlphaFld

◆ _seedPointColorFld

◆ _seedPointSizeFld

◆ _seedPointStyleFld

◆ _voxelWriteModeFld

◆ _voxelWriteValueFld