vtkSliderRepresentation Class Reference

abstract class defines the representation for a vtkSliderWidget More...

#include <vtkSliderRepresentation.h>

Inheritance diagram for vtkSliderRepresentation:

Collaboration diagram for vtkSliderRepresentation:

Public Types
enum	_InteractionState {   Outside =0, Tube, LeftCap, RightCap,   Slider }
Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass
Public Types inherited from vtkProp
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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 ()
Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PickingManagedOn ()
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool)
virtual bool	GetPickingManaged ()
virtual void	SetRenderer (vtkRenderer *ren)
virtual vtkRenderer *	GetRenderer ()
virtual void	BuildRepresentation ()=0
virtual void	PlaceWidget (double *vtkNotUsed(bounds[6]))
virtual void	StartWidgetInteraction (double eventPos[2])
virtual void	WidgetInteraction (double newEventPos[2])
virtual void	EndWidgetInteraction (double newEventPos[2])
virtual int	ComputeInteractionState (int X, int Y, int modify=0)
virtual int	GetInteractionState ()
virtual void	Highlight (int vtkNotUsed(highlightOn))
virtual void	SetPlaceFactor (double)
virtual double	GetPlaceFactor ()
virtual void	SetHandleSize (double)
virtual double	GetHandleSize ()
virtual int	GetNeedToRender ()
virtual void	SetNeedToRender (int)
virtual void	NeedToRenderOn ()
virtual void	NeedToRenderOff ()
virtual double *	GetBounds ()
virtual void	ShallowCopy (vtkProp *prop)
virtual void	GetActors (vtkPropCollection *)
virtual void	GetActors2D (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual int	RenderOverlay (vtkViewport *vtkNotUsed(viewport))
virtual int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int	HasTranslucentPolygonalGeometry ()
vtkWidgetRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Pick ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
virtual void	BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void	SetVisibility (int)
virtual int	GetVisibility ()
virtual void	VisibilityOn ()
virtual void	VisibilityOff ()
virtual void	SetPickable (int)
virtual int	GetPickable ()
virtual void	PickableOn ()
virtual void	PickableOff ()
virtual void	SetDragable (int)
virtual int	GetDragable ()
virtual void	DragableOn ()
virtual void	DragableOff ()
virtual unsigned long	GetRedrawMTime ()
virtual void	SetUseBounds (bool)
virtual bool	GetUseBounds ()
virtual void	UseBoundsOn ()
virtual void	UseBoundsOff ()
virtual void	InitPathTraversal ()
virtual vtkAssemblyPath *	GetNextPath ()
virtual int	GetNumberOfPaths ()
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkMatrix4x4 *	GetMatrix ()
virtual vtkInformation *	GetPropertyKeys ()
virtual void	SetPropertyKeys (vtkInformation *keys)
virtual int	RenderOpaqueGeometry (vtkViewport *)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *)
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double	GetEstimatedRenderTime (vtkViewport *)
virtual double	GetEstimatedRenderTime ()
virtual void	SetEstimatedRenderTime (double t)
virtual void	RestoreEstimatedRenderTime ()
virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double	GetAllocatedRenderTime ()
void	SetRenderTimeMultiplier (double t)
virtual double	GetRenderTimeMultiplier ()
virtual bool	GetSupportsSelection ()
virtual int	GetNumberOfConsumers ()
void	AddConsumer (vtkObject *c)
void	RemoveConsumer (vtkObject *c)
vtkObject *	GetConsumer (int i)
int	IsConsumer (vtkObject *c)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Protected Member Functions
	vtkSliderRepresentation ()
	~vtkSliderRepresentation ()
Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()
	~vtkWidgetRepresentation ()
void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])
virtual void	RegisterPickers ()
virtual void	UnRegisterPickers ()
virtual void	PickersModified ()
vtkPickingManager *	GetPickingManager ()
double	SizeHandlesRelativeToViewport (double factor, double pos[3])
double	SizeHandlesInPixels (double factor, double pos[3])
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
Protected Member Functions inherited from vtkProp
	vtkProp ()
	~vtkProp ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

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
Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer >	Renderer
int	InteractionState
double	StartEventPosition [3]
double	PlaceFactor
int	Placed
double	InitialBounds [6]
double	InitialLength
int	ValidPick
bool	PickingManaged
double	HandleSize
int	NeedToRender
vtkTimeStamp	BuildTime
Protected Attributes inherited from vtkProp
int	Visibility
int	Pickable
int	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkWidgetRepresentation	Superclass
static int	IsTypeOf (const char *type)
static vtkSliderRepresentation *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkSliderRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Static Public Member Functions inherited from vtkWidgetRepresentation
static int	IsTypeOf (const char *type)
static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Detailed Description

abstract class defines the representation for a vtkSliderWidget

This 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

Events:

vtkCommand::WidgetValueChangedEvent

Examples:

vtkSliderRepresentation (Examples)

Tests:

vtkSliderRepresentation (Tests)

Definition at line 44 of file vtkSliderRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkSliderRepresentation::Superclass

Standard methods for the class.

Definition at line 49 of file vtkSliderRepresentation.h.

Member Enumeration Documentation

enum vtkSliderRepresentation::_InteractionState

Enumerator
Outside
Tube
LeftCap
RightCap
Slider

Definition at line 160 of file vtkSliderRepresentation.h.

Constructor & Destructor Documentation

vtkSliderRepresentation::vtkSliderRepresentation ( )

protected

vtkSliderRepresentation::~vtkSliderRepresentation ( )

protected

Member Function Documentation

static int vtkSliderRepresentation::IsTypeOf ( const char *  type )

static

Standard methods for the class.

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 ( vtkObjectBase *  o )

static

Standard methods for the class.

virtual vtkObjectBase* vtkSliderRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCenteredSliderRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.

vtkSliderRepresentation* vtkSliderRepresentation::NewInstance

(

)

const

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkObject.

Reimplemented in 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 *  )

inlinevirtual

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, vtkSliderRepresentation3D, and vtkSliderRepresentation2D.

Definition at line 117 of file vtkSliderRepresentation.h.

virtual const char* vtkSliderRepresentation::GetTitleText ( )

inlinevirtual

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, vtkSliderRepresentation3D, and vtkSliderRepresentation2D.

Definition at line 118 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 ( )

inlinevirtual

Methods to interface with the vtkSliderWidget. Subclasses of this class actually do something.

Definition at line 152 of file vtkSliderRepresentation.h.

virtual double vtkSliderRepresentation::GetPickedT ( )

inlinevirtual

Methods to interface with the vtkSliderWidget. Subclasses of this class actually do something.

Definition at line 154 of file vtkSliderRepresentation.h.

Member Data Documentation

double vtkSliderRepresentation::Value

protected

Definition at line 175 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::MinimumValue

protected

Definition at line 176 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::MaximumValue

protected

Definition at line 177 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::SliderLength

protected

Definition at line 180 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::SliderWidth

protected

Definition at line 181 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::EndCapLength

protected

Definition at line 182 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::EndCapWidth

protected

Definition at line 183 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::TubeWidth

protected

Definition at line 184 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::CurrentT

protected

Definition at line 187 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::PickedT

protected

Definition at line 188 of file vtkSliderRepresentation.h.

int vtkSliderRepresentation::ShowSliderLabel

protected

Definition at line 191 of file vtkSliderRepresentation.h.

char* vtkSliderRepresentation::LabelFormat

protected

Definition at line 192 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::LabelHeight

protected

Definition at line 193 of file vtkSliderRepresentation.h.

double vtkSliderRepresentation::TitleHeight

protected

Definition at line 194 of file vtkSliderRepresentation.h.

---

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

• dox/Interaction/Widgets/vtkSliderRepresentation.h