ENH: Add ctkVTKColorTransferFunction

Add a concrete implementation of the virtual pure ctkTransferFunction. ctkVTKColorTransferFunction manages a vtkColorTransferFunction.

Libs/Visualization/VTK/Core/CMakeLists.txt

@@ -23,6 +23,8 @@ SET(KIT_include_directories
   
 # Source files
 SET(KIT_SRCS
+  ctkVTKColorTransferFunction.cpp
+  ctkVTKColorTransferFunction.h
   ctkVTKCommandOptions.cpp
   ctkVTKCommandOptions.h
   ctkVTKConnection.cpp
@@ -34,6 +36,7 @@ SET(KIT_SRCS
 
 # Headers that should run through moc
 SET(KIT_MOC_SRCS
+  ctkVTKColorTransferFunction.h
   ctkVTKConnection.h
   ctkVTKObjectEventsObserver.h
   )
@@ -49,6 +52,7 @@ SET(KIT_resources
 # Set VTK_LIBRARIES variable
 SET(VTK_LIBRARIES
   vtkCommon
+  vtkFiltering
   )
 
 # Target libraries - See CMake/ctkMacroGetTargetLibraries.cmake

Libs/Visualization/VTK/Core/ctkVTKColorTransferFunction.cpp

@@ -0,0 +1,238 @@
+/*=========================================================================
+
+  Library:   ctk
+
+  Copyright (c) Kitware Inc. 
+  All rights reserved.
+  Distributed under a BSD License. See LICENSE.txt file.
+
+  This software is distributed "AS IS" WITHOUT ANY WARRANTY; without even
+  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the above copyright notice for more information.
+
+=========================================================================*/
+
+/// Qt includes
+#include <QColor>
+#include <QDebug>
+
+/// CTK includes
+#include "ctkVTKColorTransferFunction.h"
+
+/// VTK includes
+#include <vtkColorTransferFunction.h>
+#include <vtkSmartPointer.h>
+
+class ctkVTKColorTransferFunctionPrivate: public ctkPrivate<ctkVTKColorTransferFunction>
+{
+public:
+  vtkSmartPointer<vtkColorTransferFunction> ColorTransferFunction;
+};
+
+//-----------------------------------------------------------------------------
+ctkVTKColorTransferFunction::ctkVTKColorTransferFunction(vtkColorTransferFunction* colorTransferFunction, 
+                                                         QObject* parentObject)
+  :ctkTransferFunction(parentObject)
+{
+  CTK_INIT_PRIVATE(ctkVTKColorTransferFunction);
+  this->setColorTransferFunction(colorTransferFunction);
+}
+
+//-----------------------------------------------------------------------------
+ctkVTKColorTransferFunction::~ctkVTKColorTransferFunction()
+{
+}
+
+//-----------------------------------------------------------------------------
+int ctkVTKColorTransferFunction::count()const
+{
+  CTK_D(const ctkVTKColorTransferFunction);
+  if (d->ColorTransferFunction.GetPointer() == 0)
+    {
+    Q_ASSERT(d->ColorTransferFunction.GetPointer());
+    return -1;
+    }
+  return d->ColorTransferFunction->GetSize();
+}
+
+//-----------------------------------------------------------------------------
+void ctkVTKColorTransferFunction::range(qreal& minRange, qreal& maxRange)const
+{
+  CTK_D(const ctkVTKColorTransferFunction);
+  if (d->ColorTransferFunction.GetPointer() == 0)
+    {
+    Q_ASSERT(d->ColorTransferFunction.GetPointer());
+    minRange = 1.;
+    maxRange = 0.;
+    return;
+    }
+  double rangeValues[2];
+  d->ColorTransferFunction->GetRange(rangeValues);
+  minRange = rangeValues[0];
+  maxRange = rangeValues[1];
+}
+
+//-----------------------------------------------------------------------------
+QVariant ctkVTKColorTransferFunction::minValue()const
+{
+  CTK_D(const ctkVTKColorTransferFunction);
+  if (d->ColorTransferFunction.GetPointer() == 0)
+    {
+    Q_ASSERT(d->ColorTransferFunction.GetPointer());
+    return -1;
+    }
+  double rgb[3];
+  QColor minValue = QColor::fromRgbF(1.,1.,1.);
+  for (int i = 0; i < this->count(); ++i)
+    {
+    d->ColorTransferFunction->GetColor(i, rgb);
+    QColor color = QColor::fromRgbF(rgb[0], rgb[1], rgb[2]);
+    if ( qGray(color.red(), color.green(), color.blue()) <
+         qGray(minValue.red(), minValue.green(), minValue.blue()))
+      {
+      minValue = color;
+      }
+    }
+  return minValue;
+}
+
+//-----------------------------------------------------------------------------
+QVariant ctkVTKColorTransferFunction::maxValue()const
+{
+  CTK_D(const ctkVTKColorTransferFunction);
+  if (d->ColorTransferFunction.GetPointer() == 0)
+    {
+    Q_ASSERT(d->ColorTransferFunction.GetPointer());
+    return -1;
+    }
+  double rgb[3];
+  QColor minValue = QColor::fromRgbF(0.,0.,0.);
+  for (int i = 0; i < this->count(); ++i)
+    {
+    d->ColorTransferFunction->GetColor(i, rgb);
+    QColor color = QColor::fromRgbF(rgb[0], rgb[1], rgb[2]);
+    if ( qGray(color.red(), color.green(), color.blue()) >
+         qGray(minValue.red(), minValue.green(), minValue.blue()))
+      {
+      minValue = color;
+      }
+    }
+  return minValue;
+}
+
+
+//-----------------------------------------------------------------------------
+ctkControlPoint* ctkVTKColorTransferFunction::controlPoint(int index)const
+{
+  CTK_D(const ctkVTKColorTransferFunction);
+  Q_ASSERT(index >= 0 && index < this->count());
+	double values[6];
+  d->ColorTransferFunction->GetNodeValue(index, values);
+  Q_ASSERT(values[0] >= d->ColorTransferFunction->GetRange()[0] &&
+           values[0] <= d->ColorTransferFunction->GetRange()[1] &&
+           values[1] >= 0. && values[1] <= 1. &&  // Red
+           values[2] >= 0. && values[2] <= 1. &&  // Green
+           values[3] >= 0. && values[3] <= 1. &&  // Blue
+           values[4] >= 0. && values[4] <= 1. &&  // MidPoint
+           values[5] >= 0. && values[5] <= 1.);   // Sharpness
+  ctkBezierControlPoint* cp = new ctkBezierControlPoint();
+  QColor rgb = QColor::fromRgbF(values[1], values[2], values[3]);
+  cp->Value = rgb;
+  cp->Pos = values[0];
+  // TODO convert P1, P2, Value1 and Value2 from midpoint/sharpness to bezier points
+  cp->P1 = values[0];
+  cp->ValueP1 = rgb;
+  index = (index + 1 )%this->count();
+  d->ColorTransferFunction->GetNodeValue(index, values);
+  Q_ASSERT(values[0] >= d->ColorTransferFunction->GetRange()[0] &&
+           values[0] <= d->ColorTransferFunction->GetRange()[1] &&
+           values[1] >= 0. && values[1] <= 1. &&  // Red
+           values[2] >= 0. && values[2] <= 1. &&  // Green
+           values[3] >= 0. && values[3] <= 1. &&  // Blue
+           values[4] >= 0. && values[4] <= 1. &&  // MidPoint
+           values[5] >= 0. && values[5] <= 1.);   // Sharpness
+  // TODO convert P1 and P2
+  cp->P2 = (index ? values[0] : cp->P1);
+  cp->ValueP2 = QColor::fromRgbF(values[1], values[2], values[3]);
+  return cp;
+}
+
+//-----------------------------------------------------------------------------
+QVariant ctkVTKColorTransferFunction::value(qreal pos)const
+{
+  CTK_D(const ctkVTKColorTransferFunction);
+  Q_ASSERT(d->ColorTransferFunction.GetPointer());
+  double rgb[3];
+  d->ColorTransferFunction->GetColor(pos, rgb);
+  QColor color = QColor::fromRgbF(rgb[0], rgb[1], rgb[2]);
+  return color;
+}
+
+//-----------------------------------------------------------------------------
+int ctkVTKColorTransferFunction::insertControlPoint(const ctkControlPoint& cp)
+{
+  CTK_D(ctkVTKColorTransferFunction);
+  int index = -1;
+  if (d->ColorTransferFunction.GetPointer() == 0)
+    {
+    return index;
+    }
+  QColor rgb = cp.Value.value<QColor>();
+  const ctkBezierControlPoint* bezierCp = dynamic_cast<const ctkBezierControlPoint*>(&cp);
+  if (bezierCp)
+    {
+    // TODO convert P1 and P2
+    index = d->ColorTransferFunction->AddRGBPoint(
+      cp.Pos, rgb.redF(), rgb.greenF(), rgb.blueF(), bezierCp->P1, bezierCp->P2);
+    }
+  else
+    {
+    index = d->ColorTransferFunction->AddRGBPoint(
+      cp.Pos, rgb.redF(), rgb.greenF(), rgb.blueF());
+    }
+  return index;
+}
+
+//-----------------------------------------------------------------------------
+void ctkVTKColorTransferFunction::setControlPointPos(int index, qreal pos)
+{
+  CTK_D(ctkVTKColorTransferFunction);
+  double values[6];
+  d->ColorTransferFunction->GetNodeValue(index, values);
+  values[0] = pos;
+  // warning, a possible new range is not supported
+  // SetNodeValue eventually fire the signal changed()
+  d->ColorTransferFunction->SetNodeValue(index, values);
+}
+
+//-----------------------------------------------------------------------------
+void ctkVTKColorTransferFunction::setControlPointValue(int index, const QVariant& value)
+{
+  CTK_D(ctkVTKColorTransferFunction);
+  Q_ASSERT(value.value<QColor>().isValid());
+  QColor rgb = value.value<QColor>();
+  double values[6];
+  d->ColorTransferFunction->GetNodeValue(index, values);
+  values[1] = rgb.redF();
+  values[2] = rgb.greenF();
+  values[3] = rgb.blueF();
+  // setNodeValue should eventually fired the signal changed()
+  d->ColorTransferFunction->SetNodeValue(index, values);
+}
+
+//-----------------------------------------------------------------------------
+void ctkVTKColorTransferFunction::setColorTransferFunction(vtkColorTransferFunction* colorTransferFunction)
+{
+  CTK_D(ctkVTKColorTransferFunction);
+  d->ColorTransferFunction = colorTransferFunction;
+  this->qvtkReconnect(d->ColorTransferFunction,vtkCommand::ModifiedEvent,
+                      this, SIGNAL(changed()));
+  emit changed();
+}
+
+//-----------------------------------------------------------------------------
+vtkColorTransferFunction* ctkVTKColorTransferFunction::colorTransferFunction()const
+{
+  CTK_D(const ctkVTKColorTransferFunction);
+  return d->ColorTransferFunction;
+}

Libs/Visualization/VTK/Core/ctkVTKColorTransferFunction.h

@@ -0,0 +1,55 @@
+/*=========================================================================
+
+  Library:   ctk
+
+  Copyright (c) Kitware Inc. 
+  All rights reserved.
+  Distributed under a BSD License. See LICENSE.txt file.
+
+  This software is distributed "AS IS" WITHOUT ANY WARRANTY; without even
+  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the above copyright notice for more information.
+
+=========================================================================*/
+
+#ifndef __ctkVTKColorTransferFunction_h
+#define __ctkVTKColorTransferFunction_h
+
+// CTK includes
+#include "ctkTransferFunction.h"
+#include "ctkPimpl.h"
+#include "CTKVisualizationVTKCoreExport.h"
+#include "ctkVTKObject.h"
+
+class vtkColorTransferFunction;
+class ctkVTKColorTransferFunctionPrivate;
+
+//-----------------------------------------------------------------------------
+class CTK_VISUALIZATION_VTK_CORE_EXPORT ctkVTKColorTransferFunction: public ctkTransferFunction
+{
+  Q_OBJECT;
+  QVTK_OBJECT;
+public:
+  ctkVTKColorTransferFunction(vtkColorTransferFunction* colorTransferFunction, 
+                              QObject* parent = 0);
+  virtual ~ctkVTKColorTransferFunction();
+  
+  virtual ctkControlPoint* controlPoint(int index)const;
+  virtual QVariant value(qreal pos)const;
+  virtual int count()const;
+
+  virtual void range(qreal& minRange, qreal& maxRange)const;
+  virtual QVariant minValue()const;
+  virtual QVariant maxValue()const;
+
+  virtual int insertControlPoint(const ctkControlPoint& cp);
+  virtual void setControlPointPos(int index, qreal pos);
+  virtual void setControlPointValue(int index, const QVariant& value);
+  
+  void setColorTransferFunction(vtkColorTransferFunction* colorTransferFunction);
+  vtkColorTransferFunction* colorTransferFunction()const;
+private:
+  CTK_DECLARE_PRIVATE(ctkVTKColorTransferFunction);
+};
+
+#endif