Frame.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2021 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
 *
 * 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 FRAME_H
#define FRAME_H
 
#include "CamiTKAPI.h"
 
#include "InterfaceFrame.h"
 
class vtkTransformPolyDataFilter;
class vtkAxesActor;
 
namespace camitk {
class CAMITK_API Frame : public InterfaceFrame {
public:
    Frame(vtkSmartPointer<vtkTransform> transform = nullptr, Frame* parentFrame = nullptr);
 
    ~Frame() override;
 
    const QString& getFrameName() const override final;
 
    void setFrameName(QString name) override;
 
    InterfaceFrame* getParentFrame() const override;
 
    void setParentFrame(InterfaceFrame* parent, bool keepTransform = true) override final;
 
    const QVector<InterfaceFrame*>& getChildrenFrame() const override;
    const vtkSmartPointer<vtkTransform> getTransformFromWorld() const override;
 
    const vtkSmartPointer<vtkTransform> getTransform() const override;
 
    const vtkSmartPointer<vtkTransform> getTransformFromFrame(InterfaceFrame* frame) const override;
 
    void setTransform(vtkSmartPointer<vtkTransform> transform) override final;
 
    void resetTransform() override;
 
    void translate(double x, double y, double z) override;
 
    void rotate(double aroundX, double aroundY, double aroundZ) override;
 
    void rotateVTK(double aroundX, double aroundY, double aroundZ) override;
 
    void setTransformTranslation(double x, double y, double z) override;
 
    void setTransformTranslationVTK(double x, double y, double z) override;
 
    void setTransformRotation(double aroundX, double aroundY, double aroundZ) override;
 
    void setTransformRotationVTK(double aroundX, double aroundY, double aroundZ) override;
 
    vtkSmartPointer<vtkAxesActor> getFrameAxisActor() override;
 
 
    CAMITK_API_DEPRECATED("Please use Frame::setFrameVisibility(QString viewerName, bool) instead") void setFrameVisibility(Viewer*, bool) override;
 
    CAMITK_API_DEPRECATED("Please use Frame::getFrameVisibility(QString viewerName, bool) instead") bool getFrameVisibility(Viewer*) const override;
 
    void setFrameVisibility(QString, bool) override;
 
    bool getFrameVisibility(QString) const override;
 
    void removeFrameChild(InterfaceFrame* frame) override final;
 
    void initAttributes();
 
protected:
 
    QString frameName;
 
    InterfaceFrame* parentFrame;
 
    vtkSmartPointer<vtkTransform> transformParentToMe;
 
    vtkSmartPointer<vtkTransform> transformWorldToMe;
 
    vtkSmartPointer<vtkTransformPolyDataFilter> representationTransformFilter;
 
    QVector<InterfaceFrame*> childrenFrame;
 
    QVector<InterfaceFrame*> computeDescendants(InterfaceFrame*);
 
private:
 
    void addFrameChild(InterfaceFrame* frame) override;
 
    static int nbTotalFrames;
 
    vtkSmartPointer<vtkAxesActor> axes;
 
    QMap<Viewer*, bool> frameViewers;
 
};
}
#endif // FRAME_H