vtkSMRepresentationProxy.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMRepresentationProxy_h
#define vtkSMRepresentationProxy_h
 
#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkSMSourceProxy.h"
 
class vtkPVProminentValuesInformation;
namespace vtkPVComparativeViewNS
{
class vtkCloningVectorOfRepresentations;
}
 
class VTKREMOTINGVIEWS_EXPORT vtkSMRepresentationProxy : public vtkSMSourceProxy
{
public:
  static vtkSMRepresentationProxy* New();
  vtkTypeMacro(vtkSMRepresentationProxy, vtkSMSourceProxy);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual vtkPVDataInformation* GetRepresentedDataInformation();
 
  virtual vtkPVProminentValuesInformation* GetProminentValuesInformation(std::string name,
    int fieldAssoc, int numComponents, double uncertaintyAllowed = 1e-6, double fraction = 1e-3,
    bool force = false);
 
  void UpdatePipeline() override;
 
  void UpdatePipeline(double time) override;
 
  void PostUpdateData(bool) override;
 
  virtual void ViewUpdated(vtkSMProxy* view);
 
  vtkTypeUInt32 GetGlobalID() override;
 
 
  virtual bool SetRepresentationType(const char* type);
  static bool SetRepresentationType(vtkSMProxy* repr, const char* type)
  {
    vtkSMRepresentationProxy* self = vtkSMRepresentationProxy::SafeDownCast(repr);
    return self ? self->SetRepresentationType(type) : false;
  }
  const char* GetRepresentationType();
  static const char* GetRepresentationType(vtkSMProxy* repr)
  {
    vtkSMRepresentationProxy* self = vtkSMRepresentationProxy::SafeDownCast(repr);
    return self ? self->GetRepresentationType() : nullptr;
  }
 
 
  static bool IsVolumeRendering(vtkSMProxy* repr)
  {
    vtkSMRepresentationProxy* self = vtkSMRepresentationProxy::SafeDownCast(repr);
    return self ? self->IsVolumeRendering() : false;
  }
  bool IsVolumeRendering();
  static bool GetUsing2DTransferFunction(vtkSMProxy* repr)
  {
    vtkSMRepresentationProxy* self = vtkSMRepresentationProxy::SafeDownCast(repr);
    return self ? self->GetUsing2DTransferFunction() : false;
  }
  bool GetUsing2DTransferFunction();
 
  void MarkDirty(vtkSMProxy* modifiedProxy) override;
 
protected:
  vtkSMRepresentationProxy();
  ~vtkSMRepresentationProxy() override;
 
  void MarkDirtyFromProducer(
    vtkSMProxy* modifiedProxy, vtkSMProxy* producer, vtkSMProperty* property) override;
 
  // Unlike subproxies in regular proxies, subproxies in representations
  // typically represent internal representations e.g. label representation,
  // representation for selection etc. In that case, if the internal
  // representation is modified, we need to ensure that any of our consumers is
  // a consumer of all our subproxies as well.
  void AddConsumer(vtkSMProperty* property, vtkSMProxy* proxy) override;
  void RemoveConsumer(vtkSMProperty* property, vtkSMProxy* proxy) override;
  void RemoveAllConsumers() override;
 
  void CreateVTKObjects() override;
  void OnVTKRepresentationUpdated();
  void OnVTKRepresentationUpdateSkipped();
  void OnVTKRepresentationUpdateTimeChanged();
 
  virtual void UpdatePipelineInternal(double time, bool doTime);
 
  void InvalidateDataInformation() override;
 
  int LoadXMLState(vtkPVXMLElement* element, vtkSMProxyLocator* locator) override;
 
private:
  vtkSMRepresentationProxy(const vtkSMRepresentationProxy&) = delete;
  void operator=(const vtkSMRepresentationProxy&) = delete;
 
  bool RepresentedDataInformationValid;
  vtkPVDataInformation* RepresentedDataInformation;
 
  bool ProminentValuesInformationValid;
  vtkPVProminentValuesInformation* ProminentValuesInformation;
  double ProminentValuesFraction;
  double ProminentValuesUncertainty;
 
  friend class vtkPVComparativeViewNS::vtkCloningVectorOfRepresentations;
  void ClearMarkedModified() { this->MarkedModified = false; }
  bool MarkedModified;
  bool VTKRepresentationUpdated;
  bool VTKRepresentationUpdateSkipped;
  bool VTKRepresentationUpdateTimeChanged;
 
  std::string DebugName;
};
 
#endif