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.
Static Public Attributes
static const char *	addCSOToGroupModeStrings [3]
	Strings for add to group mode enumerations.
Protected Member Functions
CSO *	_addCSO (CSOList *csoList, std::string groupLabel, bool useUndoRedo=true)
	Adds a new CSO to the CSOList and puts it into the group given by the label string.
CSOGroup *	_getParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false)
	Returns the parent group according to current group settings.
void	_emptyGroupOnDemand (CSOList *csoList)
	Empties a group on demand of the given CSOList with the set label.
virtual int	getModuleCreatorId () const
	Returns the module's creator id.
virtual std::string	getModuleType () const
	Returns the module's type string.
virtual bool	getShouldEmptyBeforeGeneration () const
	Returns whether the module should empty a group before generating CSOs into it.
virtual int	getAddCSOToGroupMode () const
	Returns the group generation mode.
virtual std::string	getAddCSOToGroupLabel () const
	Returns the label string of a target group.
virtual int	getAddCSOToGroupId () const
	Returns the id of a target group.
virtual int	getDefaultPathPointStyle () const
	Returns the set default path point style for a new CSO.
virtual float	getDefaultPathPointWidth () const
	Returns the set default path point width for a new CSO.
virtual Vector3	getDefaultPathPointColor () const
	Returns the set default path point color for a new CSO.
virtual float	getDefaultPathPointAlpha () const
	Returns the set default path point alpha for a new CSO.
virtual int	getDefaultSeedPointStyle () const
	Returns the set default seed point style for a new CSO.
virtual float	getDefaultSeedPointSize () const
	Returns the set default seed point size for a new CSO.
virtual Vector3	getDefaultSeedPointColor () const
	Returns the set default seed point color for a new CSO.
virtual float	getDefaultSeedPointAlpha () const
	Returns the set default seed point alpha for a new CSO.
virtual int	getDefaultVoxelWriteMode () const
	Returns the set default voxel write mode for a new CSO.
virtual float	getDefaultVoxelWriteValue () const
	Returns the set default voxel write value for a new CSO.
virtual	~CSOGenerator ()
	Destructor.
Protected Attributes
BoolField *	_emptyGroupBeforeGenerationFld
	If checked and a group name is provided, the group is emptied before a new generation.
EnumField *	_addCSOToGroupMode
	Defines if the CSOs are added to a group and how the group is identified.
StringField *	_addCSOToGroupWithLabelFld
	This label defines the group the generator should add its created CSOs to.
IntField *	_addCSOToGroupWithIdFld
	This id defines the group the generator should add its created CSOs to.
IntField *	_idFld
	The id of this processor.
EnumField *	_pathPointStyleFld
	The path point's line style (none, solid, dashed, dotted). Default is 'solid'.
FloatField *	_pathPointWidthFld
	The path point's line width. Default is 1.
ColorField *	_pathPointColorFld
	The path point's color. Default is yellow.
FloatField *	_pathPointAlphaFld
	The path point's alpha value. Default is 1.
EnumField *	_seedPointStyleFld
	The marker's mode (none, rect, circle). Default is 'rect'.
FloatField *	_seedPointSizeFld
	The marker's size. Default is 3.
ColorField *	_seedPointColorFld
	The marker's color. Default is green.
FloatField *	_seedPointAlphaFld
	The marker's alpha value. Default is 1.
EnumField *	_voxelWriteModeFld
	The CSO's voxel write mode (module, const, const plus id, id). Default is 'module'.
FloatField *	_voxelWriteValueFld
	The CSO's voxel write value. Default is 1024.

Detailed Description

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

Basically it determines the type of the CSO and an id that can be used to associate CSOs with their generator.

Definition at line 24 of file CSOGenerator.h.

Constructor & Destructor Documentation

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

Constructor.

virtual ml::CSOGenerator::~CSOGenerator ( ) [protected, virtual]

Destructor.

Member Function Documentation

CSO* ml::CSOGenerator::_addCSO	(	CSOList *	csoList,
		std::string	groupLabel,
		bool	useUndoRedo = `true`
	)		`[inline, protected]`

Adds a new CSO to the CSOList and puts it into the group given by the label string.

If the label string is empty, the new CSO is not put in any group. If no group exists with the given label, a new group is generated and the CSO gets associated with that. The method returns a pointer to the newly generated CSO if the according grouping rule allows that or NULL if no new CSO could be created for that particular group.

Definition at line 105 of file CSOGenerator.h.

References ml::CSOGeneratorBase::generatorAddCSO().

void ml::CSOGenerator::_emptyGroupOnDemand ( CSOList * csoList ) [inline, protected]

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

Definition at line 109 of file CSOGenerator.h.

References ml::CSOGeneratorBase::generatorEmptyGroupOnDemand().