#include <mlCSOGroupWrapper.h>

Inherits QObject.

Detailed Description

A class that wraps CSOGroup objects for use in scripting.

Member Enumeration Documentation

◆ CSOGroupOverflowHandling

enum MLCSOGroupWrapper::CSOGroupOverflowHandling

Enumeration for the group overflow handling modes.

Enumerator
OVERFLOW_DELETE_FIRST	If a CSOGroup is full, the first CSO in the group is replaced by the newly generated CSO.
OVERFLOW_DELETE_LAST	If a CSOGroup is full, the last CSO in the group is replaced by the newly generated CSO.
OVERFLOW_DELETE_ALL	If a CSOGroup is full, all CSOs in the group are deleted.
OVERFLOW_IGNORE_NEW	If a CSOGroup is full, one can not generate a new one.
NUM_OVERFLOW_MODES	Number of modes.

◆ CSORemoveHandling

enum MLCSOGroupWrapper::CSORemoveHandling

Enumeration for the removal handling of CSOs from group and if group is deleted.

Enumerator
REMOVE_ALWAYS	If a CSO is removed from a group, it is also deleted from the list.
REMOVE_NEVER	If a CSO is removed from a group, it is not deleted from the list.
REMOVE_IF_IN_NO_GROUP	If a CSO is removed from a group, it is only deleted from the list if it is in no group anymore.
NUM_REMOVE_MODES	Number of modes.

◆ CSOVoxelWriteMode

enum MLCSOGroupWrapper::CSOVoxelWriteMode

Voxel write mode used for setVoxelWriteMode.

Enumerator
VOXEL_WRITE_ID	If a CSO is voxelized, its ID (or the group ID) is written into the image.
VOXEL_WRITE_CONST	If a CSO is voxelized, this constant is written into the image.
VOXEL_WRITE_CONST_PLUS_ID	If a CSO is voxelized, its ID (or the group ID) added to the constant value is written into the image.
VOXEL_WRITE_MODULE	A CSO (-Group) with this value is voxelized with the according module's values. This is the default setting.

Member Function Documentation

◆ addCSO

bool MLCSOGroupWrapper::addCSO	(	int	id,
		bool	useUndoRedo = `true`
	)

slot

Adds the CSO with the given ID to this group. Returns false if the CSO ID is invalid.

◆ contains

bool MLCSOGroupWrapper::contains ( ml::CSO * cso ) const

slot

Returns whether this group contains the given CSO.

◆ containsCSOWithId

bool MLCSOGroupWrapper::containsCSOWithId ( int csoId ) const

slot

Returns whether this group contains the given CSO.

◆ getBoundingBox

QVariantList MLCSOGroupWrapper::getBoundingBox ( ) const

slot

Returns the unified bounding box of all contained CSOs.

◆ getCSOAt

MLCSOWrapper * MLCSOGroupWrapper::getCSOAt ( unsigned int index ) const

slot

Returns a pointer to the CSO at the given index. Beware: no index check.

◆ getCSOIdAt

unsigned int MLCSOGroupWrapper::getCSOIdAt ( unsigned int index ) const

slot

Returns the ID of an associated CSO at the given index. Beware: no index check.

◆ getCSOList

MLCSOListWrapper * MLCSOGroupWrapper::getCSOList ( ) const

slot

Returns a pointer to the embracing CSOList of this Group.

◆ getDeleteGroupCSOHandling

CSORemoveHandling MLCSOGroupWrapper::getDeleteGroupCSOHandling ( )

slot

Returns the 'deleteGroupCSOHandling' mode.

◆ getDescription

QString MLCSOGroupWrapper::getDescription ( ) const

slot

Returns the group description.

◆ getEditableState

bool MLCSOGroupWrapper::getEditableState ( ) const

slot

Returns the 'editable' status of this group.

◆ getId

unsigned int MLCSOGroupWrapper::getId ( ) const

slot

Returns the ID of this group.

◆ getLabel

QString MLCSOGroupWrapper::getLabel ( ) const

slot

Returns the group label.

◆ getNumCSOs

int MLCSOGroupWrapper::getNumCSOs ( ) const

slot

Returns the number of CSOs in this group.

◆ getNumMaximumCSOs

unsigned int MLCSOGroupWrapper::getNumMaximumCSOs ( )

slot

Returns the maximum number of allowed CSOs.

◆ getOverflowHandling

CSOGroupOverflowHandling MLCSOGroupWrapper::getOverflowHandling ( )

slot

Returns the overflow handling mode.

◆ getPathPointAlpha

float MLCSOGroupWrapper::getPathPointAlpha ( ) const

slot

Returns the path point alpha value of this group.

◆ getPathPointColor

QVariantList MLCSOGroupWrapper::getPathPointColor ( ) const

slot

Returns the path point color of this group.

◆ getPathPointStyle

int MLCSOGroupWrapper::getPathPointStyle ( ) const

slot

Returns the path point style of this group.

◆ getPathPointWidth

float MLCSOGroupWrapper::getPathPointWidth ( ) const

slot

Returns the path point width value of this group.

◆ getRemoveFromGroupHandling

CSORemoveHandling MLCSOGroupWrapper::getRemoveFromGroupHandling ( )

slot

Returns the 'removeFromGroupHandling' mode.

◆ getSeedPointAlpha

float MLCSOGroupWrapper::getSeedPointAlpha ( ) const

slot

Returns the seed point alpha value of this group.

◆ getSeedPointColor

QVariantList MLCSOGroupWrapper::getSeedPointColor ( ) const

slot

Returns the seed point color of this group.

◆ getSeedPointSize

float MLCSOGroupWrapper::getSeedPointSize ( ) const

slot

Returns the seed point size value of this group.

◆ getSeedPointStyle

int MLCSOGroupWrapper::getSeedPointStyle ( ) const

slot

Returns the seed point style of this group.

◆ getShowState

bool MLCSOGroupWrapper::getShowState ( ) const

slot

Returns the 'show' status of this group.

◆ getTimePointIndex

int MLCSOGroupWrapper::getTimePointIndex ( ) const

slot

Returns the time point index of this group.

◆ getUseEditableState

bool MLCSOGroupWrapper::getUseEditableState ( ) const

slot

Returns whether this group overrides the editable state of its CSOs.

◆ getUsePathPointAlpha

bool MLCSOGroupWrapper::getUsePathPointAlpha ( ) const

slot

Returns whether this group overrides the path point alpha of its CSOs.

◆ getUsePathPointColor

bool MLCSOGroupWrapper::getUsePathPointColor ( ) const

slot

Returns whether this group overrides the path point color of its CSOs.

◆ getUsePathPointStyle

bool MLCSOGroupWrapper::getUsePathPointStyle ( ) const

slot

Returns whether this group overrides the path point style of its CSOs.

◆ getUsePathPointWidth

bool MLCSOGroupWrapper::getUsePathPointWidth ( ) const

slot

Returns whether this group overrides the path point width of its CSOs.

◆ getUserData [1/2]

QVariant MLCSOGroupWrapper::getUserData ( const QString & name ) const

slot

Returns the user data under the given name or an invalid value if the entry does not exist.

◆ getUserData [2/2]

QVariant MLCSOGroupWrapper::getUserData	(	const QString &	name,
		const QVariant &	defaultValue
	)		const

slot

Returns the user data under the given name or the given default value if the entry does not exist.

◆ getUserDataNames

QStringList MLCSOGroupWrapper::getUserDataNames ( ) const

slot

Returns the keys/names under which user data are stored for this CSO.

◆ getUseSeedPointAlpha

bool MLCSOGroupWrapper::getUseSeedPointAlpha ( ) const

slot

Returns whether this group overrides the seed point alpha of its CSOs.

◆ getUseSeedPointColor

bool MLCSOGroupWrapper::getUseSeedPointColor ( ) const

slot

Returns whether this group overrides the seed point color of its CSOs.

◆ getUseSeedPointSize

bool MLCSOGroupWrapper::getUseSeedPointSize ( ) const

slot

Returns whether this group overrides the seed point size of its CSOs.

◆ getUseSeedPointStyle

bool MLCSOGroupWrapper::getUseSeedPointStyle ( ) const

slot

Returns whether this group overrides the seed point style of its CSOs.

◆ getUseShowState

bool MLCSOGroupWrapper::getUseShowState ( ) const

slot

Returns whether this group overrides the show state of its CSOs.

◆ getUseTimePointIndex

bool MLCSOGroupWrapper::getUseTimePointIndex ( ) const

slot

Returns whether the time point index of this group should be used.

◆ getUseVoxelizeState

bool MLCSOGroupWrapper::getUseVoxelizeState ( ) const

slot

Returns whether this group overrides the voxelize state of its CSOs.

◆ getUseVoxelWriteMode

bool MLCSOGroupWrapper::getUseVoxelWriteMode ( ) const

slot

Returns whether the voxel write mode of this group should be used.

◆ getUseVoxelWriteValue

bool MLCSOGroupWrapper::getUseVoxelWriteValue ( ) const

slot

Returns whether the voxel write value of this group should be used.

◆ getVoxelizeState

bool MLCSOGroupWrapper::getVoxelizeState ( ) const

slot

Returns the 'voxelize' status of this group.

◆ getVoxelWriteMode

CSOVoxelWriteMode MLCSOGroupWrapper::getVoxelWriteMode ( ) const

slot

Returns the voxel write mode of this group.

◆ getVoxelWriteValue

float MLCSOGroupWrapper::getVoxelWriteValue ( ) const

slot

Returns the voxel write value of this group.

◆ mayAddCSO

bool MLCSOGroupWrapper::mayAddCSO ( )

slot

Checks whether a CSO could be added to this group without any rule being applied (e.g., remove another CSO).

◆ removeAllCSO

void MLCSOGroupWrapper::removeAllCSO ( )

slot

Removes all CSOs from this group.

◆ removeCSO

bool MLCSOGroupWrapper::removeCSO	(	int	id,
		bool	useUndoRedo = `true`
	)

slot

Removes the CSO with the given ID from this group.

Returns false if the CSO ID is invalid.

◆ removeUserData

void MLCSOGroupWrapper::removeUserData ( const QString & name )

slot

Removes a user data entry.

◆ resetRule

void MLCSOGroupWrapper::resetRule ( )

slot

Sets the rule to its default.

◆ setDeleteGroupCSOHandling

void MLCSOGroupWrapper::setDeleteGroupCSOHandling ( CSORemoveHandling handling )

slot

Sets the handling mode for CSOs when this group is deleted, i.e., should they also be removed from the list.

◆ setDescription

void MLCSOGroupWrapper::setDescription ( QString desc )

slot

Sets the group description.

◆ setEditableState

void MLCSOGroupWrapper::setEditableState ( bool editableState )

slot

Sets the 'editable' status of this group.

◆ setLabel

void MLCSOGroupWrapper::setLabel ( QString label )

slot

Sets the group label.

◆ setNumMaximumCSOs

void MLCSOGroupWrapper::setNumMaximumCSOs ( unsigned int numMaxCSOs )

slot

Sets the maximum number of CSOs allowed.

◆ setOverflowHandling

void MLCSOGroupWrapper::setOverflowHandling ( CSOGroupOverflowHandling handling )

slot

Sets the overflow handling, i.e., what has to done when one wants to add CSO and the maximum amount is reached.

◆ setPathPointAlpha

void MLCSOGroupWrapper::setPathPointAlpha ( float alpha )

slot

Sets the path point alpha value of this group.

◆ setPathPointColor

void MLCSOGroupWrapper::setPathPointColor ( QVariantList color )

slot

Sets the path point color of this group.

◆ setPathPointStyle

void MLCSOGroupWrapper::setPathPointStyle ( int lStyle )

slot

Sets the path point style of this group.

◆ setPathPointWidth

void MLCSOGroupWrapper::setPathPointWidth ( float lWidth )

slot

Sets the path point width value of this group.

◆ setRemoveFromGroupHandling

void MLCSOGroupWrapper::setRemoveFromGroupHandling ( CSORemoveHandling handling )

slot

Sets the handling mode for CSOs that are removed from the group, i.e., should they also be removed from the list.

◆ setSeedPointAlpha

void MLCSOGroupWrapper::setSeedPointAlpha ( float alpha )

slot

Sets the seed point alpha value of this group.

◆ setSeedPointColor

void MLCSOGroupWrapper::setSeedPointColor ( QVariantList color )

slot

Sets the seed point color of this group.

◆ setSeedPointSize

void MLCSOGroupWrapper::setSeedPointSize ( float size )

slot

Sets the seed point size value of this group.

◆ setSeedPointStyle

void MLCSOGroupWrapper::setSeedPointStyle ( int sStyle )

slot

Sets the seed point style of this group.

◆ setShowState

void MLCSOGroupWrapper::setShowState ( bool showState )

slot

Sets the 'show' status of this group.

◆ setTimePointIndex

void MLCSOGroupWrapper::setTimePointIndex ( int tPoint )

slot

Sets the time point index of this group.

◆ setUseEditableState

void MLCSOGroupWrapper::setUseEditableState ( bool useEState )

slot

Sets whether this group overrides the editable state of its CSOs.

◆ setUsePathPointAlpha

void MLCSOGroupWrapper::setUsePathPointAlpha ( bool state )

slot

Sets whether this group overrides the path point alpha of its CSOs.

◆ setUsePathPointColor

void MLCSOGroupWrapper::setUsePathPointColor ( bool state )

slot

Sets whether this group overrides the path point color of its CSOs.

◆ setUsePathPointStyle

void MLCSOGroupWrapper::setUsePathPointStyle ( bool state )

slot

Sets whether this group overrides the path point style of its CSOs.

◆ setUsePathPointWidth

void MLCSOGroupWrapper::setUsePathPointWidth ( bool state )

slot

Sets whether this group overrides the path point width of its CSOs.

◆ setUserData

void MLCSOGroupWrapper::setUserData	(	const QString &	name,
		const QVariant &	value
	)

slot

Sets or adds a user data value under the given name.

◆ setUseSeedPointAlpha

void MLCSOGroupWrapper::setUseSeedPointAlpha ( bool state )

slot

Sets whether this group overrides the seed point alpha of its CSOs.

◆ setUseSeedPointColor

void MLCSOGroupWrapper::setUseSeedPointColor ( bool state )

slot

Sets whether this group overrides the seed point color of its CSOs.

◆ setUseSeedPointSize

void MLCSOGroupWrapper::setUseSeedPointSize ( bool state )

slot

Sets whether this group overrides the seed point size of its CSOs.

◆ setUseSeedPointStyle

void MLCSOGroupWrapper::setUseSeedPointStyle ( bool state )

slot

Sets whether this group overrides the seed point style of its CSOs.

◆ setUseShowState

void MLCSOGroupWrapper::setUseShowState ( bool useSState )

slot

Sets whether this group overrides the show state of its CSOs.

◆ setUseTimePointIndex

void MLCSOGroupWrapper::setUseTimePointIndex ( bool useTimePointIndex )

slot

Sets whether the time point index of this group should be used.

◆ setUseVoxelizeState

void MLCSOGroupWrapper::setUseVoxelizeState ( bool useVState )

slot

Sets if this group overrides the voxelize state of its CSOs.

◆ setUseVoxelWriteMode

void MLCSOGroupWrapper::setUseVoxelWriteMode ( bool state )

slot

Sets whether the voxel write mode of this group should be used.

◆ setUseVoxelWriteValue

void MLCSOGroupWrapper::setUseVoxelWriteValue ( bool state )

slot

Sets whether the voxel write value of this group should be used.

◆ setVoxelizeState

void MLCSOGroupWrapper::setVoxelizeState ( bool voxelizeState )

slot

Sets the 'voxelize' status of this group.

◆ setVoxelWriteMode

void MLCSOGroupWrapper::setVoxelWriteMode ( CSOVoxelWriteMode vwM )

slot

Sets the voxel write mode of this group.

◆ setVoxelWriteValue

void MLCSOGroupWrapper::setVoxelWriteValue ( float vwV )

slot

Sets the voxel write value of this group.

Property Documentation

◆ boundingBox

QVariantList MLCSOGroupWrapper::boundingBox

read

Sets or reads the bounding box.

◆ description

QString MLCSOGroupWrapper::description

readwrite

Sets or reads the description.

◆ editableState

bool MLCSOGroupWrapper::editableState

readwrite

Sets or reads the editable state.

◆ id

int MLCSOGroupWrapper::id

read

Returns the ID.

◆ label

QString MLCSOGroupWrapper::label

readwrite

Sets or reads the label.

◆ numCSOs

int MLCSOGroupWrapper::numCSOs

read

Returns the number of CSOs in this group.

◆ pathPointAlpha

float MLCSOGroupWrapper::pathPointAlpha

readwrite

Sets or reads the path point alpha.

◆ pathPointColor

QVariantList MLCSOGroupWrapper::pathPointColor

readwrite

Sets or reads the path point color.

◆ pathPointStyle

int MLCSOGroupWrapper::pathPointStyle

readwrite

Sets or reads the path point style.

◆ pathPointWidth

float MLCSOGroupWrapper::pathPointWidth

readwrite

Sets or reads the path point width.

◆ seedPointAlpha

float MLCSOGroupWrapper::seedPointAlpha

readwrite

Sets or reads the seed point alpha.

◆ seedPointColor

QVariantList MLCSOGroupWrapper::seedPointColor

readwrite

Sets or reads the seed point color.

◆ seedPointSize

float MLCSOGroupWrapper::seedPointSize

readwrite

Sets or reads the seed point size.

◆ seedPointStyle

int MLCSOGroupWrapper::seedPointStyle

readwrite

Sets or reads the seed point style.

◆ showState

bool MLCSOGroupWrapper::showState

readwrite

Sets or reads the show state.

◆ timePointIndex

int MLCSOGroupWrapper::timePointIndex

readwrite

Sets or reads the time point index.

◆ useEditableState

bool MLCSOGroupWrapper::useEditableState

readwrite

Sets or reads whether the editable state is used.

◆ usePathPointAlpha

bool MLCSOGroupWrapper::usePathPointAlpha

readwrite

Sets or reads whether the path point alpha is used.

◆ usePathPointColor

bool MLCSOGroupWrapper::usePathPointColor

readwrite

Sets or reads whether the path point color is used.

◆ usePathPointStyle

bool MLCSOGroupWrapper::usePathPointStyle

readwrite

Sets or reads whether the path point style is used.

◆ usePathPointWidth

bool MLCSOGroupWrapper::usePathPointWidth

readwrite

Sets or reads whether the path point width is used.

◆ useSeedPointAlpha

bool MLCSOGroupWrapper::useSeedPointAlpha

readwrite

Sets or reads whether the seed point alpha is used.

◆ useSeedPointColor

bool MLCSOGroupWrapper::useSeedPointColor

readwrite

Sets or reads whether the seed point color is used.

◆ useSeedPointSize

bool MLCSOGroupWrapper::useSeedPointSize

readwrite

Sets or reads whether the seed point size is used.

◆ useSeedPointStyle

bool MLCSOGroupWrapper::useSeedPointStyle

readwrite

Sets or reads whether the seed point style is used.

◆ useShowState

bool MLCSOGroupWrapper::useShowState

readwrite

Sets or reads whether the show state is used.

◆ useTimePointIndex

bool MLCSOGroupWrapper::useTimePointIndex

readwrite

Sets or reas whether the time point index is used.

◆ useVoxelizeState

bool MLCSOGroupWrapper::useVoxelizeState

readwrite

Sets or reads whether the voxelize state is used.

◆ useVoxelWriteMode

bool MLCSOGroupWrapper::useVoxelWriteMode

readwrite

Sets or reads whether voxel write mode is used.

◆ useVoxelWriteValue

bool MLCSOGroupWrapper::useVoxelWriteValue

readwrite

Sets or reads whether voxel write value is used.

◆ voxelizeState

bool MLCSOGroupWrapper::voxelizeState

readwrite

Sets or reads the voxelize state.

◆ voxelWriteMode

CSOVoxelWriteMode MLCSOGroupWrapper::voxelWriteMode

readwrite

Sets or reads the voxel write mode.

◆ voxelWriteValue

float MLCSOGroupWrapper::voxelWriteValue

readwrite

Sets or reads the voxel write value.