MeVisLabToolboxReference
ml::CSOGeneratorBase Class Reference

#include <CSOGeneratorBase.h>

Inheritance diagram for ml::CSOGeneratorBase:
ml::CSOGenerator SoCSOCreatorEditorExtension ml::CSOModificator ml::CSOProcessor SoCSODistanceLineEditor SoCSOEllipseEditor SoCSOLineCreatorEditorExtension SoCSOPointEditor ml::CSOBulgeProcessor ml::CSOFreehandProcessor ml::CSOIsoProcessor ml::CSOLiveWireProcessor ml::CSOModifyProcessor ml::CSOPrimitiveProcessor ml::CSOTransformationProcessor SoCSODistancePolylineEditor SoCSOPolygonEditor SoCSOSplineEditor

List of all members.

Public Member Functions

 CSOGeneratorBase ()
 Default constructor.
CSOgeneratorAddCSO (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.
CSOGroupgeneratorGetParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false)
 Returns the parent group according to current group settings.
void generatorEmptyGroupOnDemand (CSOList *csoList)
 Empties a group 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 group before generating CSOs into it.
virtual int getAddCSOToGroupMode () const =0
 Returns the group generation mode.
virtual std::string getAddCSOToGroupLabel () const =0
 Returns the label string of a target group.
virtual int getAddCSOToGroupId () const =0
 Returns the id of a target group.
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 32 of file CSOGeneratorBase.h.


Constructor & Destructor Documentation

ml::CSOGeneratorBase::CSOGeneratorBase ( )

Default constructor.


Member Function Documentation

CSO* ml::CSOGeneratorBase::generatorAddCSO ( 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.

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.

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

void ml::CSOGeneratorBase::generatorEmptyGroupOnDemand ( CSOList csoList)

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

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

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

Returns the parent group according to current group settings.

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

virtual int ml::CSOGeneratorBase::getAddCSOToGroupId ( ) const [pure virtual]

Returns the id of a target group.

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual std::string ml::CSOGeneratorBase::getAddCSOToGroupLabel ( ) const [pure virtual]

Returns the label string of a target group.

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual int ml::CSOGeneratorBase::getAddCSOToGroupMode ( ) const [pure virtual]

Returns the group generation mode.

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual float ml::CSOGeneratorBase::getDefaultPathPointAlpha ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual Vector3 ml::CSOGeneratorBase::getDefaultPathPointColor ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual int ml::CSOGeneratorBase::getDefaultPathPointStyle ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual float ml::CSOGeneratorBase::getDefaultPathPointWidth ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual float ml::CSOGeneratorBase::getDefaultSeedPointAlpha ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual Vector3 ml::CSOGeneratorBase::getDefaultSeedPointColor ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual float ml::CSOGeneratorBase::getDefaultSeedPointSize ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual int ml::CSOGeneratorBase::getDefaultSeedPointStyle ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual int ml::CSOGeneratorBase::getDefaultVoxelWriteMode ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual float ml::CSOGeneratorBase::getDefaultVoxelWriteValue ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual int ml::CSOGeneratorBase::getModuleCreatorId ( ) const [pure virtual]

Returns the module's creator id.

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual std::string ml::CSOGeneratorBase::getModuleType ( ) const [pure virtual]

Returns the module's type string.

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.

virtual bool ml::CSOGeneratorBase::getShouldEmptyBeforeGeneration ( ) const [pure virtual]

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

Implemented in ml::CSOGenerator, and SoCSOCreatorEditorExtension.


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