vtkSMAnimationSceneProxy.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
11 #ifndef vtkSMAnimationSceneProxy_h
12 #define vtkSMAnimationSceneProxy_h
13 
14 #include "vtkRemotingAnimationModule.h" //needed for exports
15 #include "vtkSMProxy.h"
16 
18 {
19 public:
20  static vtkSMAnimationSceneProxy* New();
22  void PrintSelf(ostream& os, vtkIndent indent) override;
23 
25 
29  virtual bool UpdateAnimationUsingDataTimeSteps();
31  {
33  return self ? self->UpdateAnimationUsingDataTimeSteps() : false;
34  }
36 
38 
42  virtual vtkSMProxy* FindAnimationCue(vtkSMProxy* animatedProxy, const char* animatedPropertyName);
44  vtkSMProxy* scene, vtkSMProxy* animatedProxy, const char* animatedPropertyName)
45  {
47  return self ? self->FindAnimationCue(animatedProxy, animatedPropertyName) : nullptr;
48  }
50 
51 protected:
53  ~vtkSMAnimationSceneProxy() override;
54 
59  int LoadXMLState(vtkPVXMLElement* element, vtkSMProxyLocator* locator) override;
60 
66  void CreateVTKObjects() override;
67 
68 private:
70  void operator=(const vtkSMAnimationSceneProxy&) = delete;
71 
72  // Called when vtkSMAnimationScene::UpdateStartEndTimesEvent is fired.
73  void OnUpdateStartEndTimesEvent(vtkObject*, unsigned long, void*);
74 };
75 
76 #endif
void PrintSelf(ostream &os, vtkIndent indent) override
static vtkSMAnimationSceneProxy * SafeDownCast(vtkObject *o)
vtkSMAnimationSceneProxy observe vtkCommand::ModifiedEvent on the client-side VTK-object to call Upda...
static vtkSMProxy * FindAnimationCue(vtkSMProxy *scene, vtkSMProxy *animatedProxy, const char *animatedPropertyName)
Returns the first animation cue (enabled or otherwise) that animates the given property on the proxy...
static vtkSMProxy * New()
virtual void CreateVTKObjects()
Given a class name (by setting VTKClassName) and server ids (by setting ServerIDs), this methods instantiates the objects on the server(s)
virtual int LoadXMLState(vtkPVXMLElement *element, vtkSMProxyLocator *locator)
Loads the proxy state from the XML element.
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:140
is used to locate proxies referred to in state xmls while loading state files.
#define VTKREMOTINGANIMATION_EXPORT
void operator=(const vtkSMProxy &)=delete
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
static bool UpdateAnimationUsingDataTimeSteps(vtkSMProxy *scene)
Setups the animation scene's playback mode and time-ranges based on the timesteps available on the ti...