MLCSOGroupWrapper Class Reference

A class that wraps CSOGroup objects for use in Scripting. More...

List of all members.

Public Slots

void addCSO (int id)
void removeAllCSO ()
void removeCSO (int id)
bool contains (ml::CSO *cso) const
MLCSOWrappergetCSOAt (unsigned int index) const
unsigned int getCSOIdAt (unsigned int index) const
MLCSOListWrappergetCSOList () const
unsigned int getId () const
int getNumCSO () const
float getAlpha () const
QVariantList getColor () const
int getLineStyle () const
float getLineWidth () const
void setAlpha (float alpha)
void setColor (QVariantList color)
void setLineStyle (int lStyle)
void setLineWidth (float lWidth)
QVariantList getBoundingBox () const
QString getDescription () const
bool getEditableState () const
QString getLabel () const
bool getShowState () const
int getTimePointIndex () const
bool getVoxelizeState () const
int getVoxelWriteMode () const
float getVoxelWriteValue () const
void setDescription (QString desc)
void setEditableState (bool editableState)
void setLabel (QString label)
void setShowState (bool showState)
void setTimePointIndex (int tPoint)
void setVoxelizeState (bool voxelizeState)
void setVoxelWriteMode (int vwM)
void setVoxelWriteValue (float vwV)
float getMarkerAlpha () const
QVariantList getMarkerColor () const
int getMarkerMode () const
float getMarkerSize () const
void setMarkerAlpha (float markerAlpha)
void setMarkerColor (QVariantList markerColor)
void setMarkerMode (int markerMode)
void setMarkerSize (float markerSize)
bool getUseEditableState () const
bool getUseShowState () const
bool getUseTimePointIndex () const
bool getUseVoxelizeState () const
bool getUseVoxelWrite () const
void setUseEditableState (bool useEState)
void setUseShowState (bool useSState)
void setUseTimePointIndex (bool useTimePointIndex)
void setUseVoxelizeState (bool useVState)
void setUseVoxelWrite (bool useVWM)
bool getUseMarkerSettings () const
bool getUseVisuals () const
void setUseMarkerSettings (bool useMarkerSettings)
void setUseVisuals (bool uVisuals)
bool getUsePathPointAlpha () const
bool getUsePathPointColor () const
bool getUsePathPointStyle () const
bool getUsePathPointWidth () const
bool getUseSeedPointAlpha () const
bool getUseSeedPointColor () const
bool getUseSeedPointSize () const
bool getUseSeedPointStyle () const
void setUsePathPointAlpha (bool state)
void setUsePathPointColor (bool state)
void setUsePathPointStyle (bool state)
void setUsePathPointWidth (bool state)
void setUseSeedPointAlpha (bool state)
void setUseSeedPointColor (bool state)
void setUseSeedPointSize (bool state)
void setUseSeedPointStyle (bool state)

Properties

float alpha
QVariantList color
int lineStyle
float lineWidth
float markerAlpha
QVariantList markerColor
int markerMode
float markerSize
bool useEditableState
bool useMarkerSettings
bool usePathPointAlpha
bool usePathPointColor
bool usePathPointStyle
bool usePathPointWidth
bool useSeedPointAlpha
bool useSeedPointColor
bool useSeedPointSize
bool useSeedPointStyle
bool useShowState
bool useTimePointIndex
bool useVisuals
bool useVoxelizeState
bool useVoxelWrite
QVariantList boundingBox
QString description
bool editableState
int id
QString label
int numCSO
bool showState
int timePointIndex
bool voxelizeState
int voxelWriteMode
float voxelWriteValue
float pathPointAlpha
QVariantList pathPointColor
int pathPointStyle
float pathPointWidth
float seedPointAlpha
QVariantList seedPointColor
float seedPointSize
int seedPointStyle


Detailed Description

A class that wraps CSOGroup objects for use in Scripting.

Member Function Documentation

void MLCSOGroupWrapper::addCSO ( int  id  )  [slot]

Adds the CSO with the given id to this group.

bool MLCSOGroupWrapper::contains ( ml::CSO *  cso  )  const [slot]

Returns if this group contains the given CSO.

float MLCSOGroupWrapper::getAlpha (  )  const [slot]

Returns the alpha value of this group.

QVariantList MLCSOGroupWrapper::getBoundingBox (  )  const [slot]

Returns the unified bounding box of all contained CSOs.

QVariantList MLCSOGroupWrapper::getColor (  )  const [slot]

Returns the color of this group.

MLCSOWrapper* MLCSOGroupWrapper::getCSOAt ( unsigned int  index  )  const [slot]

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

unsigned int MLCSOGroupWrapper::getCSOIdAt ( unsigned int  index  )  const [slot]

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

MLCSOListWrapper* MLCSOGroupWrapper::getCSOList (  )  const [slot]

Returns a pointer to the embracing CSOList of this Group.

QString MLCSOGroupWrapper::getDescription (  )  const [slot]

Returns the group description.

bool MLCSOGroupWrapper::getEditableState (  )  const [slot]

Returns the 'editable' status of this Group.

unsigned int MLCSOGroupWrapper::getId (  )  const [slot]

Returns the Id of this group.

QString MLCSOGroupWrapper::getLabel (  )  const [slot]

Returns the group label.

int MLCSOGroupWrapper::getLineStyle (  )  const [slot]

Returns the line style of this group.

float MLCSOGroupWrapper::getLineWidth (  )  const [slot]

Returns the line width value of this group.

float MLCSOGroupWrapper::getMarkerAlpha (  )  const [slot]

Returns the marker alpha value of this Group.

QVariantList MLCSOGroupWrapper::getMarkerColor (  )  const [slot]

Returns the marker color of this Group.

int MLCSOGroupWrapper::getMarkerMode (  )  const [slot]

Returns the marker mode of this Group.

float MLCSOGroupWrapper::getMarkerSize (  )  const [slot]

Returns the marker size value of this Group.

int MLCSOGroupWrapper::getNumCSO (  )  const [slot]

Returns the number of CSOs in this group.

bool MLCSOGroupWrapper::getShowState (  )  const [slot]

Returns the 'show' status of this Group.

int MLCSOGroupWrapper::getTimePointIndex (  )  const [slot]

Returns the time point index of this group.

bool MLCSOGroupWrapper::getUseEditableState (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseMarkerSettings (  )  const [slot]

Returns if the seed point settings of the Group should be used.

bool MLCSOGroupWrapper::getUsePathPointAlpha (  )  const [slot]

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

bool MLCSOGroupWrapper::getUsePathPointColor (  )  const [slot]

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

bool MLCSOGroupWrapper::getUsePathPointStyle (  )  const [slot]

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

bool MLCSOGroupWrapper::getUsePathPointWidth (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseSeedPointAlpha (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseSeedPointColor (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseSeedPointSize (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseSeedPointStyle (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseShowState (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseTimePointIndex (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseVisuals (  )  const [slot]

Returns if the path point settings of the Group should be used.

bool MLCSOGroupWrapper::getUseVoxelizeState (  )  const [slot]

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

bool MLCSOGroupWrapper::getUseVoxelWrite (  )  const [slot]

Returns if the voxel write mode of this Group should be used.

bool MLCSOGroupWrapper::getVoxelizeState (  )  const [slot]

Returns the 'voxelize' status of this Group.

int MLCSOGroupWrapper::getVoxelWriteMode (  )  const [slot]

Returns the voxel write mode of this Group.

float MLCSOGroupWrapper::getVoxelWriteValue (  )  const [slot]

Returns the voxel write value of this Group.

void MLCSOGroupWrapper::removeAllCSO (  )  [slot]

Removes all CSOs from this group.

void MLCSOGroupWrapper::removeCSO ( int  id  )  [slot]

Removes the CSO with the given id from this group.

void MLCSOGroupWrapper::setAlpha ( float  alpha  )  [slot]

Sets the alpha value of this group.

void MLCSOGroupWrapper::setColor ( QVariantList  color  )  [slot]

Sets the color of this group.

void MLCSOGroupWrapper::setDescription ( QString  desc  )  [slot]

Sets the group description.

void MLCSOGroupWrapper::setEditableState ( bool  editableState  )  [slot]

Sets the 'editable' status of this Group.

void MLCSOGroupWrapper::setLabel ( QString  label  )  [slot]

Sets the group label.

void MLCSOGroupWrapper::setLineStyle ( int  lStyle  )  [slot]

Sets the line style of this group.

void MLCSOGroupWrapper::setLineWidth ( float  lWidth  )  [slot]

Sets the line width value of this group.

void MLCSOGroupWrapper::setMarkerAlpha ( float  markerAlpha  )  [slot]

Sets the marker alpha value of this Group.

void MLCSOGroupWrapper::setMarkerColor ( QVariantList  markerColor  )  [slot]

Sets the marker color of this Group.

void MLCSOGroupWrapper::setMarkerMode ( int  markerMode  )  [slot]

Sets the marker mode of this Group.

void MLCSOGroupWrapper::setMarkerSize ( float  markerSize  )  [slot]

Sets the marker size value of this Group.

void MLCSOGroupWrapper::setShowState ( bool  showState  )  [slot]

Sets the 'show' status of this Group.

void MLCSOGroupWrapper::setTimePointIndex ( int  tPoint  )  [slot]

Sets the time point index of this group.

void MLCSOGroupWrapper::setUseEditableState ( bool  useEState  )  [slot]

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

void MLCSOGroupWrapper::setUseMarkerSettings ( bool  useMarkerSettings  )  [slot]

Sets if the seed point settings of the Group should be used.

void MLCSOGroupWrapper::setUsePathPointAlpha ( bool  state  )  [slot]

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

void MLCSOGroupWrapper::setUsePathPointColor ( bool  state  )  [slot]

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

void MLCSOGroupWrapper::setUsePathPointStyle ( bool  state  )  [slot]

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

void MLCSOGroupWrapper::setUsePathPointWidth ( bool  state  )  [slot]

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

void MLCSOGroupWrapper::setUseSeedPointAlpha ( bool  state  )  [slot]

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

void MLCSOGroupWrapper::setUseSeedPointColor ( bool  state  )  [slot]

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

void MLCSOGroupWrapper::setUseSeedPointSize ( bool  state  )  [slot]

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

void MLCSOGroupWrapper::setUseSeedPointStyle ( bool  state  )  [slot]

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

void MLCSOGroupWrapper::setUseShowState ( bool  useSState  )  [slot]

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

void MLCSOGroupWrapper::setUseTimePointIndex ( bool  useTimePointIndex  )  [slot]

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

void MLCSOGroupWrapper::setUseVisuals ( bool  uVisuals  )  [slot]

Sets if the path point settings of the Group should be used.

void MLCSOGroupWrapper::setUseVoxelizeState ( bool  useVState  )  [slot]

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

void MLCSOGroupWrapper::setUseVoxelWrite ( bool  useVWM  )  [slot]

Sets if the voxel write mode of this Group should be used.

void MLCSOGroupWrapper::setVoxelizeState ( bool  voxelizeState  )  [slot]

Sets the 'voxelize' status of this Group.

void MLCSOGroupWrapper::setVoxelWriteMode ( int  vwM  )  [slot]

Sets the voxel write mode of this Group.

void MLCSOGroupWrapper::setVoxelWriteValue ( float  vwV  )  [slot]

Sets the voxel write value of this Group.


Property Documentation

float MLCSOGroupWrapper::alpha [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

QVariantList MLCSOGroupWrapper::boundingBox [read]

Set or read the bounding box.

QVariantList MLCSOGroupWrapper::color [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

QString MLCSOGroupWrapper::description [read, write]

Set or read the description.

bool MLCSOGroupWrapper::editableState [read, write]

Set or read the editable state.

int MLCSOGroupWrapper::id [read]

Returns the id.

QString MLCSOGroupWrapper::label [read, write]

Set or read the label.

int MLCSOGroupWrapper::lineStyle [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

float MLCSOGroupWrapper::lineWidth [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

float MLCSOGroupWrapper::markerAlpha [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

QVariantList MLCSOGroupWrapper::markerColor [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

int MLCSOGroupWrapper::markerMode [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

float MLCSOGroupWrapper::markerSize [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

int MLCSOGroupWrapper::numCSO [read]

Returns the number of CSOs in this group.

float MLCSOGroupWrapper::pathPointAlpha [read, write]

Set or read the path point alpha.

QVariantList MLCSOGroupWrapper::pathPointColor [read, write]

Set or read the path point color.

int MLCSOGroupWrapper::pathPointStyle [read, write]

Set or read the path point style.

float MLCSOGroupWrapper::pathPointWidth [read, write]

Set or read the path point width.

float MLCSOGroupWrapper::seedPointAlpha [read, write]

Set or read the seed point alpha.

QVariantList MLCSOGroupWrapper::seedPointColor [read, write]

Set or read the seed point color.

float MLCSOGroupWrapper::seedPointSize [read, write]

Set or read the seed point size.

int MLCSOGroupWrapper::seedPointStyle [read, write]

Set or read the seed point style.

bool MLCSOGroupWrapper::showState [read, write]

Set or read the show state.

int MLCSOGroupWrapper::timePointIndex [read, write]

Set or read the time point index.

bool MLCSOGroupWrapper::useEditableState [read, write]

Set or read if the editable state is used.

bool MLCSOGroupWrapper::useMarkerSettings [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

bool MLCSOGroupWrapper::usePathPointAlpha [read, write]

Set or read if the path point aplha is used.

bool MLCSOGroupWrapper::usePathPointColor [read, write]

Set or read if the path point color is used.

bool MLCSOGroupWrapper::usePathPointStyle [read, write]

Set or read if the path point style is used.

bool MLCSOGroupWrapper::usePathPointWidth [read, write]

Set or read if the path point width is used.

bool MLCSOGroupWrapper::useSeedPointAlpha [read, write]

Set or read if the seed point alpha is used.

bool MLCSOGroupWrapper::useSeedPointColor [read, write]

Set or read if the seed point color is used.

bool MLCSOGroupWrapper::useSeedPointSize [read, write]

Set or read if the seed point size is used.

bool MLCSOGroupWrapper::useSeedPointStyle [read, write]

Set or read if the seed point style is used.

bool MLCSOGroupWrapper::useShowState [read, write]

Set or read if the show state is used.

bool MLCSOGroupWrapper::useTimePointIndex [read, write]

Set or read if the time point index is used.

bool MLCSOGroupWrapper::useVisuals [read, write]

deprecated (see SeedPoint- and PathPoint-Settings above)

bool MLCSOGroupWrapper::useVoxelizeState [read, write]

Set or read if the voxelize state is used.

bool MLCSOGroupWrapper::useVoxelWrite [read, write]

Set or read if voxel write is used.

bool MLCSOGroupWrapper::voxelizeState [read, write]

Set or read the voxelize state.

int MLCSOGroupWrapper::voxelWriteMode [read, write]

Set or read the voxel write mode.

float MLCSOGroupWrapper::voxelWriteValue [read, write]

Set or read the voxel write value.


Generated on Sat Sep 3 18:38:03 2011 for MeVisLab Scripting Reference by  doxygen 1.5.8