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 
17 class VTKREMOTINGANIMATION_EXPORT vtkSMAnimationSceneProxy : public vtkSMProxy
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
vtkSMProxy::New
static vtkSMProxy * New()
vtkSMProxy::LoadXMLState
virtual int LoadXMLState(vtkPVXMLElement *element, vtkSMProxyLocator *locator)
Loads the proxy state from the XML element.
vtkSMProxy::CreateVTKObjects
virtual void CreateVTKObjects()
Given a class name (by setting VTKClassName) and server ids (by setting ServerIDs),...
vtkObject
vtkSMProxy
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:140
vtkSMAnimationSceneProxy
Definition: vtkSMAnimationSceneProxy.h:17
vtkSMProxy::operator=
void operator=(const vtkSMProxy &)=delete
vtkIndent
vtkSMAnimationSceneProxy::SafeDownCast
static vtkSMAnimationSceneProxy * SafeDownCast(vtkObject *o)
vtkPVXMLElement
Definition: vtkPVXMLElement.h:23
vtkSMProxy.h
vtkSMProxy::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
vtkSMProxyLocator
is used to locate proxies referred to in state xmls while loading state files.
Definition: vtkSMProxyLocator.h:24
vtkSMAnimationSceneProxy::UpdateAnimationUsingDataTimeSteps
static bool UpdateAnimationUsingDataTimeSteps(vtkSMProxy *scene)
Setups the animation scene's playback mode and time-ranges based on the timesteps available on the ti...
Definition: vtkSMAnimationSceneProxy.h:30
vtkSMAnimationSceneProxy::FindAnimationCue
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.
Definition: vtkSMAnimationSceneProxy.h:43