vtkPVComparativeAnimationCue.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVComparativeAnimationCue_h
#define vtkPVComparativeAnimationCue_h

#include "vtkObject.h"
#include "vtkRemotingViewsModule.h" //needed for exports

class vtkSMDomain;
class vtkSMProperty;
class vtkSMProxy;
class vtkPVXMLElement;

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


  void SetAnimatedProxy(vtkSMProxy*);
  vtkGetObjectMacro(AnimatedProxy, vtkSMProxy);
  void RemoveAnimatedProxy();


  vtkSetStringMacro(AnimatedPropertyName);
  vtkGetStringMacro(AnimatedPropertyName);


  vtkSetStringMacro(AnimatedDomainName);
  vtkGetStringMacro(AnimatedDomainName);


  vtkSetMacro(AnimatedElement, int);
  vtkGetMacro(AnimatedElement, int);


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

  void UpdateXRange(int y, double minx, double maxx) { this->UpdateXRange(y, &minx, &maxx, 1); }
  void UpdateYRange(int x, double miny, double maxy) { this->UpdateYRange(x, &miny, &maxy, 1); }
  void UpdateWholeRange(double mint, double maxt) { this->UpdateWholeRange(&mint, &maxt, 1); }
  void UpdateValue(int x, int y, double value) { this->UpdateValue(x, y, &value, 1); }


  void UpdateXRange(int y, double* minx, double* maxx, unsigned int numvalues);
  void UpdateYRange(int x, double* minx, double* maxx, unsigned int numvalues);
  void UpdateWholeRange(double* mint, double* maxt, unsigned int numValues)
  {
    this->UpdateWholeRange(mint, maxt, numValues, false);
  }
  void UpdateWholeRange(double* mint, double* maxt, unsigned int numValues, bool vertical_first);
  void UpdateValue(int x, int y, double* value, unsigned int numValues);

  void UpdateAnimatedValue(int x, int y, int dx, int dy);


  double GetValue(int x, int y, int dx, int dy)
  {
    unsigned int numValues = 0;
    double* vals = this->GetValues(x, y, dx, dy, numValues);
    if (numValues > 0)
    {
      return vals[0];
    }
    return -1.0;
  }

  double* GetValues(int x, int y, int dx, int dy, unsigned int& numValues);

  vtkPVXMLElement* AppendCommandInfo(vtkPVXMLElement* proxyElem);
  int LoadCommandInfo(vtkPVXMLElement* proxyElement);

protected:
  vtkPVComparativeAnimationCue();
  ~vtkPVComparativeAnimationCue() override;

  vtkSMProperty* GetAnimatedProperty();

  vtkSMDomain* GetAnimatedDomain();

  vtkSMProxy* AnimatedProxy;
  int AnimatedElement;
  char* AnimatedPropertyName;
  char* AnimatedDomainName;
  double* Values;
  bool Enabled;

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif