vtkPVAnimationCue.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkPVAnimationCue.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkPVAnimationCue_h
#define vtkPVAnimationCue_h

#include "vtkAnimationCue.h"
#include "vtkRemotingAnimationModule.h" // needed for export macro

class vtkAnimationCue;
class vtkCommand;
class vtkPVCueManipulator;

class VTKREMOTINGANIMATION_EXPORT vtkPVAnimationCue : public vtkAnimationCue
{
public:
  vtkTypeMacro(vtkPVAnimationCue, vtkAnimationCue);
  void PrintSelf(ostream& os, vtkIndent indent) override;


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


  void SetManipulator(vtkPVCueManipulator*);
  vtkGetObjectMacro(Manipulator, vtkPVCueManipulator);


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


  virtual void BeginUpdateAnimationValues() = 0;
  virtual void SetAnimationValue(int index, double value) = 0;
  virtual void EndUpdateAnimationValues() = 0;


  vtkSetMacro(UseAnimationTime, bool);
  vtkGetMacro(UseAnimationTime, bool);


  void Initialize() override;
  void Tick(double currenttime, double deltatime, double clocktime) override;
  void Finalize() override;

protected:
  vtkPVAnimationCue();
  ~vtkPVAnimationCue() override;

  void StartCueInternal() override;
  void TickInternal(double currenttime, double deltatime, double clocktime) override;
  void EndCueInternal() override;

  friend class vtkSMAnimationSceneProxy;

  unsigned long ObserverID;
  bool UseAnimationTime;
  int AnimatedElement;
  int Enabled;

  vtkAnimationCue* AnimationCue;
  vtkPVCueManipulator* Manipulator;

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

#endif