vtkMRMLColorLegendDisplayNode.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  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.

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

#ifndef __vtkMRMLColorLegendDisplayNode_h
#define __vtkMRMLColorLegendDisplayNode_h

// MRML includes
#include <vtkMRMLDisplayNode.h>
#include "vtkSlicerColorsModuleMRMLExport.h"

class vtkMRMLColorNode;
class vtkTextProperty;

class VTK_SLICER_COLORS_MODULE_MRML_EXPORT vtkMRMLColorLegendDisplayNode : public vtkMRMLDisplayNode
{
public:
  enum OrientationType : int { Horizontal = 0, Vertical, Orientation_Last };

  static vtkMRMLColorLegendDisplayNode *New();
  vtkTypeMacro(vtkMRMLColorLegendDisplayNode,vtkMRMLDisplayNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMRMLNode* CreateNodeInstance() override;

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

  void ReadXMLAttributes(const char** atts) override;

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

  vtkMRMLCopyContentMacro(vtkMRMLColorLegendDisplayNode);

  vtkGetMacro(Orientation, OrientationType);
  vtkSetMacro(Orientation, OrientationType);

  vtkGetVector2Macro(Position, double);
  vtkSetVector2Macro(Position, double);

  vtkGetVector2Macro(Size, double);
  vtkSetVector2Macro(Size, double);

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

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

  virtual std::string GetDefaultNumericLabelFormat();

  virtual std::string GetDefaultTextLabelFormat();

  vtkGetMacro(MaxNumberOfColors, int);
  vtkSetMacro(MaxNumberOfColors, int);

  vtkGetMacro(NumberOfLabels, int);
  vtkSetMacro(NumberOfLabels, int);

  vtkGetMacro(UseColorNamesForLabels, bool);
  vtkSetMacro(UseColorNamesForLabels, bool);

  vtkGetObjectMacro(TitleTextProperty, vtkTextProperty);

  vtkGetObjectMacro(LabelTextProperty, vtkTextProperty);

  vtkMRMLDisplayNode* GetPrimaryDisplayNode();
  void SetAndObservePrimaryDisplayNode(vtkMRMLDisplayNode* node);

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

protected:
  vtkMRMLColorLegendDisplayNode();
  ~vtkMRMLColorLegendDisplayNode() override;
  vtkMRMLColorLegendDisplayNode(const vtkMRMLColorLegendDisplayNode&);
  void operator=(const vtkMRMLColorLegendDisplayNode&);

  static const char* GetOrientationAsString(int id);
  static int GetOrientationFromString(const char* name);
  void SetOrientation(int id);

  void SetTitleTextPropertyFromString(std::string textPropertyString);
  void SetLabelTextPropertyFromString(std::string textPropertyString);
  std::string GetTitleTextPropertyAsString();
  std::string GetLabelTextPropertyAsString();

private:
  OrientationType Orientation{ vtkMRMLColorLegendDisplayNode::Vertical }; // Vertical or Horizontal
  double Position[2]{ 0.95, 0.5 }; // color legend position within view
  double Size[2]{ 0.15, 0.5 }; // color legend width within view
  std::string TitleText; // color legend title
  vtkTextProperty* TitleTextProperty{ nullptr };
  vtkTextProperty* LabelTextProperty{ nullptr };
  // 7 so that the number appears aligned to the right even if it is large (>1000)
  // .1 to show one fractional digit
  // f to make the behavior more predictable for users (behavior of g is somewhat complex)
  std::string LabelFormat;
  int MaxNumberOfColors{ 256 };
  int NumberOfLabels{ 5 };
  bool UseColorNamesForLabels{ false };
  bool CenterLabels{ false };
};

#endif