---

P_Tool.h

Go to the documentation of this file.

/***************************************************************************
 *cr                                                                       
 *cr            (C) Copyright 1995-2019 The Board of Trustees of the           
 *cr                        University of Illinois                       
 *cr                         All Rights Reserved                        
 *cr                                                                   
 ***************************************************************************/

/***************************************************************************
 * RCS INFORMATION:
 *
 *      $RCSfile: P_Tool.h,v $
 *      $Author: johns $        $Locker:  $             $State: Exp $
 *      $Revision: 1.67 $       $Date: 2019/01/17 21:21:01 $
 *
 ***************************************************************************/
#ifndef P_TOOL_H
#define P_TOOL_H

#include "UIObject.h"
#include "JString.h"
#include "Matrix4.h"

class Displayable;
class VMDTracker;
class Buttons;
class Feedback;
class SensorConfig;

#define TARGET_TUG  0
#define TARGET_GRAB 1

class Tool : public UIObject {
public:
  Tool(int id, VMDApp *, Displayable *aParentDisplayable);
  virtual ~Tool();

  int id() const { return my_id; }

  int steal_sensor(Tool *from); 

  int add_tracker(VMDTracker *, const SensorConfig *);
  int add_feedback(Feedback *, const SensorConfig *);
  int add_buttons(Buttons *, const SensorConfig *);

  int remove_device(const char *device);

  void getdevices(char **ret);
  const char *get_tracker() const { return tracker ? (const char *)trackerDev : NULL; }
  const char *get_feedback() const { return feedback ? (const char *)feedbackDev : NULL; }
  const char *get_buttons() const { return buttons ? (const char *)buttonDev : NULL; }

  float getscale();
  void setscale(float scale);

  float getspringscale() const { return springscale; }
  void setspringscale(float s) { springscale = s;    }

  float getforcescale() { return forcescale; }
  void setforcescale(float f) { forcescale = f; }

  const float *getoffset();
  void setoffset(float *offset);

  virtual const float *position() const;

  virtual const Matrix4 *orientation();

  virtual int isgrabbing();

  int alive() const { return amalive; }

  void kill() { amalive = 0; }

  virtual const char *type_name() const = 0; 

  virtual int check_event();

protected:
  float forcescale;       
  float springscale;      

private:
  int amalive;            

  VMDTracker *tracker;
  Feedback *feedback;
  Buttons *buttons;
  JString trackerDev, feedbackDev, buttonDev;

  int lost_sensor;        

  void update();
  void clear_devices();

  float pos[3];           
  Matrix4 orient;         
  const int my_id;        

  // Picking state for this tool.
  int targeted_molecule;  
  int targeted_atom;      
  char *targeted_rep;     

  Matrix4 last_rot;
  float last_pos[3];
  float sel_total_mass;

public:
  // Turning grabbing on and off is still done from within P_UIVR, so these
  // need to be public for now.
  int grabs;
  void dograb();
  void ungrab();

  int assign_rep(int mol, int rep);

  int get_rep_molid() const { return targeted_molecule; }
  
  const char *get_rep_name() const { return targeted_rep; }

  void clear_rep() { 
    delete [] targeted_rep;
    targeted_molecule = -1;
    targeted_rep = NULL;
    sel_total_mass = 0;
    let_go();
  }

protected:
  Displayable *dtool;
  
  virtual void do_event() {}

  // These are all the methods for querying and manipulating the picking state.

  int target(int target_type, float *mpos, int just_checking);

  void let_go() { if (!targeted_rep) targeted_molecule = -1; }

  int is_targeted() const { return targeted_molecule != -1; }

  int get_targeted_atom(int *molret, int *atomret) const;

  void tool_location_update();

  float getTargetScale();

  void tug(const float *);

  int dimension();

  void setplaneconstraint(float k, const float *point, const float *normal);
  void addplaneconstraint(float k, const float *point, const float *normal);
  void setconstraint(float k, const float *point); 
  void setforcefield(const float *origin, const float *force, 
                     const float *jacobian);

  void sendforce();

  void forceoff();

  int wasgrabbing;
};

#endif

---