vtkPVArrayMenu Class Reference

Menu for selecting arrays from the input. More...

#include <vtkPVArrayMenu.h>

Inheritance diagram for vtkPVArrayMenu:

[legend]Collaboration diagram for vtkPVArrayMenu:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVArrayMenu, vtkPVWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Accept ()
virtual void	Create (vtkKWApplication *app)
void	ArrayMenuEntryCallback (const char *name)
virtual void	Update ()
virtual void	Trace (ofstream *file)
virtual void	UpdateEnableState ()
virtual void	SaveInBatchScript (ofstream *file)
virtual void	Initialize ()
void	SetLabel (const char *label)
const char *	GetLabel ()
virtual void	SetInputMenu (vtkPVInputMenu *)
virtual vtkPVInputMenu *	GetInputMenu ()
virtual void	SetFieldMenu (vtkPVFieldMenu *)
virtual vtkPVFieldMenu *	GetFieldMenu ()
void	SetValue (const char *name)
const char *	GetValue ()
virtual void	SetArrayName (const char *)
virtual char *	GetArrayName ()
vtkPVArrayMenu *	ClonePrototype (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
Static Public Member Functions
vtkPVArrayMenu *	New ()
Protected Member Functions
	vtkPVArrayMenu ()
	~vtkPVArrayMenu ()
virtual void	ResetInternal ()
void	UpdateArrayMenu ()
void	UpdateProperty ()
virtual void	SetInputAttributeIndex (const char *)
virtual vtkPVWidget *	ClonePrototypeInternal (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
virtual void	CopyProperties (vtkPVWidget *clone, vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
Protected Attributes
char *	ArrayName
vtkPVInputMenu *	InputMenu
vtkPVFieldMenu *	FieldMenu
vtkKWLabel *	Label
vtkKWMenuButton *	ArrayMenu
char *	InputAttributeIndex
int	CellData

---

Detailed Description

Menu for selecting arrays from the input.

This menu is pretty general, but expects a certain pattern to the set get method. It may be better to have explicit set/get method strings. I have been trying to get rid of the reference to PVSource, but this reference is the only way I have to track when the input changes. I could make a subclass to do this, but I do not know how the more general widget will be used.

Definition at line 41 of file vtkPVArrayMenu.h.

---

Constructor & Destructor Documentation

vtkPVArrayMenu::vtkPVArrayMenu (   )  [protected]

vtkPVArrayMenu::~vtkPVArrayMenu (   )  [protected]

---

Member Function Documentation

vtkPVArrayMenu* vtkPVArrayMenu::New (   )  [static]

Reimplemented from vtkPVTracedWidget.

vtkPVArrayMenu::vtkTypeRevisionMacro (  vtkPVArrayMenu  , vtkPVWidget  )

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

Reimplemented from vtkPVWidget.

virtual void vtkPVArrayMenu::Accept (   )  [virtual]

These methods are called when the Accept and Reset buttons are pressed. The copy state from VTK/PV objects to the widget and back. Most subclasses do not have to implement these methods. They implement AcceptInternal and ResetInternal instead. Only methods that copy state from PV object need to override these methods. Accept needs to add to the trace (call trace), but AcceptInternal does not. Implements vtkPVWidget.

virtual void vtkPVArrayMenu::Create (  vtkKWApplication *  app  )  [virtual]

Create the widget. Reimplemented from vtkPVWidget.

void vtkPVArrayMenu::SetLabel (  const char *  label  )

Set the label. The label can be used to get this widget from a script.

const char* vtkPVArrayMenu::GetLabel (   )

Set the label. The label can be used to get this widget from a script.

virtual void vtkPVArrayMenu::SetInputMenu (  vtkPVInputMenu *   )  [virtual]

This input menu supplies the data set.

virtual vtkPVInputMenu* vtkPVArrayMenu::GetInputMenu (   )  [virtual]

This input menu supplies the data set.

virtual void vtkPVArrayMenu::SetFieldMenu (  vtkPVFieldMenu *   )  [virtual]

This menu can alternatively supply the data set.

virtual vtkPVFieldMenu* vtkPVArrayMenu::GetFieldMenu (   )  [virtual]

This menu can alternatively supply the data set.

void vtkPVArrayMenu::SetValue (  const char *  name  )

Set the menus value as a string. Used by the Accept and Reset callbacks. Can also be used from a script.

const char* vtkPVArrayMenu::GetValue (   )  [inline]

Set the menus value as a string. Used by the Accept and Reset callbacks. Can also be used from a script. Definition at line 76 of file vtkPVArrayMenu.h.

virtual void vtkPVArrayMenu::SetArrayName (  const char *   )  [virtual]

Direct access to the ArrayName is used internally by the Reset method. The methods "SetValue" should be used instead of this method.

virtual char* vtkPVArrayMenu::GetArrayName (   )  [virtual]

Direct access to the ArrayName is used internally by the Reset method. The methods "SetValue" should be used instead of this method.

void vtkPVArrayMenu::ArrayMenuEntryCallback (  const char *  name  )

These are internal methods that are called when a menu is changed.

virtual void vtkPVArrayMenu::Update (   )  [virtual]

This is called to update the menus if something (InputMenu) changes. Reimplemented from vtkPVWidget.

vtkPVArrayMenu* vtkPVArrayMenu::ClonePrototype (  vtkPVSource *  pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *  map )

Creates and returns a copy of this widget. It will create a new instance of the same type as the current object using NewInstance() and then copy some necessary state parameters. Reimplemented from vtkPVWidget.

virtual void vtkPVArrayMenu::Trace (  ofstream *  file  )  [virtual]

Used by subclasses to save this widgets state into a PVScript. This method does not initialize trace variable or check modified. Implements vtkPVWidget.

virtual void vtkPVArrayMenu::UpdateEnableState (   )  [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc. Reimplemented from vtkKWWidget.

virtual void vtkPVArrayMenu::SaveInBatchScript (  ofstream *  file  )  [virtual]

Save this widget to a file. Reimplemented from vtkPVWidget.

virtual void vtkPVArrayMenu::Initialize (   )  [virtual]

Initialize the widget after creation Implements vtkPVWidget.

virtual void vtkPVArrayMenu::ResetInternal (   )  [protected, virtual]

Called by Reset() if PVSource is set. Reimplemented from vtkPVWidget.

void vtkPVArrayMenu::UpdateArrayMenu (   )  [protected]

void vtkPVArrayMenu::UpdateProperty (   )  [protected]

virtual void vtkPVArrayMenu::SetInputAttributeIndex (  const char *   )  [protected, virtual]

virtual vtkPVWidget* vtkPVArrayMenu::ClonePrototypeInternal (  vtkPVSource *  pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *  map )  [protected, virtual]

Reimplemented from vtkPVWidget.

virtual void vtkPVArrayMenu::CopyProperties (  vtkPVWidget *  clone, vtkPVSource *  pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *  map )  [protected, virtual]

Reimplemented from vtkPVWidget.

int vtkPVArrayMenu::ReadXMLAttributes (  vtkPVXMLElement *  element, vtkPVXMLPackageParser *  parser )  [protected, virtual]

Called by vtkPVXMLPackageParser to configure the widget from XML attributes. Reimplemented from vtkPVWidget.

---

Member Data Documentation

char* vtkPVArrayMenu::ArrayName [protected]

Definition at line 127 of file vtkPVArrayMenu.h.

vtkPVInputMenu* vtkPVArrayMenu::InputMenu [protected]

Definition at line 130 of file vtkPVArrayMenu.h.

vtkPVFieldMenu* vtkPVArrayMenu::FieldMenu [protected]

Definition at line 131 of file vtkPVArrayMenu.h.

vtkKWLabel* vtkPVArrayMenu::Label [protected]

Definition at line 134 of file vtkPVArrayMenu.h.

vtkKWMenuButton* vtkPVArrayMenu::ArrayMenu [protected]

Definition at line 135 of file vtkPVArrayMenu.h.

char* vtkPVArrayMenu::InputAttributeIndex [protected]

Definition at line 142 of file vtkPVArrayMenu.h.

int vtkPVArrayMenu::CellData [protected]

Definition at line 155 of file vtkPVArrayMenu.h.

---

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

• GUI/Client/vtkPVArrayMenu.h

---