vtkPVLookmark Class Reference

An interface widget for a container of lookmarks in the Lookmark Manager. More...

#include <vtkPVLookmark.h>

Inheritance diagram for vtkPVLookmark:

[legend]Collaboration diagram for vtkPVLookmark:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVLookmark, vtkKWLookmark)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ReleaseEvent ()
void	Clone (vtkPVLookmark *&lmk)
void	Update ()
void	CreateIconFromMainView ()
void	UpdateWidgetValues ()
void	StoreStateScript ()
void	EnableScrollBar ()
void	RemovePVSource (vtkPVSource *src)
void	InitializeDataset ()
virtual vtkPVTraceHelper *	GetTraceHelper ()
void	PreView ()
void	ViewCallback ()
void	View ()
void	PreViewMacro ()
void	ViewMacroCallback ()
void	ViewMacro ()
virtual char *	GetStateScript ()
virtual void	SetStateScript (const char *)
virtual char *	GetVersion ()
virtual void	SetVersion (const char *)
virtual char *	GetImageData ()
virtual void	SetImageData (const char *)
virtual float *	GetCenterOfRotation ()
virtual void	GetCenterOfRotation (float &, float &, float &)
virtual void	GetCenterOfRotation (float[3])
virtual void	SetCenterOfRotation (float, float, float)
virtual void	SetCenterOfRotation (float[3])
virtual int	GetLocation ()
virtual void	SetLocation (int)
virtual vtkKWPushButton *	GetToolbarButton ()
void	AddLookmarkToolbarButton (vtkKWIcon *icon)
Static Public Member Functions
vtkPVLookmark *	New ()
Protected Member Functions
	vtkPVLookmark ()
	~vtkPVLookmark ()
int	IsSourceOrOutputsVisible (vtkPVSource *src, int visibilityFlag)
vtkPVApplication *	GetPVApplication ()
vtkPVRenderView *	GetPVRenderView ()
vtkPVWindow *	GetPVWindow ()
vtkPVLookmarkManager *	GetPVLookmarkManager ()
virtual void	ExecuteEvent (vtkObject *, unsigned long event, void *calldata)
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)
Protected Attributes
vtkPVLookmarkObserver *	Observer
char *	Version
char *	StateScript
char *	ImageData
float *	CenterOfRotation
vtkPVSourceCollection *	Sources
int	Location
unsigned long	ErrorEventTag
int	ReleaseEventFlag
vtkPVTraceHelper *	TraceHelper
vtkKWPushButton *	ToolbarButton
Friends
class	vtkPVLookmarkObserver

---

Detailed Description

An interface widget for a container of lookmarks in the Lookmark Manager.

This class represents a lookmark object and stores several attributes such as name, default dataset, comments, state script, and image data. I separated it from the interface (vtkKWLookmark). Encapsulating loookmark data in one class such as this also helps when writing to the xml lookmark file since we can make use of the vtkXMLLookmarkWriter->SetObject() method.

See also:

vtkObject vtkPVLookmarkManager, vtkKWLookmark

Definition at line 49 of file vtkPVLookmark.h.

---

Constructor & Destructor Documentation

vtkPVLookmark::vtkPVLookmark (   )  [protected]

vtkPVLookmark::~vtkPVLookmark (   )  [protected]

---

Member Function Documentation

vtkPVLookmark* vtkPVLookmark::New (   )  [static]

Reimplemented from vtkKWLookmark.

vtkPVLookmark::vtkTypeRevisionMacro (  vtkPVLookmark  , vtkKWLookmark  )

void vtkPVLookmark::PrintSelf (  ostream &  os, vtkIndent  indent )

Reimplemented from vtkKWLookmark.

virtual vtkPVTraceHelper* vtkPVLookmark::GetTraceHelper (   )  [virtual]

Get the trace helper framework.

void vtkPVLookmark::PreView (   )

This will execute the lookmark. It is called when the user clicks on a lookmark's thumbnail. It tries to find/open the lookmark's dataset(s) and/or source(s) and apply the pipeline to them. The reader is initialized using the attributes in the lookmark's state script. The rest of the script is then executed.

void vtkPVLookmark::ViewCallback (   )

This will execute the lookmark. It is called when the user clicks on a lookmark's thumbnail. It tries to find/open the lookmark's dataset(s) and/or source(s) and apply the pipeline to them. The reader is initialized using the attributes in the lookmark's state script. The rest of the script is then executed.

void vtkPVLookmark::View (   )

This will execute the lookmark. It is called when the user clicks on a lookmark's thumbnail. It tries to find/open the lookmark's dataset(s) and/or source(s) and apply the pipeline to them. The reader is initialized using the attributes in the lookmark's state script. The rest of the script is then executed.

void vtkPVLookmark::PreViewMacro (   )

This is called when the user clicks on a macro's thumbnail. It uses the stored script to initialize the currently selected dataset, maintaining the current camera view and timestep.

void vtkPVLookmark::ViewMacroCallback (   )

This is called when the user clicks on a macro's thumbnail. It uses the stored script to initialize the currently selected dataset, maintaining the current camera view and timestep.

void vtkPVLookmark::ViewMacro (   )

This is called when the user clicks on a macro's thumbnail. It uses the stored script to initialize the currently selected dataset, maintaining the current camera view and timestep.

void vtkPVLookmark::ReleaseEvent (   )

void vtkPVLookmark::Clone (  vtkPVLookmark *&  lmk  )

Initialize this pvlookmark using the ivars of the the one being passed

void vtkPVLookmark::Update (   )

Updates the lookmark's icon and state while maintaining any existing name, comments, etc.

void vtkPVLookmark::CreateIconFromMainView (   )

Converts the image in the render window to a vtkKWIcon stored with the lookmark - called when lookmark is first being created or updated

void vtkPVLookmark::UpdateWidgetValues (   )

Use ivars to update widgets

void vtkPVLookmark::StoreStateScript (   )

Called when lookmark is being created or updated. Turns vtkPVWindow->SaveVisibleSourcesOnlyFlag ON before the call to SaveState and OFF afterwards. This ensures that only those sources that are visible, and all of their inputs leading up to the reader, are saved. Writes out the current session state and stores in lmk. Also initializes the comments field with filter names if first being created

virtual char* vtkPVLookmark::GetStateScript (   )  [virtual]

This is simply a 'dump' of the current session state script at the time the lookmark is created. However, it should only contain the state information for the vtkPVSources that 'contribute' to the view, meaning visible 'leaf' node filters and any visible or nonvisible sources between it and the reader.

virtual void vtkPVLookmark::SetStateScript (  const char *   )  [virtual]

This is simply a 'dump' of the current session state script at the time the lookmark is created. However, it should only contain the state information for the vtkPVSources that 'contribute' to the view, meaning visible 'leaf' node filters and any visible or nonvisible sources between it and the reader.

virtual char* vtkPVLookmark::GetVersion (   )  [virtual]

Store the paraview application version with lookmark to support backwards compatability in the future

virtual void vtkPVLookmark::SetVersion (  const char *   )  [virtual]

Store the paraview application version with lookmark to support backwards compatability in the future

virtual char* vtkPVLookmark::GetImageData (   )  [virtual]

This is the raw base64 encoded image data that makes up the thumbnail

virtual void vtkPVLookmark::SetImageData (  const char *   )  [virtual]

This is the raw base64 encoded image data that makes up the thumbnail

virtual float* vtkPVLookmark::GetCenterOfRotation (   )  [virtual]

This is the focal point of the lookmark's view at creation time

virtual void vtkPVLookmark::GetCenterOfRotation (  float &  , float &  , float &  )  [virtual]

This is the focal point of the lookmark's view at creation time

virtual void vtkPVLookmark::GetCenterOfRotation (  float  [3]  )  [virtual]

This is the focal point of the lookmark's view at creation time

virtual void vtkPVLookmark::SetCenterOfRotation (  float  , float  , float  )  [virtual]

This is the focal point of the lookmark's view at creation time

virtual void vtkPVLookmark::SetCenterOfRotation (  float  [3]  )  [virtual]

This is the focal point of the lookmark's view at creation time

virtual int vtkPVLookmark::GetLocation (   )  [virtual]

The value represents this lookmark widget's packed location among sibling lmk widgets and lmk folder. Used for moving widget.

virtual void vtkPVLookmark::SetLocation (  int   )  [virtual]

The value represents this lookmark widget's packed location among sibling lmk widgets and lmk folder. Used for moving widget.

void vtkPVLookmark::EnableScrollBar (   )

A hack to make sure the scrollbar in the lookmark manager is enabled after import operations need to find a better way.

void vtkPVLookmark::RemovePVSource (  vtkPVSource *  src  )

Called from vtkPVSource when being deleted to remove itself from this lookmark's collection of pvsources

virtual vtkKWPushButton* vtkPVLookmark::GetToolbarButton (   )  [virtual]

Adding a copy of this lookmark's thumbnail to the window's Lookmark Toolbar if this is a macro

void vtkPVLookmark::AddLookmarkToolbarButton (  vtkKWIcon *  icon  )

Adding a copy of this lookmark's thumbnail to the window's Lookmark Toolbar if this is a macro

void vtkPVLookmark::InitializeDataset (   )

Finds which readers or sources should be stored with this lookmark when created and initializes the dataset ivar

int vtkPVLookmark::IsSourceOrOutputsVisible (  vtkPVSource *  src, int  visibilityFlag )  [protected]

Since there could be entire pipelines in the selection window that are invisible and thus be ignored when creating this lookmark this is a check to see if atleast one of a reader's or source's filters are visible and thus contribute to the lookmark view

vtkPVApplication* vtkPVLookmark::GetPVApplication (   )  [protected]

vtkPVRenderView* vtkPVLookmark::GetPVRenderView (   )  [protected]

vtkPVWindow* vtkPVLookmark::GetPVWindow (   )  [protected]

vtkPVLookmarkManager* vtkPVLookmark::GetPVLookmarkManager (   )  [protected]

virtual void vtkPVLookmark::ExecuteEvent (  vtkObject *  , unsigned long  event, void *  calldata )  [protected, virtual]

void vtkPVLookmark::AddPVSource (  vtkPVSource *  src  )  [protected]

When a lookmark is recreated/viewed and the stored state script is parsed, each filter that is created gets stored in this object's vtkPVSourceCOllection

int vtkPVLookmark::DeletePVSources (   )  [protected]

Each time before a lookmark is recreated this method is called which attempts* to delete the vtkPVSources stored in this lookmakr's collection. Of course if one of these filters have been set as input to another one it cannot and will not be deleted. This helps in cleaning up the Source window.

vtkKWIcon* vtkPVLookmark::GetIconOfRenderWindow (  vtkRenderWindow *  window  )  [protected]

An added or updated lookmark widget uses the return value of this to setup its thumbnail

char* vtkPVLookmark::GetEncodedImageData (  vtkKWIcon *  lmkIcon  )  [protected]

performs a base64 encoding on the raw image data of the kwicon

void vtkPVLookmark::SetLookmarkIconCommand (   )  [protected]

This is used to make sure the user cannot click on a lookmark at certain times

void vtkPVLookmark::UnsetLookmarkIconCommand (   )  [protected]

This is used to make sure the user cannot click on a lookmark at certain times

void vtkPVLookmark::TurnFiltersOff (   )  [protected]

helper functions when viewing this lookmark

void vtkPVLookmark::TurnScalarBarsOff (   )  [protected]

helper functions when viewing this lookmark

void vtkPVLookmark::ParseAndExecuteStateScript (  char *  state, int  macroFlag )  [protected]

This is a big function because I'm triying to do it all in one pass parses the reader portion of the state file and uses it to initialize the reader module (both parameter and display settings) the rest of the script is then executed, adding created filters to the lmk's collection as we go, and saving the visibility of the filters so that we can go back and set reset them at the end

vtkPVSource* vtkPVLookmark::GetReaderForLookmark (  vtkPVSourceCollection *  col, char *  module, char *  pathname, int &  newDatasetFlag, int &  updateLookmarkFlag )  [protected]

This is a big function because I'm triying to do it all in one pass parses the reader portion of the state file and uses it to initialize the reader module (both parameter and display settings) the rest of the script is then executed, adding created filters to the lmk's collection as we go, and saving the visibility of the filters so that we can go back and set reset them at the end

vtkPVSource* vtkPVLookmark::GetReaderForMacro (  vtkPVSourceCollection *  col, char *  pathname )  [protected]

This is a big function because I'm triying to do it all in one pass parses the reader portion of the state file and uses it to initialize the reader module (both parameter and display settings) the rest of the script is then executed, adding created filters to the lmk's collection as we go, and saving the visibility of the filters so that we can go back and set reset them at the end

vtkPVSource* vtkPVLookmark::GetSourceForLookmark (  vtkPVSourceCollection *  col, char *  sourcename )  [protected]

This is a big function because I'm triying to do it all in one pass parses the reader portion of the state file and uses it to initialize the reader module (both parameter and display settings) the rest of the script is then executed, adding created filters to the lmk's collection as we go, and saving the visibility of the filters so that we can go back and set reset them at the end

vtkPVSource* vtkPVLookmark::GetSourceForMacro (  vtkPVSourceCollection *  col, char *  sourcename )  [protected]

This is a big function because I'm triying to do it all in one pass parses the reader portion of the state file and uses it to initialize the reader module (both parameter and display settings) the rest of the script is then executed, adding created filters to the lmk's collection as we go, and saving the visibility of the filters so that we can go back and set reset them at the end

---

Friends And Related Function Documentation

friend class vtkPVLookmarkObserver [friend]

Definition at line 183 of file vtkPVLookmark.h.

---

Member Data Documentation

vtkPVLookmarkObserver* vtkPVLookmark::Observer [protected]

Definition at line 182 of file vtkPVLookmark.h.

char* vtkPVLookmark::Version [protected]

Definition at line 232 of file vtkPVLookmark.h.

char* vtkPVLookmark::StateScript [protected]

Definition at line 233 of file vtkPVLookmark.h.

char* vtkPVLookmark::ImageData [protected]

Definition at line 234 of file vtkPVLookmark.h.

float* vtkPVLookmark::CenterOfRotation [protected]

Definition at line 235 of file vtkPVLookmark.h.

vtkPVSourceCollection* vtkPVLookmark::Sources [protected]

Definition at line 236 of file vtkPVLookmark.h.

int vtkPVLookmark::Location [protected]

Definition at line 237 of file vtkPVLookmark.h.

unsigned long vtkPVLookmark::ErrorEventTag [protected]

Definition at line 238 of file vtkPVLookmark.h.

int vtkPVLookmark::ReleaseEventFlag [protected]

Definition at line 239 of file vtkPVLookmark.h.

vtkPVTraceHelper* vtkPVLookmark::TraceHelper [protected]

Definition at line 241 of file vtkPVLookmark.h.

vtkKWPushButton* vtkPVLookmark::ToolbarButton [protected]

Definition at line 243 of file vtkPVLookmark.h.

---

The documentation for this class was generated from the following file:

• GUI/Client/vtkPVLookmark.h

---