GUI/Client/vtkPVLookmark.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    $RCSfile: vtkPVLookmark.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.

=========================================================================*/
/*----------------------------------------------------------------------------
 Copyright (c) Sandia Corporation
 See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
----------------------------------------------------------------------------*/

#ifndef __vtkPVLookmark_h
#define __vtkPVLookmark_h

#include "vtkKWLookmark.h"

class vtkPVSource;
class vtkPVSourceCollection;
class vtkRenderWindow;
class vtkPVApplication;
class vtkPVRenderView;
class vtkPVLookmarkManager;
class vtkPVTraceHelper;
class vtkKWPushButton;
class vtkPVLookmarkObserver;
class vtkKWIcon;
class vtkPVWindow;

class VTK_EXPORT vtkPVLookmark : public vtkKWLookmark
{
public:

  static vtkPVLookmark* New();
  vtkTypeRevisionMacro(vtkPVLookmark,vtkKWLookmark);
  void PrintSelf(ostream& os, vtkIndent indent);


  vtkGetObjectMacro(TraceHelper, vtkPVTraceHelper);


  void PreView();
  void ViewCallback();
  void View();


  void PreViewMacro();
  void ViewMacroCallback();
  void ViewMacro();

  void ReleaseEvent();

  void Clone(vtkPVLookmark*& lmk);

  void Update();

  void CreateIconFromMainView();

  void UpdateWidgetValues();

  void StoreStateScript();


  vtkGetStringMacro(StateScript);
  vtkSetStringMacro(StateScript);


  vtkGetStringMacro(Version);
  vtkSetStringMacro(Version);
 

  vtkGetStringMacro(ImageData);
  vtkSetStringMacro(ImageData);


  vtkGetVector3Macro(CenterOfRotation,float); 
  vtkSetVector3Macro(CenterOfRotation,float); 


  vtkGetMacro(Location,int);
  vtkSetMacro(Location,int);

  void EnableScrollBar();

  void RemovePVSource(vtkPVSource *src);


  vtkGetObjectMacro(ToolbarButton,vtkKWPushButton);
  void AddLookmarkToolbarButton(vtkKWIcon *icon);

  void InitializeDataset();

protected:

  vtkPVLookmark();
  ~vtkPVLookmark();
  
  int IsSourceOrOutputsVisible(vtkPVSource *src,int visibilityFlag);

  // convenience methods
  vtkPVApplication *GetPVApplication();
  vtkPVRenderView* GetPVRenderView(); 
  vtkPVWindow* GetPVWindow(); 
  vtkPVLookmarkManager* GetPVLookmarkManager(); 

  virtual void ExecuteEvent(vtkObject* , unsigned long event, void* calldata);
//BTX
  vtkPVLookmarkObserver* Observer;
  friend class vtkPVLookmarkObserver;
//ETX

  void AddPVSource(vtkPVSource *src);

  int DeletePVSources();

  vtkKWIcon *GetIconOfRenderWindow(vtkRenderWindow *window);

  char *GetEncodedImageData(vtkKWIcon *lmkIcon);


  void SetLookmarkIconCommand();
  void UnsetLookmarkIconCommand();


  void TurnFiltersOff();
  void TurnScalarBarsOff();


  void ParseAndExecuteStateScript(char *state, int macroFlag);
  vtkPVSource *GetReaderForLookmark(vtkPVSourceCollection *col,char *module, char *pathname, int &newDatasetFlag, int &updateLookmarkFlag);
  vtkPVSource *GetReaderForMacro(vtkPVSourceCollection *col, char *pathname);
  vtkPVSource *GetSourceForLookmark(vtkPVSourceCollection *col,char *sourcename);
  vtkPVSource *GetSourceForMacro(vtkPVSourceCollection *col,char *sourcename);

  char *Version;
  char* StateScript;
  char* ImageData;
  float* CenterOfRotation;
  vtkPVSourceCollection* Sources;
  int Location;
  unsigned long ErrorEventTag;
  int ReleaseEventFlag;

  vtkPVTraceHelper* TraceHelper;

  vtkKWPushButton *ToolbarButton;

private:
  vtkPVLookmark(const vtkPVLookmark&); // Not implemented
  void operator=(const vtkPVLookmark&); // Not implemented
};

#endif

---