vtkPVSphereWidget Class Reference

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

#include <vtkPVSphereWidget.h>

Inheritance diagram for vtkPVSphereWidget:

[legend]Collaboration diagram for vtkPVSphereWidget:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVSphereWidget, vtkPV3DWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
void	CenterResetCallback ()
virtual void	SetBalloonHelpString (const char *str)
void	SetCenter ()
void	SetCenter (double, double, double)
void	SetCenter (double c[3])
void	GetCenter (double pts[3])
void	SetRadius ()
void	SetRadius (double)
double	GetRadius ()
virtual void	ResetInternal ()
virtual void	Initialize ()
virtual void	Trace (ofstream *file)
virtual void	UpdateEnableState ()
virtual vtkSMProxy *	GetProxyByName (const char *)
virtual void	Update ()
virtual void	Create (vtkKWApplication *app)
virtual void	EnableAnimation ()
virtual void	DisableAnimation ()
virtual void	Accept ()
virtual void	SetInputMenu (vtkPVInputMenu *)
virtual vtkPVInputMenu *	GetInputMenu ()
Static Public Member Functions
vtkPVSphereWidget *	New ()
Protected Member Functions
	vtkPVSphereWidget ()
	~vtkPVSphereWidget ()
void	SetCenterInternal (double, double, double)
void	SetCenterInternal (double c[3])
void	SetRadiusInternal (double)
virtual void	ChildCreate (vtkPVApplication *)
virtual void	ExecuteEvent (vtkObject *, unsigned long, void *)
virtual void	SaveInBatchScript (ofstream *file)
virtual void	ActualPlaceWidget ()
int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
void	SetupPropertyObservers ()
void	UnsetPropertyObservers ()
void	RegisterAnimateableProxies ()
void	UnregisterAnimateableProxies ()
void	GetCenterInternal (double pt[3])
double	GetRadiusInternal ()
virtual vtkPVWidget *	ClonePrototypeInternal (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
Protected Attributes
vtkKWEntry *	CenterEntry [3]
vtkKWEntry *	RadiusEntry
vtkKWPushButton *	CenterResetButton
vtkKWLabel *	Labels [2]
vtkKWLabel *	CoordinateLabel [3]
vtkPVInputMenu *	InputMenu
vtkSMProxy *	ImplicitFunctionProxy

---

Detailed Description

A widget to manipulate an implicit plane.

vtkPVSphereWidget can be considered as equivalent to the combination of vtkPVLineWidget and vtkPVLineSourceWidget. Unlike vtkPVLineWidget, vtkPVSphereWidget is never used without the implicit function, hence there was no need to have the distinction here.

Definition at line 37 of file vtkPVSphereWidget.h.

---

Constructor & Destructor Documentation

vtkPVSphereWidget::vtkPVSphereWidget (   )  [protected]

vtkPVSphereWidget::~vtkPVSphereWidget (   )  [protected]

---

Member Function Documentation

vtkPVSphereWidget* vtkPVSphereWidget::New (   )  [static]

Reimplemented from vtkPVTracedWidget. Reimplemented in vtkPVPickSphereWidget.

vtkPVSphereWidget::vtkTypeRevisionMacro (  vtkPVSphereWidget  , vtkPV3DWidget  )

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

Reimplemented from vtkPV3DWidget. Reimplemented in vtkPVPickSphereWidget.

void vtkPVSphereWidget::CenterResetCallback (   )

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

virtual void vtkPVSphereWidget::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 vtkPVSphereWidget::SetCenter (   )

void vtkPVSphereWidget::SetCenter (  double  , double  , double  )

void vtkPVSphereWidget::SetCenter (  double  c[3]  )  [inline]

Definition at line 54 of file vtkPVSphereWidget.h.

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

void vtkPVSphereWidget::SetRadius (   )

void vtkPVSphereWidget::SetRadius (  double   )

double vtkPVSphereWidget::GetRadius (   )

virtual void vtkPVSphereWidget::ResetInternal (   )  [virtual]

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

virtual void vtkPVSphereWidget::Initialize (   )  [virtual]

Initializes widget after creation Reimplemented from vtkPV3DWidget.

virtual void vtkPVSphereWidget::Accept (   )  [virtual]

Called when the PVSources accept button is called. virtual void AcceptInternal(vtkClientServerID); Reimplemented from vtkPV3DWidget.

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

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

virtual void vtkPVSphereWidget::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. Reimplemented in vtkPVPickSphereWidget.

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

Returns the implicit function proxy. May be,we should use the GetProxyByName interface but for now...we use this one. virtual vtkSMProxy* GetImplicitFunctionProxy() { return this->ImplicitFunctionProxy; } Reimplemented from vtkPV3DWidget.

virtual void vtkPVSphereWidget::Update (   )  [virtual]

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

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

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

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

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

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

Create the widgets. Overloaded to create the ImplicitFunction proxy Reimplemented from vtkPV3DWidget.

virtual void vtkPVSphereWidget::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 109 of file vtkPVSphereWidget.h.

virtual void vtkPVSphereWidget::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 114 of file vtkPVSphereWidget.h.

void vtkPVSphereWidget::GetCenterInternal (  double  pt[3]  )  [protected]

These methods assume that the Property has been updated before calling them; i.e. Property->UpdateInformation has been invoked.

double vtkPVSphereWidget::GetRadiusInternal (   )  [protected]

These methods assume that the Property has been updated before calling them; i.e. Property->UpdateInformation has been invoked.

void vtkPVSphereWidget::SetCenterInternal (  double  , double  , double  )  [protected]

void vtkPVSphereWidget::SetCenterInternal (  double  c[3]  )  [inline, protected]

Definition at line 128 of file vtkPVSphereWidget.h.

void vtkPVSphereWidget::SetRadiusInternal (  double   )  [protected]

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

Call creation on the child. Implements vtkPV3DWidget. Reimplemented in vtkPVPickSphereWidget.

virtual void vtkPVSphereWidget::ExecuteEvent (  vtkObject *  , unsigned  long, void *  )  [protected, virtual]

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

virtual void vtkPVSphereWidget::SaveInBatchScript (  ofstream *  file  )  [protected, virtual]

For saving the widget into a VTK tcl script. This saves the implicit sphere. Parts will share this one sphere. Implements vtkPVObjectWidget.

virtual void vtkPVSphereWidget::ActualPlaceWidget (   )  [protected, virtual]

This method does the actual placing. If the subclass is doing something fancy, it should overwrite it. Reimplemented from vtkPV3DWidget.

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

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

virtual vtkPVWidget* vtkPVSphereWidget::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 vtkPVSphereWidget::SetupPropertyObservers (   )  [protected]

void vtkPVSphereWidget::UnsetPropertyObservers (   )  [protected]

void vtkPVSphereWidget::RegisterAnimateableProxies (   )  [protected]

void vtkPVSphereWidget::UnregisterAnimateableProxies (   )  [protected]

---

Member Data Documentation

vtkKWEntry* vtkPVSphereWidget::CenterEntry[3] [protected]

Definition at line 140 of file vtkPVSphereWidget.h.

vtkKWEntry* vtkPVSphereWidget::RadiusEntry [protected]

Definition at line 141 of file vtkPVSphereWidget.h.

vtkKWPushButton* vtkPVSphereWidget::CenterResetButton [protected]

Definition at line 142 of file vtkPVSphereWidget.h.

vtkKWLabel* vtkPVSphereWidget::Labels[2] [protected]

Definition at line 144 of file vtkPVSphereWidget.h.

vtkKWLabel* vtkPVSphereWidget::CoordinateLabel[3] [protected]

Definition at line 145 of file vtkPVSphereWidget.h.

vtkPVInputMenu* vtkPVSphereWidget::InputMenu [protected]

Definition at line 147 of file vtkPVSphereWidget.h.

vtkSMProxy* vtkPVSphereWidget::ImplicitFunctionProxy [protected]

Definition at line 149 of file vtkPVSphereWidget.h.

---

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

• GUI/Client/vtkPVSphereWidget.h

---