You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
343 lines
9.6 KiB
C++
343 lines
9.6 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkViewTheme.h
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notice for more information.
|
|
|
|
=========================================================================*/
|
|
/*-------------------------------------------------------------------------
|
|
Copyright 2008 Sandia Corporation.
|
|
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
the U.S. Government retains certain rights in this software.
|
|
-------------------------------------------------------------------------*/
|
|
/**
|
|
* @class vtkViewTheme
|
|
* @brief Sets theme colors for a graphical view.
|
|
*
|
|
*
|
|
* This may be set on any subclass of vtkView. The view class will attempt
|
|
* to use the values set in the theme to customize the view. Views will not
|
|
* generally use every aspect of the theme.
|
|
* NOTICE: This class will be deprecated in favor of a more robust
|
|
* solution based on style sheets. Do not become overly-dependent on the
|
|
* functionality of themes.
|
|
*/
|
|
|
|
#ifndef vtkViewTheme_h
|
|
#define vtkViewTheme_h
|
|
|
|
#include "vtkObject.h"
|
|
#include "vtkViewsCoreModule.h" // For export macro
|
|
|
|
class vtkScalarsToColors;
|
|
class vtkTextProperty;
|
|
|
|
class VTKVIEWSCORE_EXPORT vtkViewTheme : public vtkObject
|
|
{
|
|
public:
|
|
static vtkViewTheme* New();
|
|
vtkTypeMacro(vtkViewTheme, vtkObject);
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
|
|
|
//@{
|
|
/**
|
|
* The size of points or vertices
|
|
*/
|
|
vtkSetMacro(PointSize, double);
|
|
vtkGetMacro(PointSize, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The width of lines or edges
|
|
*/
|
|
vtkSetMacro(LineWidth, double);
|
|
vtkGetMacro(LineWidth, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The color and opacity of points or vertices when not mapped through
|
|
* a lookup table.
|
|
*/
|
|
vtkSetVector3Macro(PointColor, double);
|
|
vtkGetVector3Macro(PointColor, double);
|
|
vtkSetMacro(PointOpacity, double);
|
|
vtkGetMacro(PointOpacity, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The ranges to use in the point lookup table.
|
|
* You may also do this by accessing the point lookup table directly
|
|
* with GetPointLookupTable() and calling these methods.
|
|
*/
|
|
virtual void SetPointHueRange(double mn, double mx);
|
|
virtual void SetPointHueRange(double rng[2]);
|
|
virtual double* GetPointHueRange();
|
|
virtual void GetPointHueRange(double& mn, double& mx);
|
|
virtual void GetPointHueRange(double rng[2]);
|
|
//@}
|
|
|
|
virtual void SetPointSaturationRange(double mn, double mx);
|
|
virtual void SetPointSaturationRange(double rng[2]);
|
|
virtual double* GetPointSaturationRange();
|
|
virtual void GetPointSaturationRange(double& mn, double& mx);
|
|
virtual void GetPointSaturationRange(double rng[2]);
|
|
|
|
virtual void SetPointValueRange(double mn, double mx);
|
|
virtual void SetPointValueRange(double rng[2]);
|
|
virtual double* GetPointValueRange();
|
|
virtual void GetPointValueRange(double& mn, double& mx);
|
|
virtual void GetPointValueRange(double rng[2]);
|
|
|
|
virtual void SetPointAlphaRange(double mn, double mx);
|
|
virtual void SetPointAlphaRange(double rng[2]);
|
|
virtual double* GetPointAlphaRange();
|
|
virtual void GetPointAlphaRange(double& mn, double& mx);
|
|
virtual void GetPointAlphaRange(double rng[2]);
|
|
|
|
//@{
|
|
/**
|
|
* Set/Get the point lookup table.
|
|
*/
|
|
vtkGetObjectMacro(PointLookupTable, vtkScalarsToColors);
|
|
virtual void SetPointLookupTable(vtkScalarsToColors* lut);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* Whether to scale the lookup table to fit the range of the data.
|
|
*/
|
|
vtkSetMacro(ScalePointLookupTable, bool);
|
|
vtkGetMacro(ScalePointLookupTable, bool);
|
|
vtkBooleanMacro(ScalePointLookupTable, bool);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The color and opacity of cells or edges when not mapped through
|
|
* a lookup table.
|
|
*/
|
|
vtkSetVector3Macro(CellColor, double);
|
|
vtkGetVector3Macro(CellColor, double);
|
|
vtkSetMacro(CellOpacity, double);
|
|
vtkGetMacro(CellOpacity, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The ranges to use in the cell lookup table.
|
|
* You may also do this by accessing the cell lookup table directly
|
|
* with GetCellLookupTable() and calling these methods.
|
|
*/
|
|
virtual void SetCellHueRange(double mn, double mx);
|
|
virtual void SetCellHueRange(double rng[2]);
|
|
virtual double* GetCellHueRange();
|
|
virtual void GetCellHueRange(double& mn, double& mx);
|
|
virtual void GetCellHueRange(double rng[2]);
|
|
//@}
|
|
|
|
virtual void SetCellSaturationRange(double mn, double mx);
|
|
virtual void SetCellSaturationRange(double rng[2]);
|
|
virtual double* GetCellSaturationRange();
|
|
virtual void GetCellSaturationRange(double& mn, double& mx);
|
|
virtual void GetCellSaturationRange(double rng[2]);
|
|
|
|
virtual void SetCellValueRange(double mn, double mx);
|
|
virtual void SetCellValueRange(double rng[2]);
|
|
virtual double* GetCellValueRange();
|
|
virtual void GetCellValueRange(double& mn, double& mx);
|
|
virtual void GetCellValueRange(double rng[2]);
|
|
|
|
virtual void SetCellAlphaRange(double mn, double mx);
|
|
virtual void SetCellAlphaRange(double rng[2]);
|
|
virtual double* GetCellAlphaRange();
|
|
virtual void GetCellAlphaRange(double& mn, double& mx);
|
|
virtual void GetCellAlphaRange(double rng[2]);
|
|
|
|
//@{
|
|
/**
|
|
* Set/Get the cell lookup table.
|
|
*/
|
|
vtkGetObjectMacro(CellLookupTable, vtkScalarsToColors);
|
|
virtual void SetCellLookupTable(vtkScalarsToColors* lut);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* Whether to scale the lookup table to fit the range of the data.
|
|
*/
|
|
vtkSetMacro(ScaleCellLookupTable, bool);
|
|
vtkGetMacro(ScaleCellLookupTable, bool);
|
|
vtkBooleanMacro(ScaleCellLookupTable, bool);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The color of any outlines in the view.
|
|
*/
|
|
vtkSetVector3Macro(OutlineColor, double);
|
|
vtkGetVector3Macro(OutlineColor, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The color of selected points or vertices.
|
|
*/
|
|
vtkSetVector3Macro(SelectedPointColor, double);
|
|
vtkGetVector3Macro(SelectedPointColor, double);
|
|
vtkSetMacro(SelectedPointOpacity, double);
|
|
vtkGetMacro(SelectedPointOpacity, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The color of selected cells or edges.
|
|
*/
|
|
vtkSetVector3Macro(SelectedCellColor, double);
|
|
vtkGetVector3Macro(SelectedCellColor, double);
|
|
vtkSetMacro(SelectedCellOpacity, double);
|
|
vtkGetMacro(SelectedCellOpacity, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The view background color.
|
|
*/
|
|
vtkSetVector3Macro(BackgroundColor, double);
|
|
vtkGetVector3Macro(BackgroundColor, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The second background color (for gradients).
|
|
*/
|
|
vtkSetVector3Macro(BackgroundColor2, double);
|
|
vtkGetVector3Macro(BackgroundColor2, double);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The text property to use for labeling points/vertices.
|
|
*/
|
|
virtual void SetPointTextProperty(vtkTextProperty* tprop);
|
|
vtkGetObjectMacro(PointTextProperty, vtkTextProperty);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The text property to use for labeling edges/cells.
|
|
*/
|
|
virtual void SetCellTextProperty(vtkTextProperty* tprop);
|
|
vtkGetObjectMacro(CellTextProperty, vtkTextProperty);
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The color to use for labeling graph vertices.
|
|
* This is deprecated. Use GetPointTextProperty()->SetColor() instead.
|
|
*/
|
|
virtual void SetVertexLabelColor(double r, double g, double b);
|
|
virtual void SetVertexLabelColor(double c[3]) { this->SetVertexLabelColor(c[0], c[1], c[2]); }
|
|
virtual double* GetVertexLabelColor();
|
|
virtual void GetVertexLabelColor(double& r, double& g, double& b)
|
|
{
|
|
double* c = this->GetVertexLabelColor();
|
|
if (c)
|
|
{
|
|
r = c[0];
|
|
g = c[1];
|
|
b = c[2];
|
|
}
|
|
}
|
|
virtual void GetVertexLabelColor(double c[3]) { this->GetVertexLabelColor(c[0], c[1], c[2]); }
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* The color to use for labeling graph edges.
|
|
* This is deprecated. Use GetCellTextProperty()->SetColor() instead.
|
|
*/
|
|
virtual void SetEdgeLabelColor(double r, double g, double b);
|
|
virtual void SetEdgeLabelColor(double c[3]) { this->SetEdgeLabelColor(c[0], c[1], c[2]); }
|
|
virtual double* GetEdgeLabelColor();
|
|
virtual void GetEdgeLabelColor(double& r, double& g, double& b)
|
|
{
|
|
double* c = this->GetEdgeLabelColor();
|
|
if (c)
|
|
{
|
|
r = c[0];
|
|
g = c[1];
|
|
b = c[2];
|
|
}
|
|
}
|
|
virtual void GetEdgeLabelColor(double c[3]) { this->GetEdgeLabelColor(c[0], c[1], c[2]); }
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* Convenience methods for creating some default view themes.
|
|
* The return reference is reference-counted, so you will have to call
|
|
* Delete() on the reference when you are finished with it.
|
|
*/
|
|
static vtkViewTheme* CreateOceanTheme();
|
|
static vtkViewTheme* CreateMellowTheme();
|
|
static vtkViewTheme* CreateNeonTheme();
|
|
//@}
|
|
|
|
//@{
|
|
/**
|
|
* Whether a given lookup table matches the point or cell theme of this
|
|
* theme.
|
|
*/
|
|
bool LookupMatchesPointTheme(vtkScalarsToColors* s2c);
|
|
bool LookupMatchesCellTheme(vtkScalarsToColors* s2c);
|
|
//@}
|
|
|
|
protected:
|
|
vtkViewTheme();
|
|
~vtkViewTheme() override;
|
|
|
|
double PointSize;
|
|
double LineWidth;
|
|
|
|
double PointColor[3];
|
|
double PointOpacity;
|
|
|
|
double CellColor[3];
|
|
double CellOpacity;
|
|
|
|
double OutlineColor[3];
|
|
|
|
double SelectedPointColor[3];
|
|
double SelectedPointOpacity;
|
|
double SelectedCellColor[3];
|
|
double SelectedCellOpacity;
|
|
|
|
double BackgroundColor[3];
|
|
double BackgroundColor2[3];
|
|
|
|
vtkScalarsToColors* PointLookupTable;
|
|
vtkScalarsToColors* CellLookupTable;
|
|
|
|
bool ScalePointLookupTable;
|
|
bool ScaleCellLookupTable;
|
|
|
|
vtkTextProperty* PointTextProperty;
|
|
vtkTextProperty* CellTextProperty;
|
|
|
|
private:
|
|
vtkViewTheme(const vtkViewTheme&) = delete;
|
|
void operator=(const vtkViewTheme&) = delete;
|
|
};
|
|
|
|
#endif
|