vtkKWExtent Class Reference

six sliders defining a (xmin,xmax,ymin,ymax,zmin,zmax) extent More...

#include <vtkKWExtent.h>

Inheritance diagram for vtkKWExtent:

[legend]

Collaboration diagram for vtkKWExtent:

[legend]

List of all members.

Public Types
typedef vtkKWCompositeWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWExtent *	New ()
static int	IsTypeOf (const char *type)
static vtkKWExtent *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWExtent ()
	~vtkKWExtent ()
virtual void	CreateWidget ()
virtual void	InvokeExtentCommand (const char *command, double x0, double x1, double y0, double y1, double z0, double z1)
virtual void	InvokeCommand (double x0, double x1, double y0, double y1, double z0, double z1)
virtual void	InvokeStartCommand (double x0, double x1, double y0, double y1, double z0, double z1)
virtual void	InvokeEndCommand (double x0, double x1, double y0, double y1, double z0, double z1)
virtual void	Pack ()
Protected Attributes
char *	Command
char *	StartCommand
char *	EndCommand
double	Extent [6]
vtkKWRange *	Range [3]
int	ExtentVisibility [3]
enum	{ ChangeEvent = 10000, StartChangeEvent = 10001, EndChangeEvent = 10002 }
virtual void	SetExtentRange (const double extent[6])
virtual void	SetExtentRange (double, double, double, double, double, double)
virtual double *	GetExtentRange ()
virtual void	GetExtentRange (double &, double &, double &, double &, double &, double &)
virtual void	GetExtentRange (double extent[6])
virtual double *	GetExtent ()
virtual void	GetExtent (double &, double &, double &, double &, double &, double &)
virtual void	GetExtent (double[6])
virtual void	SetExtent (const double extent[6])
virtual void	SetExtent (double, double, double, double, double, double)
virtual void	SetExtentVisibility (int index, int arg)
virtual void	XExtentVisibilityOn ()
virtual void	XExtentVisibilityOff ()
virtual int	GetXExtentVisibility ()
virtual void	SetXExtentVisibility (int arg)
virtual void	YExtentVisibilityOn ()
virtual void	YExtentVisibilityOff ()
virtual int	GetYExtentVisibility ()
virtual void	SetYExtentVisibility (int arg)
virtual void	ZExtentVisibilityOn ()
virtual void	ZExtentVisibilityOff ()
virtual int	GetZExtentVisibility ()
virtual void	SetZExtentVisibility (int arg)
virtual void	SetCommand (vtkObject *object, const char *method)
virtual void	SetStartCommand (vtkObject *object, const char *method)
virtual void	SetEndCommand (vtkObject *object, const char *method)
virtual void	SetDisableCommands (int)
virtual void	DisableCommandsOn ()
virtual void	DisableCommandsOff ()
virtual void	SetOrientation (int)
virtual void	SetOrientationToHorizontal ()
virtual void	SetOrientationToVertical ()
virtual void	SetLabelPosition (int)
virtual void	SetLabelPositionToDefault ()
virtual void	SetLabelPositionToTop ()
virtual void	SetLabelPositionToBottom ()
virtual void	SetLabelPositionToLeft ()
virtual void	SetLabelPositionToRight ()
virtual void	SetEntry1Position (int)
virtual void	SetEntry1PositionToDefault ()
virtual void	SetEntry1PositionToTop ()
virtual void	SetEntry1PositionToBottom ()
virtual void	SetEntry1PositionToLeft ()
virtual void	SetEntry1PositionToRight ()
virtual void	SetEntry2Position (int)
virtual void	SetEntry2PositionToDefault ()
virtual void	SetEntry2PositionToTop ()
virtual void	SetEntry2PositionToBottom ()
virtual void	SetEntry2PositionToLeft ()
virtual void	SetEntry2PositionToRight ()
virtual void	SetThickness (int)
virtual void	SetInternalThickness (double)
virtual void	SetRequestedLength (int)
virtual void	SetSliderSize (int)
virtual void	SetSliderCanPush (int)
virtual void	SliderCanPushOn ()
virtual void	SliderCanPushOff ()
vtkKWRange *	GetXRange ()
vtkKWRange *	GetYRange ()
vtkKWRange *	GetZRange ()
vtkKWRange *	GetRange (int index)
virtual void	RangeCommandCallback (double r0, double r1)
virtual void	RangeStartCommandCallback (double r0, double r1)
virtual void	RangeEndCommandCallback (double r0, double r1)
virtual void	RangeEntriesCommandCallback (double r0, double r1)

---

Detailed Description

six sliders defining a (xmin,xmax,ymin,ymax,zmin,zmax) extent

vtkKWExtent is a widget containing six sliders which represent the xmin, xmax, ymin, ymax, zmin, zmax extent of a volume. It is a convinience object and has logic to keep the min values less than or equal to the max values.

Definition at line 30 of file vtkKWExtent.h.

---

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWExtent::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 35 of file vtkKWExtent.h.

---

Member Enumeration Documentation

anonymous enum

Events. The events are triggered when the extent slider is changed. BTX

Enumerator:

ChangeEvent
StartChangeEvent
EndChangeEvent

Definition at line 114 of file vtkKWExtent.h.

---

Constructor & Destructor Documentation

vtkKWExtent::vtkKWExtent

(

)

[protected]

vtkKWExtent::~vtkKWExtent

(

)

[protected]

---

Member Function Documentation

static vtkKWExtent* vtkKWExtent::New

(

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual const char* vtkKWExtent::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static int vtkKWExtent::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWExtent::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static vtkKWExtent* vtkKWExtent::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCompositeWidget.

void vtkKWExtent::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWExtent::SetExtentRange

(

const double

extent[6]

)

[virtual]

Set the Range of the Extent, this is the range of acceptable values for the sliders. Specified as minx maxx miny maxy minz maxz

virtual void vtkKWExtent::SetExtentRange	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual double* vtkKWExtent::GetExtentRange

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::GetExtentRange	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::GetExtentRange

(

double

extent[6]

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual double* vtkKWExtent::GetExtent

(

)

[virtual]

Set/Get the Extent.

virtual void vtkKWExtent::GetExtent	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::GetExtent

(

double

[6]

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetExtent

(

const double

extent[6]

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetExtent	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetExtentVisibility	(	int	index,
		int	arg
	)			[virtual]

Set/Get the visibility of the extent selectively (x, y, z).

virtual void vtkKWExtent::XExtentVisibilityOn

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::XExtentVisibilityOff

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual int vtkKWExtent::GetXExtentVisibility

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 60 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetXExtentVisibility

(

int

arg

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 61 of file vtkKWExtent.h.

virtual void vtkKWExtent::YExtentVisibilityOn

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::YExtentVisibilityOff

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual int vtkKWExtent::GetYExtentVisibility

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 64 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetYExtentVisibility

(

int

arg

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 65 of file vtkKWExtent.h.

virtual void vtkKWExtent::ZExtentVisibilityOn

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::ZExtentVisibilityOff

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual int vtkKWExtent::GetZExtentVisibility

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 68 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetZExtentVisibility

(

int

arg

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 69 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Specifies commands to associate with the widget. 'Command' is invoked when the widget value is changing (i.e. during user interaction). 'StartCommand' is invoked at the beginning of a user interaction with the widget (when a mouse button is pressed over the widget for example). 'EndCommand' is invoked at the end of the user interaction with the widget (when the mouse button is released for example). The need for a 'Command', 'StartCommand' and 'EndCommand' can be explained as follows: 'EndCommand' can be used to be notified about any changes made to this widget *after* the corresponding user interaction has been performed (say, after releasing the mouse button that was dragging a slider, or after clicking on a checkbutton). 'Command' can be set *additionally* to be notified about the intermediate changes that occur *during* the corresponding user interaction (say, *while* dragging a slider). While setting 'EndCommand' is enough to be notified about any changes, setting 'Command' is an application-specific choice that is likely to depend on how fast you want (or can) answer to rapid changes occuring during a user interaction, if any. 'StartCommand' is rarely used but provides an opportunity for the application to modify its state and prepare itself for user-interaction; in that case, the 'EndCommand' is usually set in a symmetric fashion to set the application back to its previous state. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the command: - the current extent: int, int, int, int, int, int (if the Resolution of all the visible ranges are integer); double, double, double, double, double, double otherwise. Note: the 'int' signature is for convenience, so that the command can be set to a callback accepting 'int'. In doubt, implement the callback using a 'double' signature that will accept both 'int' and 'double'.

virtual void vtkKWExtent::SetStartCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetEndCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetDisableCommands

(

int

)

[virtual]

Set/Get whether the above commands should be called or not.

virtual void vtkKWExtent::DisableCommandsOn

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::DisableCommandsOff

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetOrientation

(

int

)

[virtual]

Set the ranges orientations and item positions. This just propagates the same method to the internal ranges.

virtual void vtkKWExtent::SetOrientationToHorizontal

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 133 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetOrientationToVertical

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 135 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetLabelPosition

(

int

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetLabelPositionToDefault

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 138 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetLabelPositionToTop

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 140 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetLabelPositionToBottom

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 142 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetLabelPositionToLeft

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 144 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetLabelPositionToRight

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 146 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry1Position

(

int

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetEntry1PositionToDefault

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 149 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry1PositionToTop

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 151 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry1PositionToBottom

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 153 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry1PositionToLeft

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 155 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry1PositionToRight

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 157 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry2Position

(

int

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetEntry2PositionToDefault

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 160 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry2PositionToTop

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 162 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry2PositionToBottom

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 164 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry2PositionToLeft

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 166 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetEntry2PositionToRight

(

)

[inline, virtual]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 168 of file vtkKWExtent.h.

virtual void vtkKWExtent::SetThickness

(

int

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetInternalThickness

(

double

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetRequestedLength

(

int

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetSliderSize

(

int

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SetSliderCanPush

(

int

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SliderCanPushOn

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::SliderCanPushOff

(

)

[virtual]

Events. The events are triggered when the extent slider is changed. BTX

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

vtkKWRange* vtkKWExtent::GetXRange

(

)

[inline]

Access the internal vtkKWRange's.

Definition at line 188 of file vtkKWExtent.h.

vtkKWRange* vtkKWExtent::GetYRange

(

)

[inline]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 189 of file vtkKWExtent.h.

vtkKWRange* vtkKWExtent::GetZRange

(

)

[inline]

Events. The events are triggered when the extent slider is changed. BTX

Definition at line 190 of file vtkKWExtent.h.

vtkKWRange* vtkKWExtent::GetRange

(

int

index

)

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::RangeCommandCallback	(	double	r0,
		double	r1
	)			[virtual]

Callbacks. Internal, do not use.

virtual void vtkKWExtent::RangeStartCommandCallback	(	double	r0,
		double	r1
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::RangeEndCommandCallback	(	double	r0,
		double	r1
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::RangeEntriesCommandCallback	(	double	r0,
		double	r1
	)			[virtual]

Events. The events are triggered when the extent slider is changed. BTX

virtual void vtkKWExtent::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWExtent::InvokeExtentCommand	(	const char *	command,
		double	x0,
		double	x1,
		double	y0,
		double	y1,
		double	z0,
		double	z1
	)			[protected, virtual]

virtual void vtkKWExtent::InvokeCommand	(	double	x0,
		double	x1,
		double	y0,
		double	y1,
		double	z0,
		double	z1
	)			[protected, virtual]

virtual void vtkKWExtent::InvokeStartCommand	(	double	x0,
		double	x1,
		double	y0,
		double	y1,
		double	z0,
		double	z1
	)			[protected, virtual]

virtual void vtkKWExtent::InvokeEndCommand	(	double	x0,
		double	x1,
		double	y0,
		double	y1,
		double	z0,
		double	z1
	)			[protected, virtual]

virtual void vtkKWExtent::Pack

(

)

[protected, virtual]

---

Member Data Documentation

char* vtkKWExtent::Command [protected]

Definition at line 211 of file vtkKWExtent.h.

char* vtkKWExtent::StartCommand [protected]

Definition at line 212 of file vtkKWExtent.h.

char* vtkKWExtent::EndCommand [protected]

Definition at line 213 of file vtkKWExtent.h.

double vtkKWExtent::Extent[6] [protected]

Definition at line 225 of file vtkKWExtent.h.

vtkKWRange* vtkKWExtent::Range[3] [protected]

Definition at line 227 of file vtkKWExtent.h.

int vtkKWExtent::ExtentVisibility[3] [protected]

Definition at line 229 of file vtkKWExtent.h.

---

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

• vtkKWExtent.h