vtkPVScale Class Reference

#include <vtkPVScale.h>

Inheritance diagram for vtkPVScale:

[legend]Collaboration diagram for vtkPVScale:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVScale, vtkPVObjectWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *pvApp)
void	SetLabel (const char *label)
void	SetResolution (double res)
void	DisplayEntry ()
void	SetDisplayEntryAndLabelOnTop (int value)
virtual void	SetBalloonHelpString (const char *str)
virtual void	ResetInternal ()
virtual void	Initialize ()
virtual void	UpdateEnableState ()
virtual void	SaveInBatchScript (ofstream *file)
void	SetValue (double val)
double	GetValue ()
void	SetRange (double min, double max)
double	GetRangeMin ()
double	GetRangeMax ()
void	CheckModifiedCallback ()
void	EntryCheckModifiedCallback ()
vtkPVScale *	ClonePrototype (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
virtual void	Accept ()
virtual void	Trace (ofstream *file)
void	Trace ()
virtual void	SetRound (int)
virtual int	GetRound ()
virtual void	RoundOn ()
virtual void	RoundOff ()
virtual void	SetEntryFlag (int)
virtual void	SetEntryAndLabelOnTopFlag (int)
virtual void	SetDisplayValueFlag (int)
virtual void	SetTraceSliderMovement (int)
virtual int	GetTraceSliderMovement ()
Static Public Member Functions
vtkPVScale *	New ()
Protected Member Functions
	vtkPVScale ()
	~vtkPVScale ()
int	RoundValue (double val)
	vtkPVScale (const vtkPVScale &)
void	operator= (const vtkPVScale &)
void	SetValueInternal (double val)
virtual void	SetEntryLabel (const char *)
virtual char *	GetEntryLabel ()
virtual void	CopyProperties (vtkPVWidget *clone, vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
Protected Attributes
int	EntryFlag
int	EntryAndLabelOnTopFlag
int	DisplayValueFlag
int	Round
vtkKWLabel *	LabelWidget
vtkKWScaleWithEntry *	Scale
char *	EntryLabel
int	TraceSliderMovement

---

Constructor & Destructor Documentation

vtkPVScale::vtkPVScale (   )  [protected]

vtkPVScale::~vtkPVScale (   )  [protected]

vtkPVScale::vtkPVScale (  const vtkPVScale &   )  [protected]

---

Member Function Documentation

vtkPVScale* vtkPVScale::New (   )  [static]

Reimplemented from vtkPVTracedWidget.

vtkPVScale::vtkTypeRevisionMacro (  vtkPVScale  , vtkPVObjectWidget  )

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

Reimplemented from vtkPVObjectWidget.

virtual void vtkPVScale::Create (  vtkKWApplication *  pvApp  )  [virtual]

Create the widget. Reimplemented from vtkPVWidget.

void vtkPVScale::SetValue (  double  val  )

This method allows scripts to modify the widgets value.

double vtkPVScale::GetValue (   )

This method allows scripts to modify the widgets value.

void vtkPVScale::SetLabel (  const char *  label  )

The label.

void vtkPVScale::SetResolution (  double  res  )

The resolution of the scale

void vtkPVScale::SetRange (  double  min, double  max )

Set the range of the scale.

double vtkPVScale::GetRangeMin (   )

Set the range of the scale.

double vtkPVScale::GetRangeMax (   )

Set the range of the scale.

void vtkPVScale::DisplayEntry (   )

Turn on display of the entry box widget that lets the user entry an exact value.

void vtkPVScale::SetDisplayEntryAndLabelOnTop (  int  value  )

Set whether the entry is displayed to the side of the scale or on top. Default is 1 for on top. Set to 0 for side.

virtual void vtkPVScale::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 vtkPVScale::CheckModifiedCallback (   )

Check if the widget was modified.

void vtkPVScale::EntryCheckModifiedCallback (   )

Check if the widget was modified.

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

virtual void vtkPVScale::Accept (   )  [virtual]

Called when accept button is pushed. Sets objects variable to the widgets value. Side effect is to turn modified flag off. Implements vtkPVWidget.

virtual void vtkPVScale::ResetInternal (   )  [virtual]

Called when the reset button is pushed. Sets widget's value to the object-variable's value. Side effect is to turn the modified flag off. Reimplemented from vtkPVWidget.

virtual void vtkPVScale::Initialize (   )  [virtual]

Initialize the widget after creation Implements vtkPVWidget.

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

This serves a dual purpose. For tracing and for saving state. Implements vtkPVWidget.

void vtkPVScale::Trace (   )

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

virtual void vtkPVScale::SetRound (  int   )  [virtual]

Get/Set whether to round floating point values to integers.

virtual int vtkPVScale::GetRound (   )  [virtual]

Get/Set whether to round floating point values to integers.

virtual void vtkPVScale::RoundOn (   )  [virtual]

Get/Set whether to round floating point values to integers.

virtual void vtkPVScale::RoundOff (   )  [virtual]

Get/Set whether to round floating point values to integers.

virtual void vtkPVScale::SetEntryFlag (  int   )  [virtual]

Flags to determine how to display the scale.

virtual void vtkPVScale::SetEntryAndLabelOnTopFlag (  int   )  [virtual]

Flags to determine how to display the scale.

virtual void vtkPVScale::SetDisplayValueFlag (  int   )  [virtual]

Flags to determine how to display the scale.

virtual void vtkPVScale::SetTraceSliderMovement (  int   )  [virtual]

Flag for whether to save each movement of the slider in a trace file. This is used for vtkPVScales that are not being used to control parameters of a vtkSource.

virtual int vtkPVScale::GetTraceSliderMovement (   )  [virtual]

Flag for whether to save each movement of the slider in a trace file. This is used for vtkPVScales that are not being used to control parameters of a vtkSource.

virtual void vtkPVScale::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 vtkPVScale::SaveInBatchScript (  ofstream *  file  )  [virtual]

Save this widget to a file. Implements vtkPVObjectWidget.

int vtkPVScale::RoundValue (  double  val  )  [protected]

void vtkPVScale::operator= (  const vtkPVScale &   )  [protected]

void vtkPVScale::SetValueInternal (  double  val  )  [protected]

virtual void vtkPVScale::SetEntryLabel (  const char *   )  [protected, virtual]

virtual char* vtkPVScale::GetEntryLabel (   )  [protected, virtual]

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

Reimplemented from vtkPVObjectWidget.

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

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

---

Member Data Documentation

int vtkPVScale::EntryFlag [protected]

Definition at line 145 of file vtkPVScale.h.

int vtkPVScale::EntryAndLabelOnTopFlag [protected]

Definition at line 146 of file vtkPVScale.h.

int vtkPVScale::DisplayValueFlag [protected]

Definition at line 147 of file vtkPVScale.h.

int vtkPVScale::Round [protected]

Definition at line 148 of file vtkPVScale.h.

vtkKWLabel* vtkPVScale::LabelWidget [protected]

Definition at line 150 of file vtkPVScale.h.

vtkKWScaleWithEntry* vtkPVScale::Scale [protected]

Definition at line 151 of file vtkPVScale.h.

char* vtkPVScale::EntryLabel [protected]

Definition at line 159 of file vtkPVScale.h.

int vtkPVScale::TraceSliderMovement [protected]

Definition at line 161 of file vtkPVScale.h.

---

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

• GUI/Client/vtkPVScale.h

---