UsTK : Ultrasound ToolKit  version 2.0.1 under development (2024-05-17)
usNeedleInsertionModelInterface.h
1 /****************************************************************************
2  *
3  * This file is part of the ustk software.
4  * Copyright (C) 2016 - 2017 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * ("GPL") version 2 as published by the Free Software Foundation.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ustk with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * This software was developed at:
17  * Inria Rennes - Bretagne Atlantique
18  * Campus Universitaire de Beaulieu
19  * 35042 Rennes Cedex
20  * France
21  *
22  * If you have questions regarding the use of this file, please contact
23  * Inria at ustk@inria.fr
24  *
25  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
26  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
27  *
28  * Author:
29  * Jason Chevrie
30  *
31  *****************************************************************************/
32 
33 #ifndef __usNeedleInsertionModelInterface_h
34 #define __usNeedleInsertionModelInterface_h
35 
36 #include <visp3/core/vpColVector.h>
37 #include <visp3/core/vpHomogeneousMatrix.h>
38 #include <visp3/core/vpPoseVector.h>
39 
41 {
42 public:
44 
45  virtual bool setBasePose(
46  const vpPoseVector &pose) = 0; // must set the base pose and automatically update the whole state of the model
47  virtual vpPoseVector getBasePose() const = 0;
48 
50  bool setBasePose(double tx, double ty, double tz, double thetax, double thetay, double thetaz);
51  bool setBasePose(const vpHomogeneousMatrix &Hpose);
52 
53  vpHomogeneousMatrix getWorldMbase() const;
54  vpColVector getBasePosition() const;
55 
56  bool moveBase(const vpColVector &v, double time);
57  bool moveBase(double tx, double ty, double tz, double thetax, double thetay, double thetaz);
58  bool moveBase(const vpPoseVector &pose);
59  bool moveBase(const vpColVector &v);
60  bool moveBase(const vpHomogeneousMatrix &Hmotion);
61 
62  bool moveBaseWorldFrame(const vpColVector &command, double time);
63  bool moveBaseWorldFrame(double tx, double ty, double tz, double thetax, double thetay, double thetaz);
64  bool moveBaseWorldFrame(const vpPoseVector &pose);
65  bool moveBaseWorldFrame(const vpColVector &v);
66  bool moveBaseWorldFrame(const vpHomogeneousMatrix &Hmotion);
67 };
68 
69 #endif // __usNeedleInsertionModelInterface_h
virtual bool setBasePose(const vpPoseVector &pose)=0
The following methods should be redefined in the derived classes.
virtual vpPoseVector getBasePose() const =0