vtkPV3DWidget Class Reference

superclass of 3D Widgets More...

#include <vtkPV3DWidget.h>

Inheritance diagram for vtkPV3DWidget:

[legend]Collaboration diagram for vtkPV3DWidget:


Public Member Functions
	vtkTypeRevisionMacro (vtkPV3DWidget, vtkPVObjectWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
void	SetValueChanged ()
virtual void	Select ()
virtual void	Deselect ()
virtual void	EnableAnimation ()
virtual void	DisableAnimation ()
virtual void	PlaceWidget ()
virtual void	ActualPlaceWidget ()
virtual void	UpdateEnableState ()
virtual vtkSMProxy *	GetProxyByName (const char *)
virtual vtkSM3DWidgetProxy *	GetWidgetProxy ()
virtual char *	GetWidgetProxyName ()
virtual char *	GetWidgetProxyXMLName ()
virtual void	Trace (ofstream *file)

void	SetVisibility ()
virtual void	SetVisibility (int val)
void	SetVisibilityNoTrace (int val)
virtual void	VisibilityOn ()
virtual void	VisibilityOff ()

virtual void	SetUseLabel (int)
virtual int	GetUseLabel ()

virtual void	Accept ()
virtual void	ResetInternal ()

virtual void	Initialize ()
Protected Member Functions
	vtkPV3DWidget ()
	~vtkPV3DWidget ()
virtual void	PlaceWidget (double bds[6])
void	InitializeObservers (vtkSM3DWidgetProxy *widgetproxy)
void	Render ()
virtual void	SetWidgetProxyName (const char *)
virtual void	SetWidgetProxyXMLName (const char *)
void	SetFrameLabel (const char *label)
virtual void	ChildCreate (vtkPVApplication *)=0
virtual void	CopyProperties (vtkPVWidget clone, vtkPVSource pvSource, vtkArrayMap< vtkPVWidget , vtkPVWidget > *map)
virtual void	ExecuteEvent (vtkObject , unsigned long, void )
virtual int	ReadXMLAttributes (vtkPVXMLElement element, vtkPVXMLPackageParser parser)
Protected Attributes
vtkPV3DWidgetObserver *	Observer
vtkSM3DWidgetProxy *	WidgetProxy
char *	WidgetProxyName
char *	WidgetProxyXMLName
vtkKWFrame *	Frame
vtkKWFrameWithLabel *	LabeledFrame
vtkKWCheckButton *	Visibility
int	ValueChanged
int	Placed
int	Visible
int	UseLabel
Friends
class	vtkPV3DWidgetObserver

Detailed Description

superclass of 3D Widgets

Todo: Cleanup GUI: Visibility Resolution

Definition at line 39 of file vtkPV3DWidget.h.

Constructor & Destructor Documentation

vtkPV3DWidget::vtkPV3DWidget ( ) [protected]

vtkPV3DWidget::~vtkPV3DWidget ( ) [protected]

Member Function Documentation

vtkPV3DWidget::vtkTypeRevisionMacro ( vtkPV3DWidget ,

vtkPVObjectWidget

)

void vtkPV3DWidget::PrintSelf ( ostream & os,

vtkIndent indent

)

Reimplemented from vtkPVObjectWidget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPickBoxWidget, vtkPVPickSphereWidget, vtkPVPointSourceWidget, vtkPVPointWidget, and vtkPVSphereWidget.

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

Create the widget. Creates a SM3DWidgetProxy. The actual proxy XML name is determined using WidgetProxyXMLName which is set by derrived clases of this class.
Reimplemented from vtkPVWidget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPointSourceWidget, vtkPVPointWidget, and vtkPVSphereWidget.

void vtkPV3DWidget::SetVisibility ( )

Set the widget visibility.

virtual void vtkPV3DWidget::SetVisibility ( int val ) [virtual]

Set the widget visibility.
Reimplemented in vtkPVPointWidget.

void vtkPV3DWidget::SetVisibilityNoTrace ( int val )

Set the widget visibility.

virtual void vtkPV3DWidget::VisibilityOn ( ) [virtual]

Set the widget visibility.

virtual void vtkPV3DWidget::VisibilityOff ( ) [virtual]

Set the widget visibility.

void vtkPV3DWidget::SetValueChanged ( )

Set modified to 1 when value has changed.

virtual void vtkPV3DWidget::Select ( ) [virtual]

This method is called when the source that contains this widget is selected.
Reimplemented from vtkPVWidget.

virtual void vtkPV3DWidget::Deselect ( ) [virtual]

This method is called when the source that contains this widget is deselected.
Reimplemented from vtkPVWidget.

virtual void vtkPV3DWidget::EnableAnimation ( ) [inline, virtual]

Register the animatable proxies and make them available for animation. Called by vtkPVSelectWidget when the widget is selected. This is to make sure that only the selected widget shows up in the animation interface and thus avoids confusion.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVPointSourceWidget, and vtkPVSphereWidget.
Definition at line 74 of file vtkPV3DWidget.h.

virtual void vtkPV3DWidget::DisableAnimation ( ) [inline, virtual]

Unregister animatable proxies so that they are not available for animation. Called by vtkPVSelectWidget when this widget is deselected. is to make sure that only the selected widget shows up in the animation interface and thus avoids confusion.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVPointSourceWidget, and vtkPVSphereWidget.
Definition at line 80 of file vtkPV3DWidget.h.

virtual void vtkPV3DWidget::PlaceWidget ( ) [virtual]

This method sets the input to the 3D widget and places the widget.
Reimplemented in vtkPVBoxWidget.

virtual void vtkPV3DWidget::ActualPlaceWidget ( ) [virtual]

This method does the actual placing. If the subclass is doing something fancy, it should overwrite it.
Reimplemented in vtkPVLineWidget, vtkPVPointWidget, and vtkPVSphereWidget.

virtual void vtkPV3DWidget::SetUseLabel ( int ) [virtual]

Determines whether there is a label-border around the widget ui.

virtual int vtkPV3DWidget::GetUseLabel ( ) [virtual]

Determines whether there is a label-border around the widget ui.

virtual void vtkPV3DWidget::Accept ( ) [virtual]

Move widget state to VTK object or back.
Implements vtkPVWidget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPointSourceWidget, vtkPVPointWidget, and vtkPVSphereWidget.

virtual void vtkPV3DWidget::ResetInternal ( ) [virtual]

Move widget state to VTK object or back.
Reimplemented from vtkPVWidget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPointSourceWidget, vtkPVPointWidget, and vtkPVSphereWidget.

virtual void vtkPV3DWidget::Initialize ( ) [virtual]

Initialize the newly created widget.
Implements vtkPVWidget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPointSourceWidget, vtkPVPointWidget, and vtkPVSphereWidget.

virtual void vtkPV3DWidget::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.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineWidget, vtkPVPickBoxWidget, vtkPVPickSphereWidget, vtkPVPointSourceWidget, and vtkPVSphereWidget.

virtual vtkSMProxy* vtkPV3DWidget::GetProxyByName ( const char * ) [inline, virtual]

Provide access to the proxy used by this widget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVPointSourceWidget, and vtkPVSphereWidget.
Definition at line 117 of file vtkPV3DWidget.h.

virtual vtkSM3DWidgetProxy* vtkPV3DWidget::GetWidgetProxy ( ) [virtual]

virtual char* vtkPV3DWidget::GetWidgetProxyName ( ) [virtual]

virtual char* vtkPV3DWidget::GetWidgetProxyXMLName ( ) [virtual]

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

This serves a dual purpose. For tracing and for saving state.
Implements vtkPVWidget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineWidget, vtkPVPickBoxWidget, vtkPVPickSphereWidget, vtkPVPointSourceWidget, vtkPVPointWidget, and vtkPVSphereWidget.

virtual void vtkPV3DWidget::PlaceWidget ( double bds[6] ) [protected, virtual]

Reimplemented in vtkPVBoxWidget.

void vtkPV3DWidget::InitializeObservers ( vtkSM3DWidgetProxy * widgetproxy ) [protected]

Initialize observers on the SM3DWidgetProxy.

void vtkPV3DWidget::Render ( ) [protected]

virtual void vtkPV3DWidget::SetWidgetProxyName ( const char * ) [protected, virtual]

virtual void vtkPV3DWidget::SetWidgetProxyXMLName ( const char * ) [protected, virtual]

void vtkPV3DWidget::SetFrameLabel ( const char * label ) [protected]

Set label of the frame

virtual void vtkPV3DWidget::ChildCreate ( vtkPVApplication * ) [protected, pure virtual]

Call creation on the child.
Implemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineWidget, vtkPVPickBoxWidget, vtkPVPickSphereWidget, vtkPVPointWidget, and vtkPVSphereWidget.

virtual void vtkPV3DWidget::CopyProperties ( vtkPVWidget * clone,

vtkPVSource * pvSource,

vtkArrayMap< vtkPVWidget *, vtkPVWidget * > * map

) [protected, virtual]

Reimplemented from vtkPVObjectWidget.
Reimplemented in vtkPVLineSourceWidget, vtkPVLineWidget, and vtkPVPointSourceWidget.

virtual void vtkPV3DWidget::ExecuteEvent ( vtkObject * ,

unsigned long,

void *

) [protected, virtual]

Reimplemented from vtkPVWidget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineWidget, vtkPVPointWidget, and vtkPVSphereWidget.

virtual int vtkPV3DWidget::ReadXMLAttributes ( vtkPVXMLElement * element,

vtkPVXMLPackageParser * parser

) [protected, virtual]

Called by vtkPVXMLPackageParser to configure the widget from XML attributes.
Reimplemented from vtkPVObjectWidget.
Reimplemented in vtkPVBoxWidget, vtkPVImplicitPlaneWidget, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVPointSourceWidget, vtkPVPointWidget, and vtkPVSphereWidget.

Friends And Related Function Documentation

friend class vtkPV3DWidgetObserver [friend]

Definition at line 155 of file vtkPV3DWidget.h.

Member Data Documentation

vtkPV3DWidgetObserver* vtkPV3DWidget::Observer [protected]

Reimplemented from vtkPVWidget.
Definition at line 138 of file vtkPV3DWidget.h.

vtkSM3DWidgetProxy* vtkPV3DWidget::WidgetProxy [protected]

Definition at line 139 of file vtkPV3DWidget.h.

char* vtkPV3DWidget::WidgetProxyName [protected]

Definition at line 140 of file vtkPV3DWidget.h.

char* vtkPV3DWidget::WidgetProxyXMLName [protected]

Definition at line 141 of file vtkPV3DWidget.h.

vtkKWFrame* vtkPV3DWidget::Frame [protected]

Definition at line 163 of file vtkPV3DWidget.h.

vtkKWFrameWithLabel* vtkPV3DWidget::LabeledFrame [protected]

Definition at line 164 of file vtkPV3DWidget.h.

vtkKWCheckButton* vtkPV3DWidget::Visibility [protected]

Definition at line 165 of file vtkPV3DWidget.h.

int vtkPV3DWidget::ValueChanged [protected]

Definition at line 166 of file vtkPV3DWidget.h.

int vtkPV3DWidget::Placed [protected]

Definition at line 167 of file vtkPV3DWidget.h.

int vtkPV3DWidget::Visible [protected]

Definition at line 168 of file vtkPV3DWidget.h.

int vtkPV3DWidget::UseLabel [protected]

Definition at line 169 of file vtkPV3DWidget.h.

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

GUI/Client/vtkPV3DWidget.h

Generated on Tue May 30 12:34:27 2006 for ParaView by

1.3.5

vtkPV3DWidget Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation