ComplexCoordinateFrameSceneObject.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLGeom/src/ICLGeom/ComplexCoordinateFrameSceneObject. **
**          h                                                      **
** Module : ICLGeom                                                **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#ifndef ICL_HAVE_OPENGL
#if WIN32
#pragma WARNING("this header must not be included if ICL_HAVE_OPENGL is not defined")
#else
#warning "this header must not be included if ICL_HAVE_OPENGL is not defined"
#endif
#else

#include <ICLUtils/CompatMacros.h>
#include <ICLGeom/SceneObject.h>
#include <ICLUtils/Mutex.h>

namespace icl{
  namespace geom{


    class ComplexCoordinateFrameSceneObject : public SceneObject{
      utils::Mutex mutex;

      float axisLength;

      float axisThickness;

      std::string xLabel, yLabel, zLabel;

      public:

      ICLGeom_API ComplexCoordinateFrameSceneObject(float axisLength=100,float axisThickness=5,
                                                    bool withXYZLabels=true,
                                                    const std::string &xLabel="x",
                                                    const std::string &yLabel="y",
                                                    const std::string &zLabel="z");

      ICLGeom_API ComplexCoordinateFrameSceneObject(float axisLengths[3],float axisThickness=5,
                                                    bool withXYZLabels=true,
                                                    const std::string &xLabel="x",
                                                    const std::string &yLabel="y",
                                                    const std::string &zLabel="z",
                                                    const GeomColor &xAxisColor=GeomColor(255,0,0,255),
                                                    const GeomColor &yAxisColor=GeomColor(0,255,0,255),
                                                    const GeomColor &zAxisColor=GeomColor(0,0,255,255),
                                                    const GeomColor &textLabelColor=GeomColor(255,255,255,255),
                                                    float textScaling=1.0f);



      ICLGeom_API void setParams(float axisLength[3], float axisThickness, bool withXYZLabels = true,
                                 const GeomColor &xAxisColor=GeomColor(255,0,0,255),
                                 const GeomColor &yAxisColor=GeomColor(0,255,0,255),
                                 const GeomColor &zAxisColor=GeomColor(0,0,255,255),
                                 const GeomColor &textLabelColor=GeomColor(255,255,255,255),
                                 float textScaling = 1.0f);

      inline float getAxisLength() const { return axisLength; }

      inline float getAxisThickness() const { return axisThickness; }

      virtual void lock() { mutex.lock(); }

      virtual void unlock() { mutex.unlock(); }
    };
  } // namespace geom
}

#endif