vtkView.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkView_h
#define vtkView_h

#include "vtkObject.h"
#include "vtkViewsCoreModule.h" // For export macro
#include "vtkWrappingHints.h"   // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkAlgorithmOutput;
class vtkCommand;
class vtkDataObject;
class vtkDataRepresentation;
class vtkSelection;
class vtkViewTheme;

class VTKVIEWSCORE_EXPORT VTK_MARSHALAUTO vtkView : public vtkObject
{
public:
  static vtkView* New();
  vtkTypeMacro(vtkView, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void AddRepresentation(vtkDataRepresentation* rep);

  void SetRepresentation(vtkDataRepresentation* rep);

  vtkDataRepresentation* AddRepresentationFromInputConnection(vtkAlgorithmOutput* conn);

  vtkDataRepresentation* SetRepresentationFromInputConnection(vtkAlgorithmOutput* conn);

  vtkDataRepresentation* AddRepresentationFromInput(vtkDataObject* input);

  vtkDataRepresentation* SetRepresentationFromInput(vtkDataObject* input);

  void RemoveRepresentation(vtkDataRepresentation* rep);

  void RemoveRepresentation(vtkAlgorithmOutput* rep);

  void RemoveAllRepresentations();

  int GetNumberOfRepresentations();

  vtkDataRepresentation* GetRepresentation(int index = 0);

  bool IsRepresentationPresent(vtkDataRepresentation* rep);

  virtual void Update();

  virtual void ApplyViewTheme(vtkViewTheme* vtkNotUsed(theme)) {}

  vtkCommand* GetObserver();


  class ViewProgressEventCallData
  {
    const char* Message;
    double Progress;

  public:
    ViewProgressEventCallData(const char* msg, double progress)
    {
      this->Message = msg;
      this->Progress = progress;
    }
    ~ViewProgressEventCallData() { this->Message = nullptr; }

    const char* GetProgressMessage() const { return this->Message; }

    double GetProgress() const { return this->Progress; }
  };

  void RegisterProgress(vtkObject* algorithm, const char* message = nullptr);

  void UnRegisterProgress(vtkObject* algorithm);

protected:
  vtkView();
  ~vtkView() override;

  virtual void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData);

  virtual vtkDataRepresentation* CreateDefaultRepresentation(vtkAlgorithmOutput* conn);

  virtual void AddRepresentationInternal(vtkDataRepresentation* vtkNotUsed(rep)) {}
  virtual void RemoveRepresentationInternal(vtkDataRepresentation* vtkNotUsed(rep)) {}


  vtkSetMacro(ReuseSingleRepresentation, bool);
  vtkGetMacro(ReuseSingleRepresentation, bool);
  vtkBooleanMacro(ReuseSingleRepresentation, bool);
  bool ReuseSingleRepresentation;

private:
  vtkView(const vtkView&) = delete;
  void operator=(const vtkView&) = delete;

  class vtkImplementation;
  vtkImplementation* Implementation;

  class Command;
  friend class Command;
  Command* Observer;

  class vtkInternal;
  vtkInternal* Internal;
};

VTK_ABI_NAMESPACE_END
#endif