vtkPVImplicitPlaneWidget Class Reference

A widget to manipulate an implicit plane. More...

#include <vtkPVImplicitPlaneWidget.h>

Inheritance diagram for vtkPVImplicitPlaneWidget:

[legend]Collaboration diagram for vtkPVImplicitPlaneWidget:


Public Member Functions
	vtkTypeRevisionMacro (vtkPVImplicitPlaneWidget, vtkPV3DWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
void	CenterResetCallback ()
void	NormalCameraCallback ()
void	NormalXCallback ()
void	NormalYCallback ()
void	NormalZCallback ()
virtual void	SetBalloonHelpString (const char *str)
virtual void	SaveInBatchScript (ofstream *file)
virtual void	Update ()
virtual void	ResetInternal ()
virtual void	Initialize ()
virtual void	Trace (ofstream *file)
virtual void	UpdateEnableState ()
virtual vtkSMProxy *	GetProxyByName (const char *)
virtual void	UpdateVTKObjects ()
virtual void	Create (vtkKWApplication *app)
void	UpdateOffsetRange ()
virtual void	EnableAnimation ()
virtual void	DisableAnimation ()

void	SetCenter ()
virtual void	SetCenter (double, double, double)
virtual void	SetCenter (double f[3])
void	GetCenter (double pts[3])

void	SetNormal ()
virtual void	SetNormal (double, double, double)
virtual void	SetNormal (double f[3])
void	GetNormal (double pts[3])

virtual void	SetInputMenu (vtkPVInputMenu *)
virtual vtkPVInputMenu *	GetInputMenu ()

virtual void	Accept ()
Static Public Member Functions
vtkPVImplicitPlaneWidget *	New ()
Protected Member Functions
	vtkPVImplicitPlaneWidget ()
	~vtkPVImplicitPlaneWidget ()
virtual void	ChildCreate (vtkPVApplication *)
virtual void	ExecuteEvent (vtkObject , unsigned long, void )
virtual void	SetCenterInternal (double, double, double)
virtual void	SetNormalInternal (double, double, double)
int	ReadXMLAttributes (vtkPVXMLElement element, vtkPVXMLPackageParser parser)
void	CommonReset ()
void	SetupPropertyObservers ()
void	UnsetPropertyObservers ()

void	GetCenterInternal (double pts[3])
void	GetNormalInternal (double pts[3])

virtual vtkPVWidget *	ClonePrototypeInternal (vtkPVSource pvSource, vtkArrayMap< vtkPVWidget , vtkPVWidget * > *map)
void	RegisterAnimateableProxies ()
void	UnregisterAnimateableProxies ()
Protected Attributes
vtkPVInputMenu *	InputMenu
vtkKWEntry *	CenterEntry [3]
vtkKWPushButton *	CenterResetButton
vtkKWEntry *	NormalEntry [3]
vtkKWEntry *	OffsetEntry
vtkKWFrame *	NormalButtonFrame
vtkKWPushButton *	NormalCameraButton
vtkKWPushButton *	NormalXButton
vtkKWPushButton *	NormalYButton
vtkKWPushButton *	NormalZButton
vtkKWLabel *	Labels [2]
vtkKWLabel *	OffsetLabel
vtkKWLabel *	CoordinateLabel [3]
vtkSMProxy *	ImplicitFunctionProxy

Detailed Description

A widget to manipulate an implicit plane.

This widget creates and manages its own vtkPlane on each process. I could not decide whether to include the bounds display or not. (I did not.)

Definition at line 36 of file vtkPVImplicitPlaneWidget.h.

Constructor & Destructor Documentation

vtkPVImplicitPlaneWidget::vtkPVImplicitPlaneWidget ( ) [protected]

vtkPVImplicitPlaneWidget::~vtkPVImplicitPlaneWidget ( ) [protected]

Member Function Documentation

vtkPVImplicitPlaneWidget* vtkPVImplicitPlaneWidget::New ( ) [static]

Reimplemented from vtkPVTracedWidget.

vtkPVImplicitPlaneWidget::vtkTypeRevisionMacro ( vtkPVImplicitPlaneWidget ,

vtkPV3DWidget

)

void vtkPVImplicitPlaneWidget::PrintSelf ( ostream & os,

vtkIndent indent

)

Reimplemented from vtkPV3DWidget.

void vtkPVImplicitPlaneWidget::CenterResetCallback ( )

Callback that set the center to the middle of the bounds.

void vtkPVImplicitPlaneWidget::NormalCameraCallback ( )

void vtkPVImplicitPlaneWidget::NormalXCallback ( )

void vtkPVImplicitPlaneWidget::NormalYCallback ( )

void vtkPVImplicitPlaneWidget::NormalZCallback ( )

virtual void vtkPVImplicitPlaneWidget::SetBalloonHelpString ( const char * str ) [virtual]

This class redefines SetBalloonHelpString since it has to forward the call to a widget it contains.
Reimplemented from vtkKWWidget.

void vtkPVImplicitPlaneWidget::SetCenter ( )

Center of the plane.

virtual void vtkPVImplicitPlaneWidget::SetCenter ( double ,

double ,

double

) [virtual]

Center of the plane.

virtual void vtkPVImplicitPlaneWidget::SetCenter ( double f[3] ) [inline, virtual]

Center of the plane.
Definition at line 63 of file vtkPVImplicitPlaneWidget.h.

void vtkPVImplicitPlaneWidget::GetCenter ( double pts[3] )

Center of the plane.

void vtkPVImplicitPlaneWidget::SetNormal ( )

The normal to the plane.

virtual void vtkPVImplicitPlaneWidget::SetNormal ( double ,

double ,

double

) [virtual]

The normal to the plane.

virtual void vtkPVImplicitPlaneWidget::SetNormal ( double f[3] ) [inline, virtual]

The normal to the plane.
Definition at line 71 of file vtkPVImplicitPlaneWidget.h.

void vtkPVImplicitPlaneWidget::GetNormal ( double pts[3] )

The normal to the plane.

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

The input from the input menu is used to place the widget.

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

The input from the input menu is used to place the widget.

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

For saving the widget into a VTK tcl script. One plane object is create for all parts.
Implements vtkPVObjectWidget.

virtual void vtkPVImplicitPlaneWidget::Update ( ) [virtual]

Called when the input chages (before accept).
Reimplemented from vtkPVWidget.

virtual void vtkPVImplicitPlaneWidget::ResetInternal ( ) [virtual]

Called when the PVSources reset button is called.
Reimplemented from vtkPV3DWidget.

virtual void vtkPVImplicitPlaneWidget::Initialize ( ) [virtual]

Place the widget.
Reimplemented from vtkPV3DWidget.

virtual void vtkPVImplicitPlaneWidget::Accept ( ) [virtual]

Called when the PVSources accept button is called.
Reimplemented from vtkPV3DWidget.

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

This serves a dual purpose. For tracing and for saving state.
Reimplemented from vtkPV3DWidget.

virtual void vtkPVImplicitPlaneWidget::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 vtkPV3DWidget.

virtual vtkSMProxy* vtkPVImplicitPlaneWidget::GetProxyByName ( const char * ) [virtual]

Provide access to the proxy used by this widget. Plane == PlaneProxy
Reimplemented from vtkPV3DWidget.

virtual void vtkPVImplicitPlaneWidget::UpdateVTKObjects ( ) [virtual]

Calls UpdateVTKObjects on the plane proxy.
Reimplemented from vtkPVWidget.

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

Create the widget. Overloaded to create the ImplicitFunctionProxy
Reimplemented from vtkPV3DWidget.

void vtkPVImplicitPlaneWidget::UpdateOffsetRange ( )

Updates the Offset property of the plane proxy and calls ModifiedCallback.

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

Register the animatable proxies and make them avaiblable for animation. Called by vtkPVSelectWidget when the widget is selected.
Reimplemented from vtkPV3DWidget.
Definition at line 127 of file vtkPVImplicitPlaneWidget.h.

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

Unregister animatable proxies so that they are not available for animation. Called by vtkPVSelectWidget when this widget is deselected.
Reimplemented from vtkPV3DWidget.
Definition at line 132 of file vtkPVImplicitPlaneWidget.h.

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

Call creation on the child.
Implements vtkPV3DWidget.

virtual void vtkPVImplicitPlaneWidget::ExecuteEvent ( vtkObject * ,

unsigned long,

void *

) [protected, virtual]

Execute event of the 3D Widget.
Reimplemented from vtkPV3DWidget.

virtual void vtkPVImplicitPlaneWidget::SetCenterInternal ( double ,

double ,

double

) [protected, virtual]

virtual void vtkPVImplicitPlaneWidget::SetNormalInternal ( double ,

double ,

double

) [protected, virtual]

void vtkPVImplicitPlaneWidget::GetCenterInternal ( double pts[3] ) [protected]

These methods assume that UpdateInformation() has been called on the WidgetProxy()

void vtkPVImplicitPlaneWidget::GetNormalInternal ( double pts[3] ) [protected]

These methods assume that UpdateInformation() has been called on the WidgetProxy()

int vtkPVImplicitPlaneWidget::ReadXMLAttributes ( vtkPVXMLElement * element,

vtkPVXMLPackageParser * parser

) [protected, virtual]

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

void vtkPVImplicitPlaneWidget::CommonReset ( ) [protected]

void vtkPVImplicitPlaneWidget::SetupPropertyObservers ( ) [protected]

void vtkPVImplicitPlaneWidget::UnsetPropertyObservers ( ) [protected]

virtual vtkPVWidget* vtkPVImplicitPlaneWidget::ClonePrototypeInternal ( vtkPVSource * pvSource,

vtkArrayMap< vtkPVWidget *, vtkPVWidget * > * map

) [protected, 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.
Reimplemented from vtkPVWidget.

void vtkPVImplicitPlaneWidget::RegisterAnimateableProxies ( ) [protected]

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.

void vtkPVImplicitPlaneWidget::UnregisterAnimateableProxies ( ) [protected]

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.