covise::coUifElem Class Reference

#include <coUifElem.h>

Inheritance diagram for covise::coUifElem:

Public Types
enum	Kind { SWITCH , PARAM , INPORT , OUTPORT }
	enum Kind: SWITCH, PARAM, INPORT, OUTPORT More...

Public Member Functions
virtual	~coUifElem ()
	Destructor : virtual because we derive objects. More...
virtual void	hide ()
	Hide everything below. More...
virtual void	show ()
	Show everything below. More...
virtual Kind	kind () const =0
	return my type of element More...
virtual const char *	getName () const =0
	get the name of this object More...
virtual void	initialize ()=0
	give all necessary info to Covise -> automatically called by coModule in init() More...
virtual int	switchable () const
	whether this may be a part of a switch group More...
virtual int	paramChange ()
	handle parameter changes: called by paramCB More...
virtual int	preCompute ()
	do whatever is needed before compute CB : pre-set to do nothing More...
virtual int	postCompute ()
	do whatever is needed after compute CB : pre-set to do nothing More...

Member Enumeration Documentation

Kind

enum covise::coUifElem::Kind

enum Kind: SWITCH, PARAM, INPORT, OUTPORT

Enumerator
SWITCH
PARAM
INPORT
OUTPORT

Constructor & Destructor Documentation

~coUifElem()

coUifElem::~coUifElem ( )

virtual

Destructor : virtual because we derive objects.

Member Function Documentation

getName()

virtual const char * covise::coUifElem::getName ( ) const

pure virtual

get the name of this object

Implemented in covise::coPort, and covise::coUifSwitch.

hide()

void coUifElem::hide ( )

virtual

Hide everything below.

Reimplemented in covise::coTimerParam, covise::coUifPara, and covise::coUifSwitch.

initialize()

virtual void covise::coUifElem::initialize ( )

pure virtual

give all necessary info to Covise -> automatically called by coModule in init()

Implemented in covise::coBooleanParam, covise::coChoiceParam, covise::coColormapChoiceParam, covise::coColormapParam, covise::coColorParam, covise::coFileBrowserParam, covise::coFloatParam, covise::coFloatSliderParam, covise::coFloatVectorParam, covise::coInputPort, covise::coIntScalarParam, covise::coIntSliderParam, covise::coIntVectorParam, covise::coMaterialParam, covise::coOutputPort, covise::coStringParam, covise::coTimerParam, covise::coUifSwitch, covise::coPort, and covise::coUifPara.

kind()

virtual Kind covise::coUifElem::kind ( ) const

pure virtual

return my type of element

Implemented in covise::coInputPort, covise::coOutputPort, covise::coUifPara, covise::coUifSwitch, and covise::coPort.

paramChange()

int coUifElem::paramChange ( )

virtual

handle parameter changes: called by paramCB

Reimplemented in covise::coBooleanParam, covise::coChoiceParam, covise::coColormapChoiceParam, covise::coColormapParam, covise::coColorParam, covise::coFileBrowserParam, covise::coFloatParam, covise::coFloatSliderParam, covise::coFloatVectorParam, covise::coIntScalarParam, covise::coIntSliderParam, covise::coIntVectorParam, covise::coMaterialParam, covise::coStringParam, covise::coTimerParam, covise::coUifPort, covise::coUifSwitch, and covise::coUifPara.

postCompute()

int coUifElem::postCompute ( )

virtual

do whatever is needed after compute CB : pre-set to do nothing

Reimplemented in covise::coInputPort, and covise::coOutputPort.

preCompute()

int coUifElem::preCompute ( )

virtual

do whatever is needed before compute CB : pre-set to do nothing

Reimplemented in covise::coInputPort, covise::coOutputPort, and covise::coUifPara.

show()

void coUifElem::show ( )

virtual

Show everything below.

Reimplemented in covise::coTimerParam, covise::coUifPara, and covise::coUifSwitch.

switchable()

int coUifElem::switchable ( ) const

virtual

whether this may be a part of a switch group

Reimplemented in covise::coUifPara, and covise::coUifSwitch.

---

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

• api/coUifElem.h
• api/coUifElem.cpp