vtkSMAnimationSceneProxy.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: $RCSfile$
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
23 #ifndef vtkSMAnimationSceneProxy_h
24 #define vtkSMAnimationSceneProxy_h
25 
26 #include "vtkRemotingAnimationModule.h" //needed for exports
27 #include "vtkSMProxy.h"
28 
30 {
31 public:
32  static vtkSMAnimationSceneProxy* New();
34  void PrintSelf(ostream& os, vtkIndent indent) override;
35 
37 
41  virtual bool UpdateAnimationUsingDataTimeSteps();
43  {
45  return self ? self->UpdateAnimationUsingDataTimeSteps() : false;
46  }
48 
50 
54  virtual vtkSMProxy* FindAnimationCue(vtkSMProxy* animatedProxy, const char* animatedPropertyName);
56  vtkSMProxy* scene, vtkSMProxy* animatedProxy, const char* animatedPropertyName)
57  {
59  return self ? self->FindAnimationCue(animatedProxy, animatedPropertyName) : NULL;
60  }
62 
63 protected:
65  ~vtkSMAnimationSceneProxy() override;
66 
71  int LoadXMLState(vtkPVXMLElement* element, vtkSMProxyLocator* locator) override;
72 
78  void CreateVTKObjects() override;
79 
80 private:
82  void operator=(const vtkSMAnimationSceneProxy&) = delete;
83 
84  // Called when vtkSMAnimationScene::UpdateStartEndTimesEvent is fired.
85  void OnUpdateStartEndTimesEvent(vtkObject*, unsigned long, void*);
86 };
87 
88 #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:152
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...