File: vtkSMAnimationSceneProxy.h

package info (click to toggle)
paraview 5.4.1%2Bdfsg4-3.1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 218,616 kB
  • sloc: cpp: 2,331,508; ansic: 322,365; python: 111,051; xml: 79,203; tcl: 47,013; yacc: 4,877; java: 4,438; perl: 3,238; sh: 2,920; lex: 1,908; f90: 748; makefile: 273; pascal: 228; objc: 83; fortran: 31
file content (88 lines) | stat: -rw-r--r-- 3,006 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*=========================================================================

  Program:   ParaView
  Module:    $RCSfile$

  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.

=========================================================================*/
/**
 * @class   vtkSMAnimationSceneProxy
 *
 * vtkSMAnimationSceneProxy observe vtkCommand::ModifiedEvent on the
 * client-side VTK-object to call UpdatePropertyInformation() every time that
 * happens.
*/

#ifndef vtkSMAnimationSceneProxy_h
#define vtkSMAnimationSceneProxy_h

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

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

  //@{
  /**
   * Setups the animation scene's playback mode and time-ranges based on the
   * timesteps available on the time-keeper proxy set on the animation scene.
   */
  virtual bool UpdateAnimationUsingDataTimeSteps();
  static bool UpdateAnimationUsingDataTimeSteps(vtkSMProxy* scene)
  {
    vtkSMAnimationSceneProxy* self = vtkSMAnimationSceneProxy::SafeDownCast(scene);
    return self ? self->UpdateAnimationUsingDataTimeSteps() : false;
  }
  //@}

  //@{
  /**
   * Returns the first animation cue (enabled or otherwise) that animates the
   * given property on the proxy. This will return NULL if none such cue exists.
   */
  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) : NULL;
  }
  //@}

protected:
  vtkSMAnimationSceneProxy();
  ~vtkSMAnimationSceneProxy();

  /**
   * Overridden to prune start/end time properties if not applicable to the
   * state being loaded.
   */
  virtual int LoadXMLState(vtkPVXMLElement* element, vtkSMProxyLocator* locator) VTK_OVERRIDE;

  /**
   * Given a class name (by setting VTKClassName) and server ids (by
   * setting ServerIDs), this methods instantiates the objects on the
   * server(s)
   */
  virtual void CreateVTKObjects() VTK_OVERRIDE;

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

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

#endif