InterfaceFrame.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/

#ifndef INTERFACEFRAME_H
#define INTERFACEFRAME_H

#include <QString>
#include <QVector>

// -- std stuff
#include <vector>

// -- vtk stuff
#include <vtkType.h>
#include <vtkSmartPointer.h>

// -- vtk stuff classes
class vtkAxesActor;
class vtkTransform;

namespace camitk {

class Viewer;

class InterfaceFrame {

public:
    virtual ~InterfaceFrame() = default;

    virtual const QString& getFrameName() const = 0;

    virtual void setFrameName(QString name) = 0;

    virtual InterfaceFrame* getParentFrame() const = 0;

    virtual void setParentFrame(InterfaceFrame* parent, bool keepTransform = true) = 0;

    virtual const QVector<InterfaceFrame*>& getChildrenFrame() const = 0;

    virtual const vtkSmartPointer<vtkTransform> getTransformFromWorld() const = 0;

    virtual const vtkSmartPointer<vtkTransform> getTransform() const = 0;

    virtual const vtkSmartPointer<vtkTransform> getTransformFromFrame(InterfaceFrame* frame) const = 0;

    virtual void setTransform(vtkSmartPointer<vtkTransform> transform) = 0;

    virtual void resetTransform() = 0;


    virtual void translate(double x, double y, double z) = 0;

    virtual void rotate(double aroundX, double aroundY, double aroundZ) = 0;

    virtual void rotateVTK(double aroundX, double aroundY, double aroundZ) = 0;

    virtual void setTransformTranslation(double x, double y, double z) = 0;

    virtual void setTransformTranslationVTK(double x, double y, double z) = 0;

    virtual void setTransformRotation(double aroundX, double aroundY, double aroundZ) = 0;

    virtual void setTransformRotationVTK(double aroundX, double aroundY, double aroundZ) = 0;

    virtual vtkSmartPointer<vtkAxesActor> getFrameAxisActor() = 0;

    virtual void setFrameVisibility(Viewer* viewer, bool visible) = 0;

    virtual bool getFrameVisibility(Viewer* viewer) const = 0;

    virtual void addFrameChild(InterfaceFrame* frame) = 0;

    virtual void removeFrameChild(InterfaceFrame* frame) = 0;

};

}

#endif // INTERFACEFRAME_H