vtkMRMLPlotDataNode.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 __vtkMRMLPlotDataNode_h
#define __vtkMRMLPlotDataNode_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 vtkMRMLPlotDataNode : public vtkMRMLNode
{
public:
  static vtkMRMLPlotDataNode *New();
  vtkTypeMacro(vtkMRMLPlotDataNode,vtkMRMLNode);

  // Description:
  // Enum of the available plot types
  enum {
    LINE,
    POINTS,
    BAR,
  };

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

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

  virtual vtkMRMLNode* CreateNodeInstance() VTK_OVERRIDE;

  virtual void ReadXMLAttributes( const char** atts) VTK_OVERRIDE;

  virtual void WriteXML(ostream& of, int indent) VTK_OVERRIDE;

  virtual const char* GetNodeTagName() VTK_OVERRIDE { return "PlotData"; };

  virtual bool SetAndObserveTableNodeID(const char *TableNodeID);

  virtual bool SetAndObserveTableNodeID(const std::string& TableNodeID);

  virtual vtkMRMLTableNode* GetTableNode();

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

  enum
    {
      TableModifiedEvent = 15000
    };

  const char *GetTableNodeID();

  virtual void UpdateScene(vtkMRMLScene * scene) VTK_OVERRIDE;

  virtual void OnNodeAddedToScene() VTK_OVERRIDE;

  virtual void UpdateReferenceID(const char *oldID, const char *newID) VTK_OVERRIDE;

  virtual void SetSceneReferences() VTK_OVERRIDE;

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

  virtual void SetAndObservePlot(vtkPlot* plot);

  vtkGetObjectMacro(Plot, vtkPlot);

  vtkGetMacro(Type, int);

  virtual void SetType(int type);

  virtual void SetType(const char* type);

  vtkGetMacro(XColumnName, vtkStdString);

  virtual void SetXColumnName(vtkStdString xColumnName);

  vtkGetMacro(YColumnName, vtkStdString);

  virtual void SetYColumnName(vtkStdString yColumnName);

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

  virtual void SetMarkerStyle(int style);
  virtual int GetMarkerStyle();

  const char *GetMarkersStyleAsString(int id);
  int GetMarkersStyleFromString(const char *name);

  virtual void SetMarkerSize(float size);
  virtual float GetMarkerSize();

  virtual void SetLineWidth(float width);
  virtual float GetLineWidth();

  virtual void SetPlotColor(double color[4]);
  virtual void SetPlotColor(unsigned char color[4]);
  virtual void GetPlotColor(double color[4]);
  virtual void GetPlotColor(unsigned char color[4]);

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

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

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

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

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

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

  virtual void Copy(vtkMRMLNode *node) VTK_OVERRIDE;

  virtual void SetInputData(vtkMRMLTableNode* tableNode,
                            vtkStdString xColumnName,
                            vtkStdString yColumnName);

  virtual void SetInputData(vtkMRMLTableNode* tableNode);

  //----------------------------------------------------------------
  //----------------------------------------------------------------
 protected:
  vtkPlot* Plot;

  int Type;

  vtkStdString XColumnName;
  vtkStdString YColumnName;
};

#endif