src/aclvis/Interact.h

Go to the documentation of this file.

// -*- C++ -*-
/***************************************************************************
 *
 * The IPPL Framework
 * 
 *
 * Visit http://people.web.psi.ch/adelmann/ for more details
 *
 ***************************************************************************/

#ifndef ACLVIS_INTERACT_H
#define ACLVIS_INTERACT_H

#include "aclvis/Tool.h"
#include "aclvis/InterpTcl.h"
#include "aclvis/InterpCmdACLVIS.h"

#ifdef IPPL_USE_STANDARD_HEADERS
#include <iostream>
using namespace std;
#else
#include <iostream.h>
#endif

#include <vtk.h>

enum ConnectDataType {FieldDataType, ParticleDataType};

class VizRecord : public vtkObject {
public:
  VizRecord();

  void Print();

  void     *caller;
  char      name[80];
  int       id;
  void     *tool;
  ToolType  tooltype;
};

class VizCollection : public vtkCollection {
public:
  int         MatchTest(VizRecord *, VizRecord *);
  VizRecord  *FindItem(VizRecord *);
  VizRecord  *FindNextItem(VizRecord *);
};

class VizTool {
public:
  VizTool();

  // API methods to execute an interpreted command, or to hand off
  // control to the interpreter
  void           InterpretCommand(const char *);
  void           InterpretInteract(int timeoutseconds = (-1));

  void           SetSelectedTool(ToolType, Tool *);

  int            GetUniqueToolId(ToolType);
  Tool          *GetSelectedTool(ToolType);
  VizCollection *GetVizDB();

  void           InitToolIds();
  void           Interact(int);
  void           InteractExit();     // Give conrol to the app
  void           InteractGoFlow();   // When app gives control to viz, 
                                     //  update and return control 
  void           InteractStopFlow(); // Keep control when given control by app
  void           connect(void *caller, char *, void *data, ConnectDataType ctype);
  void           disconnect(void *caller);
  void           update(void *caller);

  // methods used to modify how image files are written out
  void SetImageFileBase(const char *);
  void SetImageFileExt(const char *);
  void SetImageNextNum(unsigned int);

private:
  int            InteractFlag;
  VizCollection *viz_db;
  int            ToolId[NUM_OF_TOOL_TYPES];
  Tool          *SelectedTool[NUM_OF_TOOL_TYPES];

  int            interactIter; // tracks the number of interactions
  int            goFlag; // controls weather the control
                           // is given back to the app as soon
                           // as the data has been updated

  // a TCL-based interpreter, and associated commands
  InterpTcl      interpreter;
  InterpCmdTool  *toolcmd;

  // info for writing out image files
  char *image_file_base;
  char *image_file_ext;
  unsigned int image_next_num;

  // from these names, get the next image filename, and put it in the
  // provided buffer
  bool GetImageName(char *);
};


#endif // ACLVIS_INTERACT_H

/***************************************************************************
 * $RCSfile: Interact.h,v $   $Author: adelmann $
 * $Revision: 1.1.1.1 $   $Date: 2003/01/23 07:40:34 $
 * IPPL_VERSION_ID: $Id: Interact.h,v 1.1.1.1 2003/01/23 07:40:34 adelmann Exp $ 
 ***************************************************************************/

---