vtkFrustumCoverageCuller.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 vtkFrustumCoverageCuller_h
#define vtkFrustumCoverageCuller_h

#include "vtkCuller.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

#define VTK_CULLER_SORT_NONE 0
#define VTK_CULLER_SORT_FRONT_TO_BACK 1
#define VTK_CULLER_SORT_BACK_TO_FRONT 2

VTK_ABI_NAMESPACE_BEGIN
class vtkProp;
class vtkRenderer;

class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkFrustumCoverageCuller : public vtkCuller
{
public:
  static vtkFrustumCoverageCuller* New();
  vtkTypeMacro(vtkFrustumCoverageCuller, vtkCuller);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(MinimumCoverage, double);
  vtkGetMacro(MinimumCoverage, double);


  vtkSetMacro(MaximumCoverage, double);
  vtkGetMacro(MaximumCoverage, double);


  vtkSetClampMacro(SortingStyle, int, VTK_CULLER_SORT_NONE, VTK_CULLER_SORT_BACK_TO_FRONT);
  vtkGetMacro(SortingStyle, int);
  void SetSortingStyleToNone() { this->SetSortingStyle(VTK_CULLER_SORT_NONE); }
  void SetSortingStyleToBackToFront() { this->SetSortingStyle(VTK_CULLER_SORT_BACK_TO_FRONT); }
  void SetSortingStyleToFrontToBack() { this->SetSortingStyle(VTK_CULLER_SORT_FRONT_TO_BACK); }
  const char* GetSortingStyleAsString();

  double Cull(vtkRenderer* ren, vtkProp** propList, int& listLength, int& initialized) override;

protected:
  vtkFrustumCoverageCuller();
  ~vtkFrustumCoverageCuller() override = default;

  double MinimumCoverage;
  double MaximumCoverage;
  int SortingStyle;

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

VTK_ABI_NAMESPACE_END
#endif