vtkIconGlyphFilter.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkIconGlyphFilter.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.
 
=========================================================================*/
#ifndef vtkIconGlyphFilter_h
#define vtkIconGlyphFilter_h
 
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
 
#define VTK_ICON_GRAVITY_TOP_RIGHT 1
#define VTK_ICON_GRAVITY_TOP_CENTER 2
#define VTK_ICON_GRAVITY_TOP_LEFT 3
#define VTK_ICON_GRAVITY_CENTER_RIGHT 4
#define VTK_ICON_GRAVITY_CENTER_CENTER 5
#define VTK_ICON_GRAVITY_CENTER_LEFT 6
#define VTK_ICON_GRAVITY_BOTTOM_RIGHT 7
#define VTK_ICON_GRAVITY_BOTTOM_CENTER 8
#define VTK_ICON_GRAVITY_BOTTOM_LEFT 9
 
#define VTK_ICON_SCALING_OFF 0
#define VTK_ICON_SCALING_USE_SCALING_ARRAY 1
 
class VTKFILTERSGENERAL_EXPORT vtkIconGlyphFilter : public vtkPolyDataAlgorithm
{
public:
 
  static vtkIconGlyphFilter* New();
  vtkTypeMacro(vtkIconGlyphFilter, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetVector2Macro(IconSize, int);
  vtkGetVectorMacro(IconSize, int, 2);
 
 
  vtkSetVector2Macro(IconSheetSize, int);
  vtkGetVectorMacro(IconSheetSize, int, 2);
 
 
  vtkSetVector2Macro(DisplaySize, int);
  vtkGetVectorMacro(DisplaySize, int, 2);
 
 
  vtkSetMacro(UseIconSize, bool);
  vtkGetMacro(UseIconSize, bool);
  vtkBooleanMacro(UseIconSize, bool);
 
 
  vtkSetMacro(IconScaling, int);
  vtkGetMacro(IconScaling, int);
  void SetIconScalingToScalingOff() { this->SetIconScaling(VTK_ICON_SCALING_OFF); }
  void SetIconScalingToScalingArray() { this->SetIconScaling(VTK_ICON_SCALING_USE_SCALING_ARRAY); }
 
 
  vtkSetMacro(PassScalars, bool);
  vtkGetMacro(PassScalars, bool);
  vtkBooleanMacro(PassScalars, bool);
 
 
  vtkSetMacro(Gravity, int);
  vtkGetMacro(Gravity, int);
  void SetGravityToTopRight() { this->SetGravity(VTK_ICON_GRAVITY_TOP_RIGHT); }
  void SetGravityToTopCenter() { this->SetGravity(VTK_ICON_GRAVITY_TOP_CENTER); }
  void SetGravityToTopLeft() { this->SetGravity(VTK_ICON_GRAVITY_TOP_LEFT); }
  void SetGravityToCenterRight() { this->SetGravity(VTK_ICON_GRAVITY_CENTER_RIGHT); }
  void SetGravityToCenterCenter() { this->SetGravity(VTK_ICON_GRAVITY_CENTER_CENTER); }
  void SetGravityToCenterLeft() { this->SetGravity(VTK_ICON_GRAVITY_CENTER_LEFT); }
  void SetGravityToBottomRight() { this->SetGravity(VTK_ICON_GRAVITY_BOTTOM_RIGHT); }
  void SetGravityToBottomCenter() { this->SetGravity(VTK_ICON_GRAVITY_BOTTOM_CENTER); }
  void SetGravityToBottomLeft() { this->SetGravity(VTK_ICON_GRAVITY_BOTTOM_LEFT); }
 
 
  vtkSetVector2Macro(Offset, int);
  vtkGetVectorMacro(Offset, int, 2);
 
protected:
  vtkIconGlyphFilter();
  ~vtkIconGlyphFilter() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  int IconSize[2];      // Size in pixels of an icon in an icon sheet
  int IconSheetSize[2]; // Size in pixels of the icon sheet
  int DisplaySize[2];   // Size in pixels of the icon when displayed
 
  int Gravity;
  bool UseIconSize;
  int IconScaling;
  bool PassScalars;
  int Offset[2];
 
private:
  vtkIconGlyphFilter(const vtkIconGlyphFilter&) = delete;
  void operator=(const vtkIconGlyphFilter&) = delete;
 
  void IconConvertIndex(int id, int& j, int& k);
};
 
inline void vtkIconGlyphFilter::IconConvertIndex(int id, int& j, int& k)
{
  int dimX = this->IconSheetSize[0] / this->IconSize[0];
  int dimY = this->IconSheetSize[1] / this->IconSize[1];
 
  j = id - dimX * static_cast<int>(id / dimX);
  k = dimY - static_cast<int>(id / dimX) - 1;
}
 
#endif