cxCustomMetric.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/
#ifndef CXCUSTOMMETRIC_H
#define CXCUSTOMMETRIC_H

#include "cxResourceExport.h"
#include "cxPrecompiledHeader.h"

#include "cxDataMetric.h"
#include "cxPointMetric.h"
#include "cxMetricReferenceArgumentList.h"

namespace cx
{
typedef boost::shared_ptr<class CustomMetric> CustomMetricPtr;

class cxResource_EXPORT CustomMetric: public DataMetric
{
Q_OBJECT
public:
    virtual ~CustomMetric();
    static CustomMetricPtr create(QString uid, QString name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider);

        virtual bool isValid() const;
        virtual QString getAsSingleLineString() const;
    virtual QIcon getIcon() {return QIcon(":/icons/metric_custom.png");}

    QString getDefineVectorUpMethod() const;
    void setDefineVectorUpMethod(QString defineVectorUpMethod);
        void setModelUid(QString val);
        QString getModelUid() const;
        DataPtr getModel() const;

        void setScaleToP1(bool val);
        bool getScaleToP1() const;
        void setOffsetFromP0(double val);
        double getOffsetFromP0() const;
        void setOffsetFromP1(double val);
        double getOffsetFromP1() const;
        void setRepeatDistance(double val);
        double getRepeatDistance() const;
        void setTranslationOnly(bool val);
        bool getTranslationOnly() const;
        void setTextureFollowTool(bool val);
        bool getTextureFollowTool() const;

        MetricReferenceArgumentListPtr getArguments() { return mArguments; }
        virtual void addXml(QDomNode& dataNode); 
        virtual void parseXml(QDomNode& dataNode); 
        virtual DoubleBoundingBox3D boundingBox() const;
        virtual Vector3D getRefCoord() const;
        virtual QString getType() const
        {
                return getTypeName();
        }
        static QString getTypeName()
        {
        return "CustomMetric";
        }
        virtual QString getValueAsString() const { return ""; }
        virtual bool showValueInGraphics() const { return false; }

private:
        std::vector<Vector3D> getPositions() const;
        Vector3D getDirection() const;
        Vector3D getVectorUp() const;
        Vector3D getScale() const;

        struct cxResource_EXPORT DefineVectorUpMethods
    {
        DefineVectorUpMethods()
        {
            table = "tableDefinesUp";
            connectedFrameInP1 = "connectedFrameDefinesUp";
                        tool = "toolDefinesUp";
        }
        QString table;
        QString connectedFrameInP1;
                QString tool;
                QStringList getAvailableDefineVectorUpMethods() const;
        std::map<QString, QString> getAvailableDefineVectorUpMethodsDisplayNames() const;
    };

    CustomMetric(const QString& uid, const QString& name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider);
        MetricReferenceArgumentListPtr mArguments;
    QString mDefineVectorUpMethod;
        QString mModelUid;
    DefineVectorUpMethods mDefineVectorUpMethods;
        bool mScaleToP1;
        double mOffsetFromP0;
        double mOffsetFromP1;
        double mRepeatDistance;
        bool mShowDistanceMarkers;
        double mDistanceMarkerVisibility;
        bool mTranslationOnly;
        bool mTextureFollowTool;
        SpaceListenerPtr mToolListener;

        Transform3D calculateOrientation(Vector3D pos, Vector3D dir, Vector3D vup, Vector3D scale) const;
        Transform3D calculateRotation(Vector3D dir, Vector3D vup) const;
        Transform3D calculateTransformTo2DImageCenter() const;
        void onPropertiesChanged();
        bool needForToolListenerHasChanged() const;
        void createOrDestroyToolListener();

public:
        CustomMetric::DefineVectorUpMethods getDefineVectorUpMethods() const;
        std::vector<Transform3D> calculateOrientations() const;
        int getRepeatCount() const;
        std::vector<Vector3D> getPointCloud() const;
        bool modelIsImage() const;
        void setShowDistanceMarkers(bool show);
        bool getShowDistanceMarkers() const;
        Vector3D getZeroPosition() const;
        void setDistanceMarkerVisibility(double val);
        double getDistanceMarkerVisibility() const;
        void updateTexture(MeshPtr model, Transform3D rMrr);
};

} // namespace cx

#endif // CXSHAPEDMETRIC_H