ml::CSOGroup Class Reference

A CSOGroup comprises a number of CSOs, which themselves can be in a number of different CSOGroups. More...

#include <CSOGroup.h>

Public Member Functions
	CSOGroup ()
	Constructor.
	CSOGroup (CSOList *csoList)
	Constructor, takes a pointer to the embracing CSOList as an argument.
	CSOGroup (const CSOGroup &group, int groupId=-1, CSOList *csoList=nullptr)
	Copy constructor.
	~CSOGroup ()
	Destructor.
CSOGroupRules &	getRules ()
	Return the rules for this CSOGroup.
bool	isSelected () const
	Returns whether this group is selected in its enclosing CSOList.
void	groupChanged ()
	Marks this Group as changed (e.g. if a CSO has been added, removed or changed).
bool	saveAttributes (std::ostream &outStream, bool useAscii=false)
	Save attributes to stream and returns whether the saving was successful.
void	loadAttributes (std::istream &inStream, short version, bool swapBytes, bool useAscii=false)
	Load attributes from stream.
Methods concerning member CSOs.
bool	addCSO (CSO &cso, bool useUndoRedo=true)
void	removeCSO (CSO &cso, bool useUndoRedo=true)
	removes given CSO from this group
void	removeAllCSO (bool useUndoRedo=true, bool shouldApplyRemoveFromGroupRule=true)
	Removes all CSOs from this group.
bool	contains (const CSO *cso) const
	Returns if this group contains the given CSO.
unsigned int	numCSOs () const
	Returns the number of CSOs in this group.
CSO *	getCSOAt (unsigned int index) const
	Returns a pointer to the CSO at the given index. Beware: no index check.
unsigned int	getCSOIdAt (unsigned int index) const
	Returns the id of an associated CSO at the given index. Beware: no index check.
MLCSO-internal Methods concerning member CSOs.
void	_addReferenceToCSO (const CSO &cso)
void	_removeReferenceToCSO (const CSO &cso)
	Removes a reference to a CSO from this group.
Maintenance methods.
unsigned int	getId () const
void	setId (unsigned int id)
	Sets the Id of this group.
void	setCSOList (CSOList *csoList)
	Sets the embracing CSOList for this Group.
CSOList *	getCSOList () const
	Returns a pointer to the embracing CSOList of this Group.
Methods for getting / setting attributes.
void	setLabel (const std::string &label)
const std::string &	getLabel () const
	Returns the group label.
void	setDescription (const std::string &description)
	Sets the group description.
const std::string &	getDescription () const
	Returns the group description.
int	getTimePointIndex () const
	Returns the time point index of this group.
void	setTimePointIndex (MLint timePointIndex)
	Sets the time point index of this group.
void	setShowState (bool state)
	Sets the 'show' status of this Group.
bool	getShowState () const
	Returns the 'show' status of this Group.
void	setVoxelizeState (bool state)
	Sets the 'voxelize' status of this Group.
bool	getVoxelizeState () const
	Returns the 'voxelize' status of this Group.
void	setEditableState (bool state)
	Sets the 'editable' status of this Group.
bool	getEditableState () const
	Returns the 'editable' status of this Group.
CSOPathPointsStyle	getPathPointStyle () const
	Returns the path point style.
void	setPathPointStyle (CSOPathPointsStyle style)
	Sets the path point style.
void	setPathPointStyle (int style)
	Sets the path point style as an int.
float	getPathPointWidth () const
	Returns the width of the path points.
void	setPathPointWidth (float width)
	Sets the width of the path points.
const Vector3 &	getPathPointColor () const
	Returns the color of the path points.
void	setPathPointColor (const Vector3 &color)
	Sets the color of the path points.
float	getPathPointAlpha () const
	Returns the alpha value of the path points.
void	setPathPointAlpha (float alpha)
	Sets the alpha value of the path points.
int	getSeedPointStyle () const
	Returns the style of the seed points.
void	setSeedPointStyle (int seedPointStyle)
	Sets the style of the seed points.
float	getSeedPointSize () const
	Returns the size of the seed points.
void	setSeedPointSize (float size)
	Sets the size of the seed points.
const Vector3 &	getSeedPointColor () const
	Returns the color of the seed points.
void	setSeedPointColor (const Vector3 &color)
	Sets the color of the seed points.
float	getSeedPointAlpha () const
	Returns the alpha value of the seed points.
void	setSeedPointAlpha (float alpha)
	Sets the alpha value of the seed points.
int	getVoxelWriteMode () const
	Returns the voxel write mode of this Group.
void	setVoxelWriteMode (int mode)
	Sets the voxel write mode of this Group.
float	getVoxelWriteValue () const
	Returns the voxel write value of this Group.
void	setVoxelWriteValue (float value)
	Sets the voxel write value of this Group.
Methods setting / reading out the user data values.
void	setUserData (const std::string &name, Variant value)
Variant	getUserData (const std::string &name) const
	Returns the user data under the given name or an invalid value if the entry does not exist.
void	getUserDataNames (std::vector< std::string > &names) const
	Fills the given vector with the keys/name under which user data are stored for this CSO.
void	removeUserData (const std::string &name)
	Removes a user data entry.
Methods for getting / setting the use of attributes.
bool	getUseTimePointIndex () const
void	setUseTimePointIndex (bool state)
	Sets whether the time point index of this Group should be used.
bool	getUseShowState () const
	Returns if this Group overrides the show state of its CSOs.
void	setUseShowState (bool state)
	Sets whether this Group overrides the show state of its CSOs.
bool	getUseVoxelizeState () const
	Returns whether this Group overrides the voxelize state of its CSOs.
void	setUseVoxelizeState (bool state)
	Sets whether this Group overrides the voxelize state of its CSOs.
bool	getUseEditableState () const
	Returns whether this Group overrides the editable state of its CSOs.
void	setUseEditableState (bool state)
	Sets whether this Group overrides the editable state of its CSOs.
bool	getUseSeedPointStyle () const
	Returns whether this Group overrides the seed point style of its CSOs.
void	setUseSeedPointStyle (bool state)
	Sets whether this Group overrides the seed point style of its CSOs.
bool	getUseSeedPointSize () const
	Returns whether this Group overrides the seed point size of its CSOs.
void	setUseSeedPointSize (bool state)
	Sets whether this Group overrides the seed point size of its CSOs.
bool	getUseSeedPointColor () const
	Returns whether this Group overrides the seed point color of its CSOs.
void	setUseSeedPointColor (bool state)
	Sets whether this Group overrides the seed point color of its CSOs.
bool	getUseSeedPointAlpha () const
	Returns whether this Group overrides the seed point alpha of its CSOs.
void	setUseSeedPointAlpha (bool state)
	Sets whether this Group overrides the seed point alpha of its CSOs.
bool	getUsePathPointStyle () const
	Returns whether this Group overrides the path point style of its CSOs.
void	setUsePathPointStyle (bool state)
	Sets whether this Group overrides the path point style of its CSOs.
bool	getUsePathPointWidth () const
	Returns whether this Group overrides the path point width of its CSOs.
void	setUsePathPointWidth (bool state)
	Sets whether this Group overrides the path point width of its CSOs.
bool	getUsePathPointColor () const
	Returns whether this Group overrides the path point color of its CSOs.
void	setUsePathPointColor (bool state)
	Sets whether this Group overrides the path point color of its CSOs.
bool	getUsePathPointAlpha () const
	Returns whether this Group overrides the path point alpha of its CSOs.
void	setUsePathPointAlpha (bool state)
	Sets whether this Group overrides the path point alpha of its CSOs.
bool	getUseVoxelWriteMode () const
	Returns whether this Group overrides the voxel write mode of its CSOs.
void	setUseVoxelWriteMode (bool state)
	Sets whether this Group overrides the voxel write mode of its CSOs.
bool	getUseVoxelWriteValue () const
	Returns whether this Group overrides the voxel write value of its CSOs.
void	setUseVoxelWriteValue (bool state)
	Sets whether this Group overrides the voxel write value of its CSOs.
Methods for handling the bounding box.
const CSOBoundingBox &	getBoundingBox ()
CSOBoundingBox	getVoxelBoundingBox (const Matrix4 &worldToVoxelMatrix, size_t hashKey)
	Returns the unified voxel bounding box of all contained CSOs.

Friends
class	CSOList

Detailed Description

A CSOGroup comprises a number of CSOs, which themselves can be in a number of different CSOGroups.

Some visualization parameters can be controlled by a CSOGroup, and some processing modules can apply special functions for groups only.

Definition at line 37 of file CSOGroup.h.

Constructor & Destructor Documentation

CSOGroup() [1/3]

ml::CSOGroup::CSOGroup

(

)

Constructor.

CSOGroup() [2/3]

ml::CSOGroup::CSOGroup

(

CSOList *

csoList

)

Constructor, takes a pointer to the embracing CSOList as an argument.

CSOGroup() [3/3]

ml::CSOGroup::CSOGroup	(	const CSOGroup &	group,
		int	groupId = -1,
		CSOList *	csoList = nullptr )

Copy constructor.

~CSOGroup()

ml::CSOGroup::~CSOGroup

(

)

Destructor.

Member Function Documentation

_addReferenceToCSO()

void ml::CSOGroup::_addReferenceToCSO

(

const CSO &

cso

)

Adds a reference to a CSO to this group.

_removeReferenceToCSO()

void ml::CSOGroup::_removeReferenceToCSO

(

const CSO &

cso

)

Removes a reference to a CSO from this group.

addCSO()

bool ml::CSOGroup::addCSO	(	CSO &	cso,
		bool	useUndoRedo = true )

adds given CSO to this group Returns whether the operation was successful.

contains()

bool ml::CSOGroup::contains

(

const CSO *

cso

)

const

Returns if this group contains the given CSO.

getBoundingBox()

const CSOBoundingBox & ml::CSOGroup::getBoundingBox

(

)

Returns the unified bounding box of all contained CSOs.

getCSOAt()

CSO * ml::CSOGroup::getCSOAt

(

unsigned int

index

)

const

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

getCSOIdAt()

unsigned int ml::CSOGroup::getCSOIdAt ( unsigned int index ) const

inline

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

Definition at line 75 of file CSOGroup.h.

getCSOList()

CSOList * ml::CSOGroup::getCSOList ( ) const

inline

Returns a pointer to the embracing CSOList of this Group.

Definition at line 101 of file CSOGroup.h.

getDescription()

const std::string & ml::CSOGroup::getDescription ( ) const

inline

Returns the group description.

Definition at line 119 of file CSOGroup.h.

getEditableState()

bool ml::CSOGroup::getEditableState ( ) const

inline

Returns the 'editable' status of this Group.

Definition at line 136 of file CSOGroup.h.

getId()

unsigned int ml::CSOGroup::getId ( ) const

inline

Returns the Id of this group.

Definition at line 93 of file CSOGroup.h.

getLabel()

const std::string & ml::CSOGroup::getLabel ( ) const

inline

Returns the group label.

Definition at line 115 of file CSOGroup.h.

getPathPointAlpha()

float ml::CSOGroup::getPathPointAlpha ( ) const

inline

Returns the alpha value of the path points.

Definition at line 152 of file CSOGroup.h.

getPathPointColor()

const Vector3 & ml::CSOGroup::getPathPointColor ( ) const

inline

Returns the color of the path points.

Definition at line 148 of file CSOGroup.h.

getPathPointStyle()

CSOPathPointsStyle ml::CSOGroup::getPathPointStyle ( ) const

inline

Returns the path point style.

Definition at line 138 of file CSOGroup.h.

getPathPointWidth()

float ml::CSOGroup::getPathPointWidth ( ) const

inline

Returns the width of the path points.

Definition at line 144 of file CSOGroup.h.

getRules()

CSOGroupRules & ml::CSOGroup::getRules ( )

inline

Return the rules for this CSOGroup.

Definition at line 55 of file CSOGroup.h.

getSeedPointAlpha()

float ml::CSOGroup::getSeedPointAlpha ( ) const

inline

Returns the alpha value of the seed points.

Definition at line 168 of file CSOGroup.h.

getSeedPointColor()

const Vector3 & ml::CSOGroup::getSeedPointColor ( ) const

inline

Returns the color of the seed points.

Definition at line 164 of file CSOGroup.h.

getSeedPointSize()

float ml::CSOGroup::getSeedPointSize ( ) const

inline

Returns the size of the seed points.

Definition at line 160 of file CSOGroup.h.

getSeedPointStyle()

int ml::CSOGroup::getSeedPointStyle ( ) const

inline

Returns the style of the seed points.

Definition at line 156 of file CSOGroup.h.

getShowState()

bool ml::CSOGroup::getShowState ( ) const

inline

Returns the 'show' status of this Group.

Definition at line 128 of file CSOGroup.h.

getTimePointIndex()

int ml::CSOGroup::getTimePointIndex ( ) const

inline

Returns the time point index of this group.

Definition at line 122 of file CSOGroup.h.

getUseEditableState()

bool ml::CSOGroup::getUseEditableState ( ) const

inline

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

Definition at line 212 of file CSOGroup.h.

getUsePathPointAlpha()

bool ml::CSOGroup::getUsePathPointAlpha ( ) const

inline

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

Definition at line 244 of file CSOGroup.h.

getUsePathPointColor()

bool ml::CSOGroup::getUsePathPointColor ( ) const

inline

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

Definition at line 240 of file CSOGroup.h.

getUsePathPointStyle()

bool ml::CSOGroup::getUsePathPointStyle ( ) const

inline

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

Definition at line 232 of file CSOGroup.h.

getUsePathPointWidth()

bool ml::CSOGroup::getUsePathPointWidth ( ) const

inline

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

Definition at line 236 of file CSOGroup.h.

getUserData()

Variant ml::CSOGroup::getUserData ( const std::string & name ) const

inline

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

Definition at line 188 of file CSOGroup.h.

getUserDataNames()

void ml::CSOGroup::getUserDataNames ( std::vector< std::string > & names ) const

inline

Fills the given vector with the keys/name under which user data are stored for this CSO.

Definition at line 190 of file CSOGroup.h.

References mlrange_cast().

getUseSeedPointAlpha()

bool ml::CSOGroup::getUseSeedPointAlpha ( ) const

inline

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

Definition at line 228 of file CSOGroup.h.

getUseSeedPointColor()

bool ml::CSOGroup::getUseSeedPointColor ( ) const

inline

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

Definition at line 224 of file CSOGroup.h.

getUseSeedPointSize()

bool ml::CSOGroup::getUseSeedPointSize ( ) const

inline

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

Definition at line 220 of file CSOGroup.h.

getUseSeedPointStyle()

bool ml::CSOGroup::getUseSeedPointStyle ( ) const

inline

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

Definition at line 216 of file CSOGroup.h.

getUseShowState()

bool ml::CSOGroup::getUseShowState ( ) const

inline

Returns if this Group overrides the show state of its CSOs.

Definition at line 204 of file CSOGroup.h.

getUseTimePointIndex()

bool ml::CSOGroup::getUseTimePointIndex ( ) const

inline

Returns if the time point index of this Group should be used.

Definition at line 200 of file CSOGroup.h.

getUseVoxelizeState()

bool ml::CSOGroup::getUseVoxelizeState ( ) const

inline

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

Definition at line 208 of file CSOGroup.h.

getUseVoxelWriteMode()

bool ml::CSOGroup::getUseVoxelWriteMode ( ) const

inline

Returns whether this Group overrides the voxel write mode of its CSOs.

Definition at line 248 of file CSOGroup.h.

getUseVoxelWriteValue()

bool ml::CSOGroup::getUseVoxelWriteValue ( ) const

inline

Returns whether this Group overrides the voxel write value of its CSOs.

Definition at line 252 of file CSOGroup.h.

getVoxelBoundingBox()

CSOBoundingBox ml::CSOGroup::getVoxelBoundingBox	(	const Matrix4 &	worldToVoxelMatrix,
		size_t	hashKey )

Returns the unified voxel bounding box of all contained CSOs.

getVoxelizeState()

bool ml::CSOGroup::getVoxelizeState ( ) const

inline

Returns the 'voxelize' status of this Group.

Definition at line 132 of file CSOGroup.h.

getVoxelWriteMode()

int ml::CSOGroup::getVoxelWriteMode ( ) const

inline

Returns the voxel write mode of this Group.

Definition at line 172 of file CSOGroup.h.

getVoxelWriteValue()

float ml::CSOGroup::getVoxelWriteValue ( ) const

inline

Returns the voxel write value of this Group.

Definition at line 176 of file CSOGroup.h.

groupChanged()

void ml::CSOGroup::groupChanged

(

)

Marks this Group as changed (e.g. if a CSO has been added, removed or changed).

isSelected()

bool ml::CSOGroup::isSelected

(

)

const

Returns whether this group is selected in its enclosing CSOList.

If there is no enclosing CSOList, this method returns false.

loadAttributes()

void ml::CSOGroup::loadAttributes	(	std::istream &	inStream,
		short	version,
		bool	swapBytes,
		bool	useAscii = false )

Load attributes from stream.

numCSOs()

unsigned int ml::CSOGroup::numCSOs ( ) const

inline

Returns the number of CSOs in this group.

Definition at line 71 of file CSOGroup.h.

removeAllCSO()

void ml::CSOGroup::removeAllCSO	(	bool	useUndoRedo = true,
		bool	shouldApplyRemoveFromGroupRule = true )

Removes all CSOs from this group.

removeCSO()

void ml::CSOGroup::removeCSO	(	CSO &	cso,
		bool	useUndoRedo = true )

removes given CSO from this group

removeUserData()

void ml::CSOGroup::removeUserData ( const std::string & name )

inline

Removes a user data entry.

Definition at line 192 of file CSOGroup.h.

saveAttributes()

bool ml::CSOGroup::saveAttributes	(	std::ostream &	outStream,
		bool	useAscii = false )

Save attributes to stream and returns whether the saving was successful.

setCSOList()

void ml::CSOGroup::setCSOList

(

CSOList *

csoList

)

Sets the embracing CSOList for this Group.

Note that this method does not alter this CSOGroup's unique id, so it may become invalid (not unique) in the new CSOList.

setDescription()

void ml::CSOGroup::setDescription

(

const std::string &

description

)

Sets the group description.

setEditableState()

void ml::CSOGroup::setEditableState

(

bool

state

)

Sets the 'editable' status of this Group.

setId()

void ml::CSOGroup::setId ( unsigned int id )

inline

Sets the Id of this group.

Definition at line 95 of file CSOGroup.h.

setLabel()

void ml::CSOGroup::setLabel

(

const std::string &

label

)

Sets the group label.

setPathPointAlpha()

void ml::CSOGroup::setPathPointAlpha

(

float

alpha

)

Sets the alpha value of the path points.

setPathPointColor()

void ml::CSOGroup::setPathPointColor

(

const Vector3 &

color

)

Sets the color of the path points.

setPathPointStyle() [1/2]

void ml::CSOGroup::setPathPointStyle

(

CSOPathPointsStyle

style

)

Sets the path point style.

setPathPointStyle() [2/2]

void ml::CSOGroup::setPathPointStyle ( int style )

inline

Sets the path point style as an int.

Definition at line 142 of file CSOGroup.h.

References mlrange_cast(), and setPathPointStyle().

Referenced by setPathPointStyle().

setPathPointWidth()

void ml::CSOGroup::setPathPointWidth

(

float

width

)

Sets the width of the path points.

setSeedPointAlpha()

void ml::CSOGroup::setSeedPointAlpha

(

float

alpha

)

Sets the alpha value of the seed points.

setSeedPointColor()

void ml::CSOGroup::setSeedPointColor

(

const Vector3 &

color

)

Sets the color of the seed points.

setSeedPointSize()

void ml::CSOGroup::setSeedPointSize

(

float

size

)

Sets the size of the seed points.

setSeedPointStyle()

void ml::CSOGroup::setSeedPointStyle

(

int

seedPointStyle

)

Sets the style of the seed points.

setShowState()

void ml::CSOGroup::setShowState

(

bool

state

)

Sets the 'show' status of this Group.

setTimePointIndex()

void ml::CSOGroup::setTimePointIndex

(

MLint

timePointIndex

)

Sets the time point index of this group.

setUseEditableState()

void ml::CSOGroup::setUseEditableState ( bool state )

inline

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

Definition at line 214 of file CSOGroup.h.

setUsePathPointAlpha()

void ml::CSOGroup::setUsePathPointAlpha ( bool state )

inline

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

Definition at line 246 of file CSOGroup.h.

setUsePathPointColor()

void ml::CSOGroup::setUsePathPointColor ( bool state )

inline

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

Definition at line 242 of file CSOGroup.h.

setUsePathPointStyle()

void ml::CSOGroup::setUsePathPointStyle ( bool state )

inline

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

Definition at line 234 of file CSOGroup.h.

setUsePathPointWidth()

void ml::CSOGroup::setUsePathPointWidth ( bool state )

inline

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

Definition at line 238 of file CSOGroup.h.

setUserData()

void ml::CSOGroup::setUserData ( const std::string & name, Variant value )

inline

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

Definition at line 186 of file CSOGroup.h.

setUseSeedPointAlpha()

void ml::CSOGroup::setUseSeedPointAlpha ( bool state )

inline

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

Definition at line 230 of file CSOGroup.h.

setUseSeedPointColor()

void ml::CSOGroup::setUseSeedPointColor ( bool state )

inline

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

Definition at line 226 of file CSOGroup.h.

setUseSeedPointSize()

void ml::CSOGroup::setUseSeedPointSize ( bool state )

inline

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

Definition at line 222 of file CSOGroup.h.

setUseSeedPointStyle()

void ml::CSOGroup::setUseSeedPointStyle ( bool state )

inline

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

Definition at line 218 of file CSOGroup.h.

setUseShowState()

void ml::CSOGroup::setUseShowState ( bool state )

inline

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

Definition at line 206 of file CSOGroup.h.

setUseTimePointIndex()

void ml::CSOGroup::setUseTimePointIndex ( bool state )

inline

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

Definition at line 202 of file CSOGroup.h.

setUseVoxelizeState()

void ml::CSOGroup::setUseVoxelizeState ( bool state )

inline

Sets whether this Group overrides the voxelize state of its CSOs.

Definition at line 210 of file CSOGroup.h.

setUseVoxelWriteMode()

void ml::CSOGroup::setUseVoxelWriteMode ( bool state )

inline

Sets whether this Group overrides the voxel write mode of its CSOs.

Definition at line 250 of file CSOGroup.h.

setUseVoxelWriteValue()

void ml::CSOGroup::setUseVoxelWriteValue ( bool state )

inline

Sets whether this Group overrides the voxel write value of its CSOs.

Definition at line 254 of file CSOGroup.h.

setVoxelizeState()

void ml::CSOGroup::setVoxelizeState

(

bool

state

)

Sets the 'voxelize' status of this Group.

setVoxelWriteMode()

void ml::CSOGroup::setVoxelWriteMode

(

int

mode

)

Sets the voxel write mode of this Group.

setVoxelWriteValue()

void ml::CSOGroup::setVoxelWriteValue

(

float

value

)

Sets the voxel write value of this Group.

Friends And Related Symbol Documentation

CSOList

friend class CSOList

friend

Definition at line 41 of file CSOGroup.h.

---

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

• MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOGroup.h