TTK
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ttkUserInterfaceBase Class Reference

Interactions and rendering. More...

#include <ttkUserInterfaceBase.h>

Inheritance diagram for ttkUserInterfaceBase:
ttkProgramBase ttk::ProgramBase ttk::Debug ttk::BaseClass vtkUserInterface< ttkModule >

Public Member Functions

 ttkUserInterfaceBase ()
 
 ~ttkUserInterfaceBase () override
 
int exportScene (const std::string &fileName="output.wrl") const
 
ttkKeyHandlergetKeyHandler ()
 
int hideOutputs (const std::vector< int > &outputList)
 
int init (int &argc, char **argv) override
 
int refresh ()
 
int run () override
 
int setKeyHandler (ttkKeyHandler *handler)
 
int switchOutput (const int &outputId)
 
int switchTransparency ()
 
- Public Member Functions inherited from ttkProgramBase
 ttkProgramBase ()
 
 ~ttkProgramBase () override=default
 
int execute () override
 Set the arguments of your ttk module and execute it here.
 
vtkDataSet * getInput (const int &inputId)
 
int getNumberOfInputs ()
 
int run () override
 
int save () const override
 Save the output(s) of the TTK module.
 
virtual int setTTKmodule (vtkDataSetAlgorithm *ttkModule)
 
- Public Member Functions inherited from ttk::ProgramBase
 ProgramBase ()
 
 ~ProgramBase () override=default
 
virtual int init (int &argc, char **argv)
 
virtual int run ()
 
virtual int save () const =0
 Save the output(s) of the TTK module.
 
- Public Member Functions inherited from ttk::Debug
 Debug ()
 
 ~Debug () override
 
virtual int setDebugLevel (const int &debugLevel)
 
int setWrapper (const Wrapper *wrapper) override
 
int printMsg (const std::string &msg, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::vector< std::string > &msgs, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printErr (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const
 
int printWrn (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const double &memory, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::vector< std::vector< std::string > > &rows, const debug::Priority &priority=debug::Priority::INFO, const bool hasHeader=true, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const
 
int printMsg (const debug::Separator &separator, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const
 
void setDebugMsgPrefix (const std::string &prefix)
 
- Public Member Functions inherited from ttk::BaseClass
 BaseClass ()
 
virtual ~BaseClass ()=default
 
int getThreadNumber () const
 
virtual int setThreadNumber (const int threadNumber)
 
virtual int setWrapper (const Wrapper *wrapper)
 

Protected Member Functions

int updateScalarFieldTexture ()
 
- Protected Member Functions inherited from ttkProgramBase
template<class vtkReaderClass >
int load (const std::string &fileName, std::vector< vtkSmartPointer< vtkReaderClass > > &readerList)
 
int load (const std::vector< std::string > &inputPaths) override
 Load a sequence of input data-sets.
 
template<class vtkWriterClass >
int save (const int &outputPortId) const
 
virtual int execute ()=0
 Execute your TTK module here.
 
virtual int load (const std::vector< std::string > &inputPaths)=0
 Load a sequence of input data-sets.
 
- Protected Member Functions inherited from ttk::Debug
int printMsgInternal (const std::string &msg, const std::string &right, const std::string &filler, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsgInternal (const std::string &msg, const debug::Priority &priority, const debug::LineMode &lineMode, std::ostream &stream=std::cout) const
 
int welcomeMsg (std::ostream &stream)
 

Protected Attributes

bool hasTexture_
 
bool isUp_
 
bool repeat_
 
bool transparency_
 
bool fullscreen_
 
std::vector< bool > visibleOutputs_
 
std::vector< int > hiddenOutputs_
 
ttkKeyHandlerkeyHandler_
 
std::vector< vtkPolyData * > surfaces_
 
vtkSmartPointer< ttkCustomInteractorcustomInteractor_
 
std::vector< vtkSmartPointer< vtkActor > > mainActors_
 
std::vector< vtkSmartPointer< vtkDataSetSurfaceFilter > > boundaryFilters_
 
vtkSmartPointer< vtkPNGReader > pngReader_
 
std::vector< vtkSmartPointer< vtkPolyDataMapper > > boundaryMappers_
 
vtkSmartPointer< vtkRenderer > renderer_
 
vtkSmartPointer< vtkRenderWindow > renderWindow_
 
vtkSmartPointer< vtkRenderWindowInteractor > interactor_
 
vtkSmartPointer< vtkTexture > texture_
 
std::vector< vtkSmartPointer< ttkTextureMapFromField > > textureMapFromFields_
 
- Protected Attributes inherited from ttkProgramBase
std::vector< vtkDataSet * > inputs_
 
std::vector< vtkSmartPointer< vtkXMLImageDataReader > > imageDataReaders_
 
std::vector< vtkSmartPointer< vtkXMLPolyDataReader > > polyDataReaders_
 
std::vector< vtkSmartPointer< vtkXMLUnstructuredGridReader > > unstructuredGridReaders_
 
vtkDataSetAlgorithm * vtkWrapper_
 
- Protected Attributes inherited from ttk::ProgramBase
std::string outputPath_
 
DebugttkModule_
 
- Protected Attributes inherited from ttk::Debug
int debugLevel_
 
std::string debugMsgPrefix_
 
std::string debugMsgNamePrefix_
 
- Protected Attributes inherited from ttk::BaseClass
bool lastObject_
 
int threadNumber_
 
Wrapperwrapper_
 

Additional Inherited Members

- Public Attributes inherited from ttk::ProgramBase
CommandLineParser parser_
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

Interactions and rendering.

Author
Julien Tierny julie.nosp@m.n.ti.nosp@m.erny@.nosp@m.lip6.nosp@m..fr.
Date
March 2017.

Definition at line 59 of file ttkUserInterfaceBase.h.

Constructor & Destructor Documentation

◆ ttkUserInterfaceBase()

ttkUserInterfaceBase::ttkUserInterfaceBase ( )

Definition at line 65 of file ttkUserInterfaceBase.cpp.

◆ ~ttkUserInterfaceBase()

ttkUserInterfaceBase::~ttkUserInterfaceBase ( )
overridedefault

Member Function Documentation

◆ exportScene()

int ttkUserInterfaceBase::exportScene ( const std::string &  fileName = "output.wrl") const

Definition at line 91 of file ttkUserInterfaceBase.cpp.

◆ getKeyHandler()

ttkKeyHandler * ttkUserInterfaceBase::getKeyHandler ( )
inline

Definition at line 68 of file ttkUserInterfaceBase.h.

◆ hideOutputs()

int ttkUserInterfaceBase::hideOutputs ( const std::vector< int > &  outputList)
inline

Definition at line 72 of file ttkUserInterfaceBase.h.

◆ init()

int ttkUserInterfaceBase::init ( int &  argc,
char **  argv 
)
overridevirtual

Reimplemented from ttk::ProgramBase.

Definition at line 104 of file ttkUserInterfaceBase.cpp.

◆ refresh()

int ttkUserInterfaceBase::refresh ( )

Definition at line 113 of file ttkUserInterfaceBase.cpp.

◆ run()

int ttkUserInterfaceBase::run ( )
overridevirtual

Reimplemented from ttkProgramBase.

Reimplemented in vtkUserInterface< ttkModule >.

Definition at line 186 of file ttkUserInterfaceBase.cpp.

◆ setKeyHandler()

int ttkUserInterfaceBase::setKeyHandler ( ttkKeyHandler handler)
inline

Definition at line 95 of file ttkUserInterfaceBase.h.

◆ switchOutput()

int ttkUserInterfaceBase::switchOutput ( const int &  outputId)

Definition at line 228 of file ttkUserInterfaceBase.cpp.

◆ switchTransparency()

int ttkUserInterfaceBase::switchTransparency ( )

Definition at line 252 of file ttkUserInterfaceBase.cpp.

◆ updateScalarFieldTexture()

int ttkUserInterfaceBase::updateScalarFieldTexture ( )
protected

Definition at line 270 of file ttkUserInterfaceBase.cpp.

Member Data Documentation

◆ boundaryFilters_

std::vector<vtkSmartPointer<vtkDataSetSurfaceFilter> > ttkUserInterfaceBase::boundaryFilters_
protected

Definition at line 112 of file ttkUserInterfaceBase.h.

◆ boundaryMappers_

std::vector<vtkSmartPointer<vtkPolyDataMapper> > ttkUserInterfaceBase::boundaryMappers_
protected

Definition at line 114 of file ttkUserInterfaceBase.h.

◆ customInteractor_

vtkSmartPointer<ttkCustomInteractor> ttkUserInterfaceBase::customInteractor_
protected

Definition at line 110 of file ttkUserInterfaceBase.h.

◆ fullscreen_

bool ttkUserInterfaceBase::fullscreen_
protected

Definition at line 105 of file ttkUserInterfaceBase.h.

◆ hasTexture_

bool ttkUserInterfaceBase::hasTexture_
protected

Definition at line 105 of file ttkUserInterfaceBase.h.

◆ hiddenOutputs_

std::vector<int> ttkUserInterfaceBase::hiddenOutputs_
protected

Definition at line 107 of file ttkUserInterfaceBase.h.

◆ interactor_

vtkSmartPointer<vtkRenderWindowInteractor> ttkUserInterfaceBase::interactor_
protected

Definition at line 117 of file ttkUserInterfaceBase.h.

◆ isUp_

bool ttkUserInterfaceBase::isUp_
protected

Definition at line 105 of file ttkUserInterfaceBase.h.

◆ keyHandler_

ttkKeyHandler* ttkUserInterfaceBase::keyHandler_
protected

Definition at line 108 of file ttkUserInterfaceBase.h.

◆ mainActors_

std::vector<vtkSmartPointer<vtkActor> > ttkUserInterfaceBase::mainActors_
protected

Definition at line 111 of file ttkUserInterfaceBase.h.

◆ pngReader_

vtkSmartPointer<vtkPNGReader> ttkUserInterfaceBase::pngReader_
protected

Definition at line 113 of file ttkUserInterfaceBase.h.

◆ renderer_

vtkSmartPointer<vtkRenderer> ttkUserInterfaceBase::renderer_
protected

Definition at line 115 of file ttkUserInterfaceBase.h.

◆ renderWindow_

vtkSmartPointer<vtkRenderWindow> ttkUserInterfaceBase::renderWindow_
protected

Definition at line 116 of file ttkUserInterfaceBase.h.

◆ repeat_

bool ttkUserInterfaceBase::repeat_
protected

Definition at line 105 of file ttkUserInterfaceBase.h.

◆ surfaces_

std::vector<vtkPolyData *> ttkUserInterfaceBase::surfaces_
protected

Definition at line 109 of file ttkUserInterfaceBase.h.

◆ texture_

vtkSmartPointer<vtkTexture> ttkUserInterfaceBase::texture_
protected

Definition at line 118 of file ttkUserInterfaceBase.h.

◆ textureMapFromFields_

std::vector<vtkSmartPointer<ttkTextureMapFromField> > ttkUserInterfaceBase::textureMapFromFields_
protected

Definition at line 119 of file ttkUserInterfaceBase.h.

◆ transparency_

bool ttkUserInterfaceBase::transparency_
protected

Definition at line 105 of file ttkUserInterfaceBase.h.

◆ visibleOutputs_

std::vector<bool> ttkUserInterfaceBase::visibleOutputs_
protected

Definition at line 106 of file ttkUserInterfaceBase.h.


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