InterfaceFrame.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, 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 INTERFACEFRAME_H
#define INTERFACEFRAME_H
 
#include <QString>
#include <vtkAxesActor.h>
#include <memory>
 
namespace camitk {
 
class FrameOfReference;
class Transformation;
 
class InterfaceFrame {
 
public:
    virtual ~InterfaceFrame() = default;
 
    virtual void setFrame(const std::shared_ptr<FrameOfReference>& frame) = 0;
 
    // in conjunction with this method if you need to share the ownership of this frame
    virtual const FrameOfReference* getFrame() const = 0;
 
    virtual QMultiMap<const FrameOfReference*, Component*> getAllFrames(bool includeChildrenFrames = true) = 0;
 
    virtual QMultiMap<const Transformation*, Component*> getAllTransformations(bool includeChildrenTransformations = true) = 0;
 
    virtual void setFrameFrom(const InterfaceFrame*) = 0;
 
    virtual void resetFrame() = 0;
 
    virtual vtkSmartPointer<vtkAxesActor> getFrameAxisActor(QString) = 0;
 
    virtual bool getFrameVisibility(QString) const = 0;
 
    virtual void setFrameVisibility(QString, bool) = 0;
 
};
 
}
 
#endif // INTERFACEFRAME_H