Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkPVObjectWidget Class Reference

Widget the represents an objects variable. More...

#include <vtkPVObjectWidget.h>

Inheritance diagram for vtkPVObjectWidget:

Inheritance graph
[legend]
Collaboration diagram for vtkPVObjectWidget:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkPVObjectWidget, vtkPVWidget)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SaveInBatchScript (ofstream *file)=0
virtual void SetObjectID (vtkClientServerID)
virtual void SetVariableName (const char *)
virtual char * GetVariableName ()
vtkPVObjectWidgetClonePrototype (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
virtual vtkClientServerID GetObjectByName (const char *)

Protected Member Functions

 vtkPVObjectWidget ()
 ~vtkPVObjectWidget ()
 vtkPVObjectWidget (const vtkPVObjectWidget &)
void operator= (const vtkPVObjectWidget &)
virtual void CopyProperties (vtkPVWidget *clone, vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
int ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)

Protected Attributes

vtkClientServerID ObjectID
char * VariableName

Detailed Description

Widget the represents an objects variable.

vtkPVObjectWidget is a special class of vtkPVWidget that represents a VTK object's variable. It has ivars for the VTK objects name and its variable name. The Reset and Accept commands can format scripts from these variables. The name of this class may not be the best. .NOTE Since we have created the AcceptInternal method that has the object tcl name as an argument, many classes do not need this superclass or use its ivar ObjectID. I have not removed the class because I believe some widgets use this class when the object is a PV object and not a VTK object. I will have to clean this up later

!!!!!!!!!!!!!!

Definition at line 37 of file vtkPVObjectWidget.h.


Constructor & Destructor Documentation

vtkPVObjectWidget::vtkPVObjectWidget  )  [protected]
 

vtkPVObjectWidget::~vtkPVObjectWidget  )  [protected]
 

vtkPVObjectWidget::vtkPVObjectWidget const vtkPVObjectWidget  )  [protected]
 


Member Function Documentation

vtkPVObjectWidget::vtkTypeRevisionMacro vtkPVObjectWidget  ,
vtkPVWidget 
 

void vtkPVObjectWidget::PrintSelf ostream &  os,
vtkIndent  indent
 

Reimplemented from vtkPVWidget.

Reimplemented in vtkPV3DWidget, vtkPVBoxWidget, vtkPVExtentEntry, vtkPVFileEntry, vtkPVImplicitPlaneWidget, vtkPVLabeledToggle, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPickBoxWidget, vtkPVPickSphereWidget, vtkPVPointSourceWidget, vtkPVPointWidget, vtkPVScale, vtkPVScaleFactorEntry, vtkPVSelectionList, vtkPVSelectWidget, vtkPVSphereWidget, vtkPVStringEntry, vtkPVThumbWheel, vtkPVVectorEntry, and vtkPVXDMFParameters.

virtual void vtkPVObjectWidget::SetObjectID vtkClientServerID   )  [virtual]
 

The point of a PV widget is that it is an interface for some objects state/ivars. This is one way the object/variable can be specified. Subclasses may have seperate or addition variables for specifying the relationship.

virtual void vtkPVObjectWidget::SetVariableName const char *   )  [virtual]
 

The point of a PV widget is that it is an interface for some objects state/ivars. This is one way the object/variable can be specified. Subclasses may have seperate or addition variables for specifying the relationship.

virtual char* vtkPVObjectWidget::GetVariableName  )  [virtual]
 

The point of a PV widget is that it is an interface for some objects state/ivars. This is one way the object/variable can be specified. Subclasses may have seperate or addition variables for specifying the relationship.

vtkPVObjectWidget* vtkPVObjectWidget::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.

Reimplemented in vtkPVExtentEntry, vtkPVFileEntry, vtkPVLabeledToggle, vtkPVLineWidget, vtkPVScale, vtkPVSelectionList, vtkPVSelectWidget, vtkPVStringEntry, vtkPVThumbWheel, vtkPVVectorEntry, and vtkPVXDMFParameters.

virtual vtkClientServerID vtkPVObjectWidget::GetObjectByName const char *   )  [inline, virtual]
 

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.

Definition at line 64 of file vtkPVObjectWidget.h.

virtual void vtkPVObjectWidget::SaveInBatchScript ofstream *  file  )  [pure virtual]
 

Save this widget to a file.

Reimplemented from vtkPVWidget.

Implemented in vtkPVBoxWidget, vtkPVExtentEntry, vtkPVFileEntry, vtkPVImplicitPlaneWidget, vtkPVLabeledToggle, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPointSourceWidget, vtkPVPointWidget, vtkPVScale, vtkPVSelectionList, vtkPVSelectWidget, vtkPVSphereWidget, vtkPVStringEntry, vtkPVThumbWheel, vtkPVVectorEntry, and vtkPVXDMFParameters.

void vtkPVObjectWidget::operator= const vtkPVObjectWidget  )  [protected]
 

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

Reimplemented from vtkPVWidget.

Reimplemented in vtkPV3DWidget, vtkPVExtentEntry, vtkPVFileEntry, vtkPVLabeledToggle, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPointSourceWidget, vtkPVScale, vtkPVSelectionList, vtkPVSelectWidget, vtkPVStringEntry, vtkPVThumbWheel, vtkPVVectorEntry, and vtkPVXDMFParameters.

int vtkPVObjectWidget::ReadXMLAttributes vtkPVXMLElement element,
vtkPVXMLPackageParser parser
[protected, virtual]
 

Called by vtkPVXMLPackageParser to configure the widget from XML attributes.

Reimplemented from vtkPVWidget.

Reimplemented in vtkPV3DWidget, vtkPVBoxWidget, vtkPVExtentEntry, vtkPVFileEntry, vtkPVImplicitPlaneWidget, vtkPVLabeledToggle, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPointSourceWidget, vtkPVPointWidget, vtkPVScale, vtkPVScaleFactorEntry, vtkPVSelectionList, vtkPVSelectWidget, vtkPVSphereWidget, vtkPVStringEntry, vtkPVThumbWheel, vtkPVVectorEntry, and vtkPVXDMFParameters.


Member Data Documentation

vtkClientServerID vtkPVObjectWidget::ObjectID [protected]
 

Definition at line 75 of file vtkPVObjectWidget.h.

char* vtkPVObjectWidget::VariableName [protected]
 

Definition at line 76 of file vtkPVObjectWidget.h.


The documentation for this class was generated from the following file:
Generated on Tue May 30 12:40:49 2006 for ParaView by doxygen 1.3.5