ml::CSOGeneratorBase Class Reference

#include <CSOGeneratorBase.h>

Inheritance diagram for ml::CSOGeneratorBase:

Public Member Functions
	CSOGeneratorBase ()
	Default constructor.
virtual	~CSOGeneratorBase ()=default
CSO *	generatorAddCSO (CSOList *csoList, bool useUndoRedo=true)
	Adds a new CSO to the CSOList.
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.
virtual int	getModuleCreatorId () const =0
	Returns the module's creator ID.
virtual std::string	getModuleType () const =0
	Returns the module's type string.
virtual bool	getShouldEmptyBeforeGeneration () const =0
	Returns whether the module should empty a CSOGroup before generating CSOs into it.
virtual int	getAddCSOToGroupMode () const =0
	Returns the CSOGroup generation mode.
virtual std::string	getAddCSOToGroupLabel () const =0
	Returns the label string of a target CSOGroup.
virtual int	getAddCSOToGroupId () const =0
	Returns the ID of a target CSOGroup.
virtual int	getDefaultPathPointStyle () const =0
	Returns the set default path point style for a new CSO.
virtual float	getDefaultPathPointWidth () const =0
	Returns the set default path point width for a new CSO.
virtual Vector3	getDefaultPathPointColor () const =0
	Returns the set default path point color for a new CSO.
virtual float	getDefaultPathPointAlpha () const =0
	Returns the set default path point alpha for a new CSO.
virtual int	getDefaultSeedPointStyle () const =0
	Returns the set default seed point style for a new CSO.
virtual float	getDefaultSeedPointSize () const =0
	Returns the set default seed point size for a new CSO.
virtual Vector3	getDefaultSeedPointColor () const =0
	Returns the set default seed point color for a new CSO.
virtual float	getDefaultSeedPointAlpha () const =0
	Returns the set default seed point alpha for a new CSO.
virtual int	getDefaultVoxelWriteMode () const =0
	Returns the set default voxel write mode for a new CSO.
virtual float	getDefaultVoxelWriteValue () const =0
	Returns the set default voxel write value for a new CSO.

Detailed Description

Definition at line 38 of file CSOGeneratorBase.h.

Constructor & Destructor Documentation

CSOGeneratorBase()

ml::CSOGeneratorBase::CSOGeneratorBase

(

)

Default constructor.

~CSOGeneratorBase()

virtual ml::CSOGeneratorBase::~CSOGeneratorBase ( )

virtualdefault

Member Function Documentation

generatorAddCSO()

CSO * ml::CSOGeneratorBase::generatorAddCSO	(	CSOList *	csoList,
		bool	useUndoRedo = true
	)

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.

Referenced by ml::CSOGenerator::_addCSO(), and SoCSOCreatorEditorExtension::editorAddCSO().

generatorAddCSONoEvent()

CSO * ml::CSOGeneratorBase::generatorAddCSONoEvent	(	CSOList *	csoList,
		bool	useUndoRedo = true,
		bool	sendEvent = false
	)

See generatorAddCSO, but no CSOGroup scope event is emitted. (So this method is faster!)

Referenced by ml::CSOGenerator::_addCSONoEvent().

generatorEmptyGroupOnDemand()

void ml::CSOGeneratorBase::generatorEmptyGroupOnDemand

(

CSOList *

csoList

)

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

Referenced by ml::CSOGenerator::_emptyGroupOnDemand(), and SoCSOCreatorEditorExtension::editorAddCSO().

generatorGetParentGroup()

CSOGroup * ml::CSOGeneratorBase::generatorGetParentGroup	(	CSOList *	csoList,
		bool	useUndoRedo = false,
		bool	generate = false
	)

Returns the parent CSOGroup according to current CSOGroup settings.

Referenced by ml::CSOGenerator::_getParentGroup().

getAddCSOToGroupId()

virtual int ml::CSOGeneratorBase::getAddCSOToGroupId ( ) const

pure virtual

Returns the ID of a target CSOGroup.

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getAddCSOToGroupLabel()

virtual std::string ml::CSOGeneratorBase::getAddCSOToGroupLabel ( ) const

pure virtual

Returns the label string of a target CSOGroup.

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getAddCSOToGroupMode()

virtual int ml::CSOGeneratorBase::getAddCSOToGroupMode ( ) const

pure virtual

Returns the CSOGroup generation mode.

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultPathPointAlpha()

virtual float ml::CSOGeneratorBase::getDefaultPathPointAlpha ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultPathPointColor()

virtual Vector3 ml::CSOGeneratorBase::getDefaultPathPointColor ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultPathPointStyle()

virtual int ml::CSOGeneratorBase::getDefaultPathPointStyle ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultPathPointWidth()

virtual float ml::CSOGeneratorBase::getDefaultPathPointWidth ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultSeedPointAlpha()

virtual float ml::CSOGeneratorBase::getDefaultSeedPointAlpha ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultSeedPointColor()

virtual Vector3 ml::CSOGeneratorBase::getDefaultSeedPointColor ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultSeedPointSize()

virtual float ml::CSOGeneratorBase::getDefaultSeedPointSize ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultSeedPointStyle()

virtual int ml::CSOGeneratorBase::getDefaultSeedPointStyle ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultVoxelWriteMode()

virtual int ml::CSOGeneratorBase::getDefaultVoxelWriteMode ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getDefaultVoxelWriteValue()

virtual float ml::CSOGeneratorBase::getDefaultVoxelWriteValue ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getModuleCreatorId()

virtual int ml::CSOGeneratorBase::getModuleCreatorId ( ) const

pure virtual

Returns the module's creator ID.

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getModuleType()

virtual std::string ml::CSOGeneratorBase::getModuleType ( ) const

pure virtual

Returns the module's type string.

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

getShouldEmptyBeforeGeneration()

virtual bool ml::CSOGeneratorBase::getShouldEmptyBeforeGeneration ( ) const

pure virtual

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

Implemented in SoCSOCreatorEditorExtension, and ml::CSOGenerator.

---

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

• MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOModuleBase/CSOGeneratorBase.h