OpenCOVER
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | List of all members
opencover::coInteractor Class Referenceabstract

abstract feedback class for interacting with parameters of visualization modules (e.g. COVISE or Vistle) More...

#include <coInteractor.h>

Inheritance diagram for opencover::coInteractor:
Inheritance graph
[legend]

Public Member Functions

 coInteractor ()
 
virtual ~coInteractor ()
 
void incRefCount ()
 if you get an interactor and you want to keep it use ... More...
 
void decRefCount ()
 if you don't need the interactor any more use ... More...
 
virtual void removedObject ()=0
 
virtual bool isSameModule (coInteractor *i) const =0
 returns true, if Interactor comes from same Module as intteractor i; More...
 
virtual bool isSame (coInteractor *i) const =0
 returns true, if Interactor is exactly the same as interactor i; More...
 
virtual void executeModule ()=0
 execute the Module More...
 
virtual void copyModule ()=0
 copy the Module to same host More...
 
virtual void copyModuleExec ()=0
 copy the Module to same host and execute the copied one More...
 
virtual void deleteModule ()=0
 delete the Module More...
 
virtual int getBooleanParam (const std::string &paraName, int &value) const =0
 
virtual int getIntScalarParam (const std::string &paraName, int &value) const =0
 
virtual int getFloatScalarParam (const std::string &paraName, float &value) const =0
 
virtual int getIntSliderParam (const std::string &paraName, int &min, int &max, int &val) const =0
 
virtual int getFloatSliderParam (const std::string &paraName, float &min, float &max, float &val) const =0
 
virtual int getIntVectorParam (const std::string &paraName, int &numElem, int *&val) const =0
 
virtual int getFloatVectorParam (const std::string &paraName, int &numElem, float *&val) const =0
 
virtual int getStringParam (const std::string &paraName, const char *&val) const =0
 
virtual int getChoiceParam (const std::string &paraName, int &num, char **&labels, int &active) const =0
 
virtual int getFileBrowserParam (const std::string &paraName, char *&val) const =0
 
virtual void setBooleanParam (const char *name, int val)=0
 set Boolean Parameter More...
 
virtual void setScalarParam (const char *name, float val)=0
 set float scalar parameter More...
 
virtual void setScalarParam (const char *name, int val)=0
 set int scalar parameter More...
 
virtual void setSliderParam (const char *name, float min, float max, float value)=0
 set float slider parameter More...
 
virtual void setSliderParam (const char *name, int min, int max, int value)=0
 set int slider parameter More...
 
virtual void setVectorParam (const char *name, int numElem, float *field)=0
 set float Vector Param More...
 
virtual void setVectorParam (const char *name, float u, float v, float w)=0
 
virtual void setVectorParam (const char *name, int numElem, int *field)=0
 set int vector parameter More...
 
virtual void setVectorParam (const char *name, int u, int v, int w)=0
 
virtual void setStringParam (const char *name, const char *val)=0
 set string parameter More...
 
virtual void setChoiceParam (const char *name, int num, const char *const *list, int pos)=0
 set choice parameter, pos starts with 1 More...
 
virtual void setFileBrowserParam (const char *name, const char *val)=0
 set browser parameter More...
 
virtual const char * getObjName ()=0
 
virtual RenderObjectgetObject ()=0
 
virtual const char * getPluginName ()=0
 
virtual const char * getModuleName ()=0
 
virtual int getModuleInstance ()=0
 
virtual const char * getModuleHost ()=0
 
virtual int getNumParam () const =0
 Get the number of Parameters. More...
 
virtual int getNumUser () const =0
 Get the number of User Strings. More...
 
virtual const char * getString (unsigned int i) const =0
 

Detailed Description

abstract feedback class for interacting with parameters of visualization modules (e.g. COVISE or Vistle)

Constructor & Destructor Documentation

opencover::coInteractor::coInteractor ( )
virtual opencover::coInteractor::~coInteractor ( )
virtual

Member Function Documentation

virtual void opencover::coInteractor::copyModule ( )
pure virtual

copy the Module to same host

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::copyModuleExec ( )
pure virtual

copy the Module to same host and execute the copied one

Implemented in opencover::coBaseCoviseInteractor.

void opencover::coInteractor::decRefCount ( )

if you don't need the interactor any more use ...

virtual void opencover::coInteractor::deleteModule ( )
pure virtual

delete the Module

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::executeModule ( )
pure virtual

execute the Module

Implemented in opencover::coBaseCoviseInteractor.

virtual int opencover::coInteractor::getBooleanParam ( const std::string &  paraName,
int &  value 
) const
pure virtual
virtual int opencover::coInteractor::getChoiceParam ( const std::string &  paraName,
int &  num,
char **&  labels,
int &  active 
) const
pure virtual
virtual int opencover::coInteractor::getFileBrowserParam ( const std::string &  paraName,
char *&  val 
) const
pure virtual
virtual int opencover::coInteractor::getFloatScalarParam ( const std::string &  paraName,
float &  value 
) const
pure virtual
virtual int opencover::coInteractor::getFloatSliderParam ( const std::string &  paraName,
float &  min,
float &  max,
float &  val 
) const
pure virtual
virtual int opencover::coInteractor::getFloatVectorParam ( const std::string &  paraName,
int &  numElem,
float *&  val 
) const
pure virtual
virtual int opencover::coInteractor::getIntScalarParam ( const std::string &  paraName,
int &  value 
) const
pure virtual
virtual int opencover::coInteractor::getIntSliderParam ( const std::string &  paraName,
int &  min,
int &  max,
int &  val 
) const
pure virtual
virtual int opencover::coInteractor::getIntVectorParam ( const std::string &  paraName,
int &  numElem,
int *&  val 
) const
pure virtual
virtual const char* opencover::coInteractor::getModuleHost ( )
pure virtual
virtual int opencover::coInteractor::getModuleInstance ( )
pure virtual
virtual const char* opencover::coInteractor::getModuleName ( )
pure virtual
virtual int opencover::coInteractor::getNumParam ( ) const
pure virtual

Get the number of Parameters.

Implemented in opencover::coBaseCoviseInteractor.

virtual int opencover::coInteractor::getNumUser ( ) const
pure virtual

Get the number of User Strings.

Implemented in opencover::coBaseCoviseInteractor.

virtual RenderObject* opencover::coInteractor::getObject ( )
pure virtual
virtual const char* opencover::coInteractor::getObjName ( )
pure virtual
virtual const char* opencover::coInteractor::getPluginName ( )
pure virtual
virtual const char* opencover::coInteractor::getString ( unsigned int  i) const
pure virtual
virtual int opencover::coInteractor::getStringParam ( const std::string &  paraName,
const char *&  val 
) const
pure virtual
void opencover::coInteractor::incRefCount ( )

if you get an interactor and you want to keep it use ...

virtual bool opencover::coInteractor::isSame ( coInteractor i) const
pure virtual

returns true, if Interactor is exactly the same as interactor i;

Implemented in opencover::coBaseCoviseInteractor.

virtual bool opencover::coInteractor::isSameModule ( coInteractor i) const
pure virtual

returns true, if Interactor comes from same Module as intteractor i;

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::removedObject ( )
pure virtual
virtual void opencover::coInteractor::setBooleanParam ( const char *  name,
int  val 
)
pure virtual

set Boolean Parameter

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setChoiceParam ( const char *  name,
int  num,
const char *const *  list,
int  pos 
)
pure virtual

set choice parameter, pos starts with 1

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setFileBrowserParam ( const char *  name,
const char *  val 
)
pure virtual

set browser parameter

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setScalarParam ( const char *  name,
float  val 
)
pure virtual

set float scalar parameter

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setScalarParam ( const char *  name,
int  val 
)
pure virtual

set int scalar parameter

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setSliderParam ( const char *  name,
float  min,
float  max,
float  value 
)
pure virtual

set float slider parameter

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setSliderParam ( const char *  name,
int  min,
int  max,
int  value 
)
pure virtual

set int slider parameter

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setStringParam ( const char *  name,
const char *  val 
)
pure virtual

set string parameter

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setVectorParam ( const char *  name,
int  numElem,
float *  field 
)
pure virtual

set float Vector Param

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setVectorParam ( const char *  name,
float  u,
float  v,
float  w 
)
pure virtual
virtual void opencover::coInteractor::setVectorParam ( const char *  name,
int  numElem,
int *  field 
)
pure virtual

set int vector parameter

Implemented in opencover::coBaseCoviseInteractor.

virtual void opencover::coInteractor::setVectorParam ( const char *  name,
int  u,
int  v,
int  w 
)
pure virtual

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