vtkMRMLPlotSeriesNode.h

Go to the documentation of this file.

/*==============================================================================

  Copyright (c) Kapteyn Astronomical Institute
  University of Groningen, Groningen, Netherlands. All Rights Reserved.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Davide Punzo, Kapteyn Astronomical Institute,
  and was supported through the European Research Council grant nr. 291531.

==============================================================================*/

#ifndef __vtkMRMLPlotSeriesNode_h
#define __vtkMRMLPlotSeriesNode_h

#include <string>
#include <vector>

// MRML Includes
#include "vtkMRMLNode.h"

class vtkMRMLStorageNode;
class vtkMRMLTableNode;

// VTK Includes
class vtkColor4ub;
class vtkPlot;
class vtkTable;

class VTK_MRML_EXPORT vtkMRMLPlotSeriesNode : public vtkMRMLNode
{
public:
  static vtkMRMLPlotSeriesNode *New();
  vtkTypeMacro(vtkMRMLPlotSeriesNode,vtkMRMLNode);

  enum
    {
    PlotTypeLine,
    PlotTypeBar,
    PlotTypeScatter,
    PlotTypeScatterBar,
    PlotType_Last // must be last
    };

  enum
    {
    MarkerStyleNone,
    MarkerStyleCross,
    MarkerStylePlus,
    MarkerStyleSquare,
    MarkerStyleCircle,
    MarkerStyleDiamond,
    MarkerStyle_Last // must be last
    };

  enum
    {
    LineStyleNone,
    LineStyleSolid,
    LineStyleDash,
    LineStyleDot,
    LineStyleDashDot,
    LineStyleDashDotDot,
    LineStyle_Last // must be last
    };

  void PrintSelf(ostream& os, vtkIndent indent) override;

  //----------------------------------------------------------------
  //----------------------------------------------------------------

  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes( const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  const char* GetNodeTagName() override { return "PlotSeries"; };

  virtual void SetAndObserveTableNodeID(const char *tableNodeID);

  virtual void SetAndObserveTableNodeID(const std::string& tableNodeID);

  virtual vtkMRMLTableNode* GetTableNode();

  void ProcessMRMLEvents (vtkObject *caller,
                                  unsigned long event,
                                  void *callData) override;

  enum
    {
      TableModifiedEvent = 15000
    };

  const char *GetTableNodeID();

  //----------------------------------------------------------------
  //----------------------------------------------------------------

  vtkSetMacro(PlotType, int);
  vtkGetMacro(PlotType, int);

  virtual void SetPlotType(const char* type);

  vtkGetMacro(XColumnName, std::string);
  vtkSetMacro(XColumnName, std::string);

  vtkGetMacro(YColumnName, std::string);
  vtkSetMacro(YColumnName, std::string);

  vtkGetMacro(LabelColumnName, std::string);
  vtkSetMacro(LabelColumnName, std::string);

  static const char *GetPlotTypeAsString(int id);
  static int GetPlotTypeFromString(const char *name);

  vtkSetMacro(MarkerStyle, int);
  vtkGetMacro(MarkerStyle, int);

  static const char *GetMarkerStyleAsString(int id);
  static int GetMarkerStyleFromString(const char *name);

  vtkGetMacro(MarkerSize, float);
  vtkSetMacro(MarkerSize, float);

  vtkSetMacro(LineStyle, int);
  vtkGetMacro(LineStyle, int);

  const char *GetLineStyleAsString(int id);
  int GetLineStyleFromString(const char *name);

  vtkGetMacro(LineWidth, float);
  vtkSetMacro(LineWidth, float);

  vtkGetVector3Macro(Color, double);
  vtkSetVector3Macro(Color, double);

  void SetUniqueColor(const char* colorTableNodeID = nullptr);

  vtkGetMacro(Opacity, double);
  vtkSetMacro(Opacity, double);

  bool IsXColumnRequired();

  //----------------------------------------------------------------
  //----------------------------------------------------------------
protected:
  vtkMRMLPlotSeriesNode();
  ~vtkMRMLPlotSeriesNode() override;
  vtkMRMLPlotSeriesNode(const vtkMRMLPlotSeriesNode&);
  void operator=(const vtkMRMLPlotSeriesNode&);

  static const char* TableNodeReferenceRole;
  static const char* TableNodeReferenceMRMLAttributeName;

  virtual const char* GetTableNodeReferenceRole();
  virtual const char* GetTableNodeReferenceMRMLAttributeName();

  void OnNodeReferenceAdded(vtkMRMLNodeReference *reference) override
  {
    Superclass::OnNodeReferenceAdded(reference);
    if (std::string(reference->GetReferenceRole()) == this->TableNodeReferenceRole)
      {
      this->InvokeCustomModifiedEvent(vtkMRMLPlotSeriesNode::TableModifiedEvent, reference->GetReferencedNode());
      }
  }

  void OnNodeReferenceModified(vtkMRMLNodeReference *reference) override
  {
    Superclass::OnNodeReferenceModified(reference);
    if (std::string(reference->GetReferenceRole()) == this->TableNodeReferenceRole)
    {
      this->InvokeCustomModifiedEvent(vtkMRMLPlotSeriesNode::TableModifiedEvent, reference->GetReferencedNode());
    }
  }

  void OnNodeReferenceRemoved(vtkMRMLNodeReference *reference) override
  {
    Superclass::OnNodeReferenceRemoved(reference);
    if (std::string(reference->GetReferenceRole()) == this->TableNodeReferenceRole)
    {
      this->InvokeCustomModifiedEvent(vtkMRMLPlotSeriesNode::TableModifiedEvent, reference->GetReferencedNode());
    }
  }

  vtkMRMLCopyContentMacro(vtkMRMLPlotSeriesNode);

  //----------------------------------------------------------------
  //----------------------------------------------------------------
 protected:

  int PlotType{PlotTypeLine};

  std::string XColumnName;
  std::string YColumnName;
  std::string LabelColumnName;

  float LineWidth{2};
  int LineStyle{LineStyleSolid};

  float MarkerSize{7};
  int MarkerStyle{MarkerStyleCircle};

  double Color[3];
  double Opacity{1.0};
};

#endif