vtkSMAnimationSceneProxy.h

Go to the documentation of this file.

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

#include "vtkRemotingAnimationModule.h" //needed for exports
#include "vtkSMProxy.h"

class VTKREMOTINGANIMATION_EXPORT vtkSMAnimationSceneProxy : public vtkSMProxy
{
public:
  static vtkSMAnimationSceneProxy* New();
  vtkTypeMacro(vtkSMAnimationSceneProxy, vtkSMProxy);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual bool UpdateAnimationUsingDataTimeSteps();
  static bool UpdateAnimationUsingDataTimeSteps(vtkSMProxy* scene)
  {
    vtkSMAnimationSceneProxy* self = vtkSMAnimationSceneProxy::SafeDownCast(scene);
    return self ? self->UpdateAnimationUsingDataTimeSteps() : false;
  }


  virtual vtkSMProxy* FindAnimationCue(vtkSMProxy* animatedProxy, const char* animatedPropertyName);
  static vtkSMProxy* FindAnimationCue(
    vtkSMProxy* scene, vtkSMProxy* animatedProxy, const char* animatedPropertyName)
  {
    vtkSMAnimationSceneProxy* self = vtkSMAnimationSceneProxy::SafeDownCast(scene);
    return self ? self->FindAnimationCue(animatedProxy, animatedPropertyName) : nullptr;
  }

protected:
  vtkSMAnimationSceneProxy();
  ~vtkSMAnimationSceneProxy() override;

  int LoadXMLState(vtkPVXMLElement* element, vtkSMProxyLocator* locator) override;

  void CreateVTKObjects() override;

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

  // Called when vtkSMAnimationScene::UpdateStartEndTimesEvent is fired.
  void OnUpdateStartEndTimesEvent(vtkObject*, unsigned long, void*);
};

#endif