vtkSliderRepresentation Class Reference
#include <vtkSliderRepresentation.h>
Detailed Description
abstract class defines the representation for a vtkSliderWidgetThis abstract class is used to specify how the vtkSliderWidget should interact with representations of the vtkSliderWidget. This class may be subclassed so that alternative representations can be created. The class defines an API, and a default implementation, that the vtkSliderWidget interacts with to render itself in the scene.
- See also:
- vtkSliderWidget
- Examples:
- vtkSliderRepresentation (Examples)
Definition at line 43 of file vtkSliderRepresentation.h.
| typedef vtkWidgetRepresentation | Superclass |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| static int | IsTypeOf (const char *type) |
| static vtkSliderRepresentation * | SafeDownCast (vtkObject *o) |
Public Types | |
| enum | _InteractionState { Outside = 0, Tube, LeftCap, RightCap, Slider } |
Public Member Functions | |
| void | SetValue (double value) |
| virtual double | GetValue () |
| void | SetMinimumValue (double value) |
| virtual double | GetMinimumValue () |
| void | SetMaximumValue (double value) |
| virtual double | GetMaximumValue () |
| virtual void | SetSliderLength (double) |
| virtual double | GetSliderLength () |
| virtual void | SetSliderWidth (double) |
| virtual double | GetSliderWidth () |
| virtual void | SetTubeWidth (double) |
| virtual double | GetTubeWidth () |
| virtual void | SetEndCapLength (double) |
| virtual double | GetEndCapLength () |
| virtual void | SetEndCapWidth (double) |
| virtual double | GetEndCapWidth () |
| virtual void | SetTitleText (const char *) |
| virtual const char * | GetTitleText () |
| virtual void | SetLabelFormat (const char *) |
| virtual char * | GetLabelFormat () |
| virtual void | SetLabelHeight (double) |
| virtual double | GetLabelHeight () |
| virtual void | SetTitleHeight (double) |
| virtual double | GetTitleHeight () |
| virtual void | SetShowSliderLabel (int) |
| virtual int | GetShowSliderLabel () |
| virtual void | ShowSliderLabelOn () |
| virtual void | ShowSliderLabelOff () |
| virtual double | GetCurrentT () |
| virtual double | GetPickedT () |
Protected Member Functions | |
| vtkSliderRepresentation () | |
| ~vtkSliderRepresentation () | |
Protected Attributes | |
| double | Value |
| double | MinimumValue |
| double | MaximumValue |
| double | SliderLength |
| double | SliderWidth |
| double | EndCapLength |
| double | EndCapWidth |
| double | TubeWidth |
| double | CurrentT |
| double | PickedT |
| int | ShowSliderLabel |
| char * | LabelFormat |
| double | LabelHeight |
| double | TitleHeight |
Member Typedef Documentation
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
Definition at line 48 of file vtkSliderRepresentation.h.
Member Enumeration Documentation
Definition at line 159 of file vtkSliderRepresentation.h.
Constructor & Destructor Documentation
| vtkSliderRepresentation::vtkSliderRepresentation | ( | ) | [protected] |
| vtkSliderRepresentation::~vtkSliderRepresentation | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkSliderRepresentation::GetClassName | ( | ) | [virtual] |
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
| static int vtkSliderRepresentation::IsTypeOf | ( | const char * | type | ) | [static] |
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
| virtual int vtkSliderRepresentation::IsA | ( | const char * | type | ) | [virtual] |
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
| static vtkSliderRepresentation* vtkSliderRepresentation::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
| void vtkSliderRepresentation::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
| void vtkSliderRepresentation::SetValue | ( | double | value | ) |
Specify the current value for the widget. The value should lie between the minimum and maximum values.
| virtual double vtkSliderRepresentation::GetValue | ( | ) | [virtual] |
Specify the current value for the widget. The value should lie between the minimum and maximum values.
| void vtkSliderRepresentation::SetMinimumValue | ( | double | value | ) |
Set the current minimum value that the slider can take. Setting the minimum value greater than the maximum value will cause the maximum value to grow to (minimum value + 1).
| virtual double vtkSliderRepresentation::GetMinimumValue | ( | ) | [virtual] |
Set the current minimum value that the slider can take. Setting the minimum value greater than the maximum value will cause the maximum value to grow to (minimum value + 1).
| void vtkSliderRepresentation::SetMaximumValue | ( | double | value | ) |
Set the current maximum value that the slider can take. Setting the maximum value less than the minimum value will cause the minimum value to change to (maximum value - 1).
| virtual double vtkSliderRepresentation::GetMaximumValue | ( | ) | [virtual] |
Set the current maximum value that the slider can take. Setting the maximum value less than the minimum value will cause the minimum value to change to (maximum value - 1).
| virtual void vtkSliderRepresentation::SetSliderLength | ( | double | ) | [virtual] |
Specify the length of the slider shape (in normalized display coordinates [0.01,0.5]). The slider length by default is 0.05.
| virtual double vtkSliderRepresentation::GetSliderLength | ( | ) | [virtual] |
Specify the length of the slider shape (in normalized display coordinates [0.01,0.5]). The slider length by default is 0.05.
| virtual void vtkSliderRepresentation::SetSliderWidth | ( | double | ) | [virtual] |
Set the width of the slider in the directions orthogonal to the slider axis. Using this it is possible to create ellipsoidal and hockey puck sliders (in some subclasses). By default the width is 0.05.
| virtual double vtkSliderRepresentation::GetSliderWidth | ( | ) | [virtual] |
Set the width of the slider in the directions orthogonal to the slider axis. Using this it is possible to create ellipsoidal and hockey puck sliders (in some subclasses). By default the width is 0.05.
| virtual void vtkSliderRepresentation::SetTubeWidth | ( | double | ) | [virtual] |
Set the width of the tube (in normalized display coordinates) on which the slider moves. By default the width is 0.05.
| virtual double vtkSliderRepresentation::GetTubeWidth | ( | ) | [virtual] |
Set the width of the tube (in normalized display coordinates) on which the slider moves. By default the width is 0.05.
| virtual void vtkSliderRepresentation::SetEndCapLength | ( | double | ) | [virtual] |
Specify the length of each end cap (in normalized coordinates [0.0,0.25]). By default the length is 0.025. If the end cap length is set to 0.0, then the end cap will not display at all.
| virtual double vtkSliderRepresentation::GetEndCapLength | ( | ) | [virtual] |
Specify the length of each end cap (in normalized coordinates [0.0,0.25]). By default the length is 0.025. If the end cap length is set to 0.0, then the end cap will not display at all.
| virtual void vtkSliderRepresentation::SetEndCapWidth | ( | double | ) | [virtual] |
Specify the width of each end cap (in normalized coordinates [0.0,0.25]). By default the width is twice the tube width.
| virtual double vtkSliderRepresentation::GetEndCapWidth | ( | ) | [virtual] |
Specify the width of each end cap (in normalized coordinates [0.0,0.25]). By default the width is twice the tube width.
| virtual void vtkSliderRepresentation::SetTitleText | ( | const char * | ) | [inline, virtual] |
Specify the label text for this widget. If the value is not set, or set to the empty string "", then the label text is not displayed.
Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
Definition at line 116 of file vtkSliderRepresentation.h.
| virtual const char* vtkSliderRepresentation::GetTitleText | ( | ) | [inline, virtual] |
Specify the label text for this widget. If the value is not set, or set to the empty string "", then the label text is not displayed.
Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
Definition at line 117 of file vtkSliderRepresentation.h.
| virtual void vtkSliderRepresentation::SetLabelFormat | ( | const char * | ) | [virtual] |
Set/Get the format with which to print the slider value.
| virtual char* vtkSliderRepresentation::GetLabelFormat | ( | ) | [virtual] |
Set/Get the format with which to print the slider value.
| virtual void vtkSliderRepresentation::SetLabelHeight | ( | double | ) | [virtual] |
Specify the relative height of the label as compared to the length of the slider.
| virtual double vtkSliderRepresentation::GetLabelHeight | ( | ) | [virtual] |
Specify the relative height of the label as compared to the length of the slider.
| virtual void vtkSliderRepresentation::SetTitleHeight | ( | double | ) | [virtual] |
Specify the relative height of the title as compared to the length of the slider.
| virtual double vtkSliderRepresentation::GetTitleHeight | ( | ) | [virtual] |
Specify the relative height of the title as compared to the length of the slider.
| virtual void vtkSliderRepresentation::SetShowSliderLabel | ( | int | ) | [virtual] |
Indicate whether the slider text label should be displayed. This is a number corresponding to the current Value of this widget.
| virtual int vtkSliderRepresentation::GetShowSliderLabel | ( | ) | [virtual] |
Indicate whether the slider text label should be displayed. This is a number corresponding to the current Value of this widget.
| virtual void vtkSliderRepresentation::ShowSliderLabelOn | ( | ) | [virtual] |
Indicate whether the slider text label should be displayed. This is a number corresponding to the current Value of this widget.
| virtual void vtkSliderRepresentation::ShowSliderLabelOff | ( | ) | [virtual] |
Indicate whether the slider text label should be displayed. This is a number corresponding to the current Value of this widget.
| virtual double vtkSliderRepresentation::GetCurrentT | ( | ) | [inline, virtual] |
Methods to interface with the vtkSliderWidget. Subclasses of this class actually do something.
Definition at line 151 of file vtkSliderRepresentation.h.
| virtual double vtkSliderRepresentation::GetPickedT | ( | ) | [inline, virtual] |
Methods to interface with the vtkSliderWidget. Subclasses of this class actually do something.
Definition at line 153 of file vtkSliderRepresentation.h.
Member Data Documentation
double vtkSliderRepresentation::Value [protected] |
Definition at line 174 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::MinimumValue [protected] |
Definition at line 175 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::MaximumValue [protected] |
Definition at line 176 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::SliderLength [protected] |
Definition at line 179 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::SliderWidth [protected] |
Definition at line 180 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::EndCapLength [protected] |
Definition at line 181 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::EndCapWidth [protected] |
Definition at line 182 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::TubeWidth [protected] |
Definition at line 183 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::CurrentT [protected] |
Definition at line 186 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::PickedT [protected] |
Definition at line 187 of file vtkSliderRepresentation.h.
int vtkSliderRepresentation::ShowSliderLabel [protected] |
Definition at line 190 of file vtkSliderRepresentation.h.
char* vtkSliderRepresentation::LabelFormat [protected] |
Definition at line 191 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::LabelHeight [protected] |
Definition at line 192 of file vtkSliderRepresentation.h.
double vtkSliderRepresentation::TitleHeight [protected] |
Definition at line 193 of file vtkSliderRepresentation.h.
The documentation for this class was generated from the following file:
- dox/Widgets/vtkSliderRepresentation.h
