Servers/ServerManager/vtkSMComparativeVisProxy.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    $RCSfile: vtkSMComparativeVisProxy.h,v $

  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.

=========================================================================*/
#ifndef __vtkSMComparativeVisProxy_h
#define __vtkSMComparativeVisProxy_h

#include "vtkSMProxy.h"

class vtkSMAnimationCueProxy;
class vtkSMPropertyAdaptor;
class vtkSMProxy;
class vtkSMRenderModuleProxy;
//BTX
struct vtkSMComparativeVisProxyInternals;
//ETX

class VTK_EXPORT vtkSMComparativeVisProxy : public vtkSMProxy
{
public:
  static vtkSMComparativeVisProxy* New();
  vtkTypeRevisionMacro(vtkSMComparativeVisProxy, vtkSMProxy);
  void PrintSelf(ostream& os ,vtkIndent indent);

  void Generate();


  vtkGetMacro(IsGenerated, int);

  int Show();

  void Hide();


  void AddCue(vtkSMProxy* cueProxy);
  void SetCue(unsigned int idx, vtkSMProxy* cueProxy);
  void SetNumberOfCues(unsigned int num);
  void SetNumberOfFramesInCue(unsigned int idx, unsigned int numValues);

  void RemoveAllCues();

  void Initialize();

  void RemoveAllCache();

  unsigned int GetNumberOfCues();

  unsigned int GetNumberOfFramesInCue(unsigned int idx);

  vtkSMAnimationCueProxy* GetCue(unsigned int idx);


  vtkGetObjectMacro(MultiActorHelper, vtkSMProxy);


  vtkSetStringMacro(Name);
  vtkGetStringMacro(Name);


  vtkSetMacro(ShouldAbort, int);
  vtkGetMacro(ShouldAbort, int);


  void SetRenderModule(vtkSMRenderModuleProxy* ren);
  vtkGetObjectMacro(RenderModule, vtkSMRenderModuleProxy);


  void SetSourceName(unsigned int idx, const char* sourceName);
  const char* GetSourceName(unsigned int idx);


  void SetSourceTclName(unsigned int idx, const char* sourceName);
  const char* GetSourceTclName(unsigned int idx);


  vtkSetMacro(NumberOfXFrames, unsigned int);
  vtkGetMacro(NumberOfXFrames, unsigned int);


  vtkSetMacro(NumberOfYFrames, unsigned int);
  vtkGetMacro(NumberOfYFrames, unsigned int);

protected:
  vtkSMComparativeVisProxy();
  ~vtkSMComparativeVisProxy();

  // Create all the geometry for a property (and all the properties
  // after it). Call PlayOne(0) to create the geometry for all.
  void PlayOne(unsigned int idx);

  // Create geometry caches and displays for one case (i.e. fixed set 
  // of property values)
  void StoreGeometry();

  // All geometry caches and displays are stored consecutively in a vector.
  // To figure out which property indices an entry in the vector corresponds
  // to, call ComputeIndices(entryIdx). After this call, 
  // Internal->Indices vector will contain the right indices pointing to
  // the properties
  void ComputeIndices(unsigned int gidx);
  void ComputeIndex(unsigned int paramIdx, unsigned int gidx);

  // Used during comparative vis. generation. Called by the animation
  // scene proxy
  void ExecuteEvent(vtkObject* , unsigned long event, unsigned int paramIdx);

  // Gather two bounds (result is stored in the second argument)
  static void AddBounds(double bounds[6], double totalB[6]);

  vtkSMProxy* MultiActorHelper;

  char* Name;

  char* SourceName;

  int InFirstShow;

  int IsGenerated;

  unsigned int NumberOfXFrames;
  unsigned int NumberOfYFrames;

  void UpdateProgress(double progress);

  vtkSMRenderModuleProxy* RenderModule;

//BTX
  friend class vtkCVAnimationSceneObserver;
//ETX

private:
  void ComputeNumberOfFrames();

  unsigned int NumberOfFrames;
  unsigned int CurrentFrame;

  unsigned int  PropertyIndex;

  // Private implementation
  vtkSMComparativeVisProxyInternals* Internal;

  int ShouldAbort;

  static const double BorderWidth;

  vtkSMPropertyAdaptor* Adaptor;

  vtkSMComparativeVisProxy(const vtkSMComparativeVisProxy&); // Not implemented.
  void operator=(const vtkSMComparativeVisProxy&); // Not implemented.
};

#endif

---