vtkPolyDataMapper.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 vtkPolyDataMapper_h
#define vtkPolyDataMapper_h

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

#include <cstdint> // For uintptr_t
#include <limits>  // For std::numeric_limits<>

VTK_ABI_NAMESPACE_BEGIN
class vtkPolyData;
class vtkRenderer;
class vtkRenderWindow;

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

  virtual void RenderPiece(vtkRenderer*, vtkActor*) {}

  void Render(vtkRenderer* ren, vtkActor* act) override;

  using MapperHashType = std::uintptr_t;
  virtual MapperHashType GenerateHash(vtkPolyData*) { return 0; }

  virtual vtkIdType GetMaximumNumberOfTriangles(vtkRenderer*)
  {
    return std::numeric_limits<vtkIdType>::max();
  }


  void SetInputData(vtkPolyData* in);
  vtkPolyData* GetInput();


  bool Update(int port) override;
  bool Update() override;
  vtkTypeBool Update(int port, vtkInformationVector* requests) override;
  vtkTypeBool Update(vtkInformation* requests) override;


  vtkSetMacro(Piece, int);
  vtkGetMacro(Piece, int);
  vtkSetMacro(NumberOfPieces, int);
  vtkGetMacro(NumberOfPieces, int);
  vtkSetMacro(NumberOfSubPieces, int);
  vtkGetMacro(NumberOfSubPieces, int);


  vtkSetMacro(GhostLevel, int);
  vtkGetMacro(GhostLevel, int);


  vtkSetMacro(SeamlessU, bool);
  vtkGetMacro(SeamlessU, bool);
  vtkBooleanMacro(SeamlessU, bool);
  vtkSetMacro(SeamlessV, bool);
  vtkGetMacro(SeamlessV, bool);
  vtkBooleanMacro(SeamlessV, bool);


  vtkSetStringMacro(PointIdArrayName);
  vtkGetStringMacro(PointIdArrayName);
  vtkSetStringMacro(CellIdArrayName);
  vtkGetStringMacro(CellIdArrayName);


  vtkSetStringMacro(CompositeIdArrayName);
  vtkGetStringMacro(CompositeIdArrayName);


  vtkSetStringMacro(ProcessIdArrayName);
  vtkGetStringMacro(ProcessIdArrayName);

  double* GetBounds() VTK_SIZEHINT(6) override;
  void GetBounds(double bounds[6]) override { this->Superclass::GetBounds(bounds); }

  void ShallowCopy(vtkAbstractMapper* m) override;

  virtual void MapDataArrayToVertexAttribute(const char* vertexAttributeName,
    const char* dataArrayName, int fieldAssociation, int componentno = -1);

  // Specify a data array to use as the texture coordinate
  // for a named texture. See vtkProperty.h for how to
  // name textures.
  virtual void MapDataArrayToMultiTextureAttribute(
    const char* textureName, const char* dataArrayName, int fieldAssociation, int componentno = -1);

  virtual void RemoveVertexAttributeMapping(const char* vertexAttributeName);

  virtual void RemoveAllVertexAttributeMappings();

  vtkTypeBool ProcessRequest(
    vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  enum ShiftScaleMethodType
  {
    DISABLE_SHIFT_SCALE,     
    AUTO_SHIFT_SCALE,        
    ALWAYS_AUTO_SHIFT_SCALE, 
    MANUAL_SHIFT_SCALE,      
    AUTO_SHIFT,              
    NEAR_PLANE_SHIFT_SCALE,  
    FOCAL_POINT_SHIFT_SCALE  
  };

  virtual void SetVBOShiftScaleMethod(int) {}
  virtual int GetVBOShiftScaleMethod() { return this->ShiftScaleMethod; }

  virtual void SetPauseShiftScale(bool pauseShiftScale) { this->PauseShiftScale = pauseShiftScale; }
  vtkGetMacro(PauseShiftScale, bool);
  vtkBooleanMacro(PauseShiftScale, bool);

protected:
  vtkPolyDataMapper();
  ~vtkPolyDataMapper() override;

  virtual void ComputeBounds();

  int Piece;
  int NumberOfPieces;
  int NumberOfSubPieces;
  int GhostLevel;
  bool SeamlessU, SeamlessV;
  int ShiftScaleMethod; // for points
  bool PauseShiftScale;

  // additional picking indirection
  char* PointIdArrayName = nullptr;
  char* CellIdArrayName = nullptr;
  char* CompositeIdArrayName = nullptr;
  char* ProcessIdArrayName = nullptr;

  int FillInputPortInformation(int, vtkInformation*) override;

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

VTK_ABI_NAMESPACE_END
#endif