MLCSOWrapper Class Reference

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

List of all members.

Public Slots

void addGroup (int id)
float getAlpha () const
QVariantList getColor () const
QString getDescription () const
bool getEditableState () const
QString getLabel () const
int getLineStyle () const
float getLineWidth () const
float getMarkerAlpha () const
QVariantList getMarkerColor () const
int getMarkerMode () const
float getMarkerSize () const
bool getShowState () const
int getTimePointIndex () const
bool getVoxelizeState () const
int getVoxelWriteMode () const
float getVoxelWriteValue () const
void removeAllGroups ()
void removeGroup (int id)
void setAlpha (float alpha)
void setColor (QVariantList)
void setDescription (QString desc)
void setEditableState (bool editableState)
void setLabel (QString label)
void setLineStyle (int lStyle)
void setLineWidth (float lineWidth)
void setMarkerAlpha (float markerAlpha)
void setMarkerColor (QVariantList markerColor)
void setMarkerMode (int markerMode)
void setMarkerSize (float markerSize)
void setShowState (bool showState)
void setTimePointIndex (int index)
void setVoxelizeState (bool voxelizeState)
void setVoxelWriteMode (int vvMode)
void setVoxelWriteValue (float vwV)
double getArea () const
bool getIsClosed () const
bool getIsFinished () const
bool getIsInPlane () const
float getLength () const
QVariantList getPlaneNormal () const
QVariantList getVoxelBoundingBox (QVariantList worldToVoxelMatrix) const
QVariantList getVoxelBoundingBoxSeedPoints (QVariantList worldToVoxelMatrix) const
QVariantList getWorldBoundingBox () const
QVariantList getWorldToVoxelMatrix () const
int getCreatorId () const
MLCSOListWrappergetCSOList () const
unsigned int getId () const
QString getSubType () const
QString getType () const
QVariant getGroupAt (unsigned int index) const
unsigned int getGroupIdAt (unsigned int index) const
unsigned int getNumGroups () const
int getNumSeedPoints () const
int getNumUniquePathPoints () const
QList< float > getPathPoints () const
QList< float > getSeedPoints () const

Properties

float alpha
QVariantList color
int lineStyle
float lineWidth
float markerAlpha
QVariantList markerColor
int markerMode
float markerSize
float pathPointAlpha
QVariantList pathPointColor
int pathPointStyle
float pathPointWidth
float seedPointAlpha
QVariantList seedPointColor
float seedPointSize
int seedPointStyle
float area
bool isClosed
bool isFinished
bool isInPlane
float length
int creatorId
MLCSOListWrapper csoList
unsigned int
QString subType
QString type
QString description
bool editableState
QString label
bool showState
int timePointIndex
bool voxelizeState
int voxelWriteMode
float voxelWriteValue
int numSeedPoints
int numUniquePathPoints
QVariantList worldToVoxelMatrix


Detailed Description

A class that wraps CSO objects for use in Scripting.

Member Function Documentation

void MLCSOWrapper::addGroup ( int  id  )  [slot]

Adds the group with the given id to this CSO.

float MLCSOWrapper::getAlpha (  )  const [slot]

Returns the alpha value of this CSO.

double MLCSOWrapper::getArea (  )  const [slot]

Returns the area of this CSO (this value is only meaningful if all points lie in a plane).

QVariantList MLCSOWrapper::getColor (  )  const [slot]

Returns the color of this CSO.

int MLCSOWrapper::getCreatorId (  )  const [slot]

Returns the creator ID of the CSO. This is set by the Processor, which generated this CSO.

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

Returns the internal pointer to the wrapped CSOList.

QString MLCSOWrapper::getDescription (  )  const [slot]

Returns the description of this CSO.

bool MLCSOWrapper::getEditableState (  )  const [slot]

Returns the 'editable' state of this CSO.

QVariant MLCSOWrapper::getGroupAt ( unsigned int  index  )  const [slot]

Returns the group at the specified index. If the index is out of bounds, NULL is returned.

unsigned int MLCSOWrapper::getGroupIdAt ( unsigned int  index  )  const [inline, slot]

Returns the id of the group at the specified index.

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

Returns the unique ID of this CSO.

bool MLCSOWrapper::getIsClosed (  )  const [slot]

Returns the closed state of this contour.

bool MLCSOWrapper::getIsFinished (  )  const [slot]

Returns the finished status of this contour.

bool MLCSOWrapper::getIsInPlane (  )  const [slot]

Returns the plane status (do all seed points lie in a plane?). If the method returns 'true', the plane normal is also valid.

QString MLCSOWrapper::getLabel (  )  const [slot]

Returns the label of this CSO.

float MLCSOWrapper::getLength (  )  const [slot]

Returns the length of this CSO (this is sum of the the euclidean distances between all successive path points).

int MLCSOWrapper::getLineStyle (  )  const [slot]

Returns the line style of this CSO.

float MLCSOWrapper::getLineWidth (  )  const [slot]

Returns the line width of this CSO.

float MLCSOWrapper::getMarkerAlpha (  )  const [slot]

Returns the marker alpha value of this CSO.

QVariantList MLCSOWrapper::getMarkerColor (  )  const [slot]

Returns the marker color of this CSO.

int MLCSOWrapper::getMarkerMode (  )  const [slot]

Returns the marker mode of this CSO.

float MLCSOWrapper::getMarkerSize (  )  const [slot]

Returns the marker size value of this CSO.

unsigned int MLCSOWrapper::getNumGroups (  )  const [slot]

Returns the number of groups this CSO is in.

int MLCSOWrapper::getNumSeedPoints (  )  const [slot]

Get the namuber of seed points.

int MLCSOWrapper::getNumUniquePathPoints (  )  const [slot]

Get the number of path points.

QList<float> MLCSOWrapper::getPathPoints (  )  const [slot]

Get all path points making up the CSO in World coordinates (xyz tuple).

QVariantList MLCSOWrapper::getPlaneNormal (  )  const [slot]

Returns the plane normal. Only valid, if isInPlane returns 'true'.

QList<float> MLCSOWrapper::getSeedPoints (  )  const [slot]

Get all seed points in World coordinates (xyz tuple).

bool MLCSOWrapper::getShowState (  )  const [slot]

Returns the 'show' status of this CSO.

QString MLCSOWrapper::getSubType (  )  const [slot]

Returns the subtype of the CSO. This is set by the Processor, which generated this CSO.

int MLCSOWrapper::getTimePointIndex (  )  const [slot]

Returns the time point index of this CSO.

QString MLCSOWrapper::getType (  )  const [slot]

Returns the type of the CSO. This is set by the Processor, which generated this CSO.

QVariantList MLCSOWrapper::getVoxelBoundingBox ( QVariantList  worldToVoxelMatrix  )  const [slot]

Returns the bounding box of this contour in voxel coordinates computed by the given (image) matrix.

QVariantList MLCSOWrapper::getVoxelBoundingBoxSeedPoints ( QVariantList  worldToVoxelMatrix  )  const [slot]

Returns the bounding box of the seed points of this CSO in voxel coordinates computed by the given (image) matrix.

bool MLCSOWrapper::getVoxelizeState (  )  const [slot]

Returns the 'voxelize' state of this CSO.

int MLCSOWrapper::getVoxelWriteMode (  )  const [slot]

Returns the voxel write mode of this CSO.

float MLCSOWrapper::getVoxelWriteValue (  )  const [slot]

Returns the voxel write value of this CSO.

QVariantList MLCSOWrapper::getWorldBoundingBox (  )  const [slot]

Returns the bounding box of this contour in world coordinates.

QVariantList MLCSOWrapper::getWorldToVoxelMatrix (  )  const [slot]

Returns the world-to-voxel matrix of the image this CSO was generated on.

void MLCSOWrapper::removeAllGroups (  )  [slot]

Removes all groups from this CSO.

void MLCSOWrapper::removeGroup ( int  id  )  [slot]

Removes the group with the given id from this CSO.

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

Sets the alpha value of this CSO.

void MLCSOWrapper::setColor ( QVariantList   )  [slot]

Sets the color of this CSO.

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

Sets the description of this CSO.

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

Sets the 'editable' state of this CSO.

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

Sets the label of this CSO.

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

Sets the line style of this CSO.

void MLCSOWrapper::setLineWidth ( float  lineWidth  )  [slot]

Sets the line width for this CSO.

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

Sets the marker alpha value of this CSO.

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

Sets the marker color of this CSO.

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

Sets the marker mode of this CSO.

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

Sets the marker size value of this CSO.

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

Sets the 'show' status of this CSO.

void MLCSOWrapper::setTimePointIndex ( int  index  )  [slot]

Sets the time point index of this CSO.

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

Sets the 'voxelize' state of this CSO.

void MLCSOWrapper::setVoxelWriteMode ( int  vvMode  )  [slot]

Sets the voxel write mode of this CSO.

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

Sets the voxel write value of this CSO.


Property Documentation

float MLCSOWrapper::alpha [read, write]

Deprecated: Set or read the path point alpha.

float MLCSOWrapper::area [read]

Returns the area of the CSO.

QVariantList MLCSOWrapper::color [read, write]

Deprecated: Set or read the path point color.

int MLCSOWrapper::creatorId [read]

Returns the id of the creator.

MLCSOListWrapper MLCSOWrapper::csoList [read]

Returns the CSOList.

QString MLCSOWrapper::description [read, write]

Set or read the description.

bool MLCSOWrapper::editableState [read, write]

Set or read the editable state.

unsigned MLCSOWrapper::int [read]

Returns the id.

bool MLCSOWrapper::isClosed [read]

Returns if the cso is closed.

bool MLCSOWrapper::isFinished [read]

Returns if the cso is finished.

bool MLCSOWrapper::isInPlane [read]

Returns if the CSO is planar.

QString MLCSOWrapper::label [read, write]

Set or read the label.

float MLCSOWrapper::length [read]

Returns the length of the CSO.

int MLCSOWrapper::lineStyle [read, write]

Deprecated: Set or read the path point style.

float MLCSOWrapper::lineWidth [read, write]

Deprecated: Set or read the path point width.

float MLCSOWrapper::markerAlpha [read, write]

Deprecated: Set or read the seed point alpha.

QVariantList MLCSOWrapper::markerColor [read, write]

Deprecated: Set or read the seed point color.

int MLCSOWrapper::markerMode [read, write]

Deprecated: Set or read the seed point style.

float MLCSOWrapper::markerSize [read, write]

Deprecated: Set or read the seed point size.

int MLCSOWrapper::numSeedPoints [read]

Returns the number of seed points.

int MLCSOWrapper::numUniquePathPoints [read]

Returns the number of path points.

float MLCSOWrapper::pathPointAlpha [read, write]

Set or read the path point alpha.

QVariantList MLCSOWrapper::pathPointColor [read, write]

Set or read the path point color.

int MLCSOWrapper::pathPointStyle [read, write]

Set or read the path point style.

float MLCSOWrapper::pathPointWidth [read, write]

Set or read the path point width.

float MLCSOWrapper::seedPointAlpha [read, write]

Set or read the seed point alpha.

QVariantList MLCSOWrapper::seedPointColor [read, write]

Set or read the seed point color.

float MLCSOWrapper::seedPointSize [read, write]

Set or read the seed point size.

int MLCSOWrapper::seedPointStyle [read, write]

Set or read the seed point style.

bool MLCSOWrapper::showState [read, write]

Set or read the show state.

QString MLCSOWrapper::subType [read]

Returns the subtype.

int MLCSOWrapper::timePointIndex [read, write]

Set or read the time point index.

QString MLCSOWrapper::type [read]

Returns the type.

bool MLCSOWrapper::voxelizeState [read, write]

Set or read the voxelize state.

int MLCSOWrapper::voxelWriteMode [read, write]

Set or read the voxel write mode.

float MLCSOWrapper::voxelWriteValue [read, write]

Set or read the voxel write value.

QVariantList MLCSOWrapper::worldToVoxelMatrix [read]

Returns the world-to-voxel matrix.


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