vtkCheckerboardRepresentation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCheckerboardRepresentation_h
#define vtkCheckerboardRepresentation_h

#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkImageCheckerboard;
class vtkImageActor;
class vtkSliderRepresentation3D;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkCheckerboardRepresentation
  : public vtkWidgetRepresentation
{
public:
  static vtkCheckerboardRepresentation* New();


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


  void SetCheckerboard(vtkImageCheckerboard* chkrbrd);
  vtkGetObjectMacro(Checkerboard, vtkImageCheckerboard);


  void SetImageActor(vtkImageActor* imageActor);
  vtkGetObjectMacro(ImageActor, vtkImageActor);


  vtkSetClampMacro(CornerOffset, double, 0.0, 0.4);
  vtkGetMacro(CornerOffset, double);

  enum
  {
    TopSlider = 0,
    RightSlider,
    BottomSlider,
    LeftSlider
  };

  void SliderValueChanged(int sliderNum);


  void SetTopRepresentation(vtkSliderRepresentation3D*);
  void SetRightRepresentation(vtkSliderRepresentation3D*);
  void SetBottomRepresentation(vtkSliderRepresentation3D*);
  void SetLeftRepresentation(vtkSliderRepresentation3D*);
  vtkGetObjectMacro(TopRepresentation, vtkSliderRepresentation3D);
  vtkGetObjectMacro(RightRepresentation, vtkSliderRepresentation3D);
  vtkGetObjectMacro(BottomRepresentation, vtkSliderRepresentation3D);
  vtkGetObjectMacro(LeftRepresentation, vtkSliderRepresentation3D);


  void BuildRepresentation() override;
  void GetActors(vtkPropCollection*) override;
  void ReleaseGraphicsResources(vtkWindow* w) override;
  int RenderOverlay(vtkViewport* viewport) override;
  int RenderOpaqueGeometry(vtkViewport* viewport) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport* viewport) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;

protected:
  vtkCheckerboardRepresentation();
  ~vtkCheckerboardRepresentation() override;

  // Instances that this class manipulates
  vtkImageCheckerboard* Checkerboard;
  vtkImageActor* ImageActor;

  // The internal widgets for each side
  vtkSliderRepresentation3D* TopRepresentation;
  vtkSliderRepresentation3D* RightRepresentation;
  vtkSliderRepresentation3D* BottomRepresentation;
  vtkSliderRepresentation3D* LeftRepresentation;

  // The corner offset
  double CornerOffset;

  // Direction index of image actor's plane normal
  int OrthoAxis;

private:
  vtkCheckerboardRepresentation(const vtkCheckerboardRepresentation&) = delete;
  void operator=(const vtkCheckerboardRepresentation&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif