vtkKWHSVColorSelector Class Reference

an HSV color selector More...

#include <vtkKWHSVColorSelector.h>

Inheritance diagram for vtkKWHSVColorSelector:

[legend]

Collaboration diagram for vtkKWHSVColorSelector:

[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	SetBalloonHelpString (const char *str)
virtual void	Update ()
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWHSVColorSelector *	New ()
static int	IsTypeOf (const char *type)
static vtkKWHSVColorSelector *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWHSVColorSelector ()
	~vtkKWHSVColorSelector ()
virtual void	CreateWidget ()
virtual void	InvokeCommandWithColor (const char *command, double h, double s, double v)
virtual void	InvokeSelectionChangedCommand (double h, double s, double v)
virtual void	InvokeSelectionChangingCommand (double h, double s, double v)
virtual void	Pack ()
virtual int	GetHueSatFromCoordinates (int x, int y, double &hue, double &sat)
virtual void	GetValueFromCoordinate (int y, double &value)
Protected Attributes
int	HueSatWheelRadius
int	HueSatCursorRadius
int	ValueBoxWidth
int	ValueCursorMargin
int	Selected
double	SelectedColor [3]
int	ModificationOnly
int	HideValue
double	PreviouslySelectedColor [3]
char *	SelectionChangedCommand
char *	SelectionChangingCommand
int	InvokeCommandsWithRGB
vtkKWCanvas *	HueSatWheelCanvas
vtkKWCanvas *	ValueBoxCanvas
vtkKWLabel *	HueSatLabel
vtkKWLabel *	ValueLabel
virtual void	SetHueSatWheelRadius (int)
virtual int	GetHueSatWheelRadius ()
virtual void	SetValueBoxWidth (int)
virtual int	GetValueBoxWidth ()
virtual void	SetHueSatCursorRadius (int)
virtual int	GetHueSatCursorRadius ()
virtual void	SetValueCursorMargin (int)
virtual int	GetValueCursorMargin ()
virtual double *	GetSelectedColor ()
virtual void	GetSelectedColor (double &, double &, double &)
virtual void	GetSelectedColor (double[3])
virtual void	SetSelectedColor (double h, double s, double v)
virtual void	SetSelectedColor (double hsv[3])
virtual void	ClearSelection ()
virtual int	HasSelection ()
virtual void	SetModificationOnly (int)
virtual int	GetModificationOnly ()
virtual void	ModificationOnlyOn ()
virtual void	ModificationOnlyOff ()
virtual void	SetHideValue (int)
virtual int	GetHideValue ()
virtual void	HideValueOn ()
virtual void	HideValueOff ()
virtual void	SetSelectionChangedCommand (vtkObject *object, const char *method)
virtual void	SetSelectionChangingCommand (vtkObject *object, const char *method)
virtual void	SetInvokeCommandsWithRGB (int)
virtual int	GetInvokeCommandsWithRGB ()
virtual void	InvokeCommandsWithRGBOn ()
virtual void	InvokeCommandsWithRGBOff ()
virtual vtkKWCanvas *	GetHueSatWheelCanvas ()
virtual vtkKWCanvas *	GetValueBoxCanvas ()
virtual void	HueSatPickCallback (int x, int y)
virtual void	HueSatMoveCallback (int x, int y)
virtual void	HueSatReleaseCallback ()
virtual void	ValuePickCallback (int x, int y)
virtual void	ValueMoveCallback (int x, int y)
virtual void	ValueReleaseCallback ()
virtual void	Bind ()
virtual void	UnBind ()
virtual void	Redraw ()
virtual void	RedrawHueSatWheelCanvas ()
virtual void	UpdateHueSatWheelImage ()
virtual void	UpdateHueSatWheelSelection ()
virtual void	RedrawValueBoxCanvas ()
virtual void	UpdateValueBoxImage ()
virtual void	UpdateValueBoxSelection ()

---

Detailed Description

an HSV color selector

A widget that allows the user choose a HSV color interactively

Definition at line 28 of file vtkKWHSVColorSelector.h.

---

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWHSVColorSelector::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 33 of file vtkKWHSVColorSelector.h.

---

Constructor & Destructor Documentation

vtkKWHSVColorSelector::vtkKWHSVColorSelector

(

)

[protected]

vtkKWHSVColorSelector::~vtkKWHSVColorSelector

(

)

[protected]

---

Member Function Documentation

static vtkKWHSVColorSelector* vtkKWHSVColorSelector::New

(

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual const char* vtkKWHSVColorSelector::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static int vtkKWHSVColorSelector::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWHSVColorSelector::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static vtkKWHSVColorSelector* vtkKWHSVColorSelector::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWHSVColorSelector::SetHueSatWheelRadius

(

int

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual int vtkKWHSVColorSelector::GetHueSatWheelRadius

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetValueBoxWidth

(

int

)

[virtual]

Set/Get the value box width in pixels.

virtual int vtkKWHSVColorSelector::GetValueBoxWidth

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetHueSatCursorRadius

(

int

)

[virtual]

Set/Get the radius of the selection cursor in the hue/sat wheel in pixels.

virtual int vtkKWHSVColorSelector::GetHueSatCursorRadius

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetValueCursorMargin

(

int

)

[virtual]

Set/Get the horizontal outer margin of the selection cursor in the value box in pixels.

virtual int vtkKWHSVColorSelector::GetValueCursorMargin

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual double* vtkKWHSVColorSelector::GetSelectedColor

(

)

[virtual]

Select/Deselect a color (in HSV space)

virtual void vtkKWHSVColorSelector::GetSelectedColor	(	double &	,
		double &	,
		double &
	)			[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::GetSelectedColor

(

double

[3]

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetSelectedColor	(	double	h,
		double	s,
		double	v
	)			[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetSelectedColor

(

double

hsv[3]

)

[inline, virtual]

Set/Get the hue/saturation wheel radius in pixels.

Definition at line 66 of file vtkKWHSVColorSelector.h.

virtual void vtkKWHSVColorSelector::ClearSelection

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual int vtkKWHSVColorSelector::HasSelection

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetModificationOnly

(

int

)

[virtual]

User can only modify the selection, it can not create a selection (i.e. pick a color) when nothing has been selected yet.

virtual int vtkKWHSVColorSelector::GetModificationOnly

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::ModificationOnlyOn

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::ModificationOnlyOff

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetHideValue

(

int

)

[virtual]

Hide the Value UI.

virtual int vtkKWHSVColorSelector::GetHideValue

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::HideValueOn

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::HideValueOff

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetSelectionChangedCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Specifies commands to associate with the widget. 'SelectionChangedCommand' is invoked when the selected color has changed (i.e. at the end of the user interaction). 'SelectionChangingCommand' is invoked when the selected color is changing (i.e. during the user interaction). The need for a '...ChangedCommand' and '...ChangingCommand' can be explained as follows: the former 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). The later 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 '...ChangedCommand' is enough to be notified about any changes, setting '...ChangingCommand' 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. 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: - selected HSV color: double, double, double Note that if InvokeCommandsWithRGB is true, the selected color is passed as RGB instead of HSV.

virtual void vtkKWHSVColorSelector::SetSelectionChangingCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetInvokeCommandsWithRGB

(

int

)

[virtual]

Set/Get if the commands should be invoked with RGB parameters instead of the current HSV value.

virtual int vtkKWHSVColorSelector::GetInvokeCommandsWithRGB

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::InvokeCommandsWithRGBOn

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::InvokeCommandsWithRGBOff

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::SetBalloonHelpString

(

const char *

str

)

[virtual]

Set the string that enables balloon help for this widget. Override to pass down to children.

Reimplemented from vtkKWWidget.

virtual vtkKWCanvas* vtkKWHSVColorSelector::GetHueSatWheelCanvas

(

)

[virtual]

Access to the canvas and internal elements

virtual vtkKWCanvas* vtkKWHSVColorSelector::GetValueBoxCanvas

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::Update

(

)

[virtual]

Update the whole UI depending on the value of the Ivars

virtual void vtkKWHSVColorSelector::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 vtkKWHSVColorSelector::HueSatPickCallback	(	int	x,
		int	y
	)			[virtual]

Callbacks. Internal, do not use.

virtual void vtkKWHSVColorSelector::HueSatMoveCallback	(	int	x,
		int	y
	)			[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::HueSatReleaseCallback

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::ValuePickCallback	(	int	x,
		int	y
	)			[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::ValueMoveCallback	(	int	x,
		int	y
	)			[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::ValueReleaseCallback

(

)

[virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWHSVColorSelector::InvokeCommandWithColor	(	const char *	command,
		double	h,
		double	s,
		double	v
	)			[protected, virtual]

virtual void vtkKWHSVColorSelector::InvokeSelectionChangedCommand	(	double	h,
		double	s,
		double	v
	)			[protected, virtual]

virtual void vtkKWHSVColorSelector::InvokeSelectionChangingCommand	(	double	h,
		double	s,
		double	v
	)			[protected, virtual]

virtual void vtkKWHSVColorSelector::Bind

(

)

[protected, virtual]

Bind/Unbind all components.

virtual void vtkKWHSVColorSelector::UnBind

(

)

[protected, virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::Pack

(

)

[protected, virtual]

Pack the widget

virtual void vtkKWHSVColorSelector::Redraw

(

)

[protected, virtual]

Redraw or update canvas elements

virtual void vtkKWHSVColorSelector::RedrawHueSatWheelCanvas

(

)

[protected, virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::UpdateHueSatWheelImage

(

)

[protected, virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::UpdateHueSatWheelSelection

(

)

[protected, virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::RedrawValueBoxCanvas

(

)

[protected, virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::UpdateValueBoxImage

(

)

[protected, virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual void vtkKWHSVColorSelector::UpdateValueBoxSelection

(

)

[protected, virtual]

Set/Get the hue/saturation wheel radius in pixels.

virtual int vtkKWHSVColorSelector::GetHueSatFromCoordinates	(	int	x,
		int	y,
		double &	hue,
		double &	sat
	)			[protected, virtual]

Get Hue/Sat given coordinates in Hue/Sat wheel image Return 1 if OK, 0 if coords were out of the wheel (i.e. sat was > 1.0)

virtual void vtkKWHSVColorSelector::GetValueFromCoordinate	(	int	y,
		double &	value
	)			[protected, virtual]

Get Value given coordinates in Value image

---

Member Data Documentation

int vtkKWHSVColorSelector::HueSatWheelRadius [protected]

Definition at line 165 of file vtkKWHSVColorSelector.h.

int vtkKWHSVColorSelector::HueSatCursorRadius [protected]

Definition at line 166 of file vtkKWHSVColorSelector.h.

int vtkKWHSVColorSelector::ValueBoxWidth [protected]

Definition at line 167 of file vtkKWHSVColorSelector.h.

int vtkKWHSVColorSelector::ValueCursorMargin [protected]

Definition at line 168 of file vtkKWHSVColorSelector.h.

int vtkKWHSVColorSelector::Selected [protected]

Definition at line 169 of file vtkKWHSVColorSelector.h.

double vtkKWHSVColorSelector::SelectedColor[3] [protected]

Definition at line 170 of file vtkKWHSVColorSelector.h.

int vtkKWHSVColorSelector::ModificationOnly [protected]

Definition at line 171 of file vtkKWHSVColorSelector.h.

int vtkKWHSVColorSelector::HideValue [protected]

Definition at line 172 of file vtkKWHSVColorSelector.h.

double vtkKWHSVColorSelector::PreviouslySelectedColor[3] [protected]

Definition at line 173 of file vtkKWHSVColorSelector.h.

char* vtkKWHSVColorSelector::SelectionChangedCommand [protected]

Definition at line 177 of file vtkKWHSVColorSelector.h.

char* vtkKWHSVColorSelector::SelectionChangingCommand [protected]

Definition at line 178 of file vtkKWHSVColorSelector.h.

int vtkKWHSVColorSelector::InvokeCommandsWithRGB [protected]

Definition at line 180 of file vtkKWHSVColorSelector.h.

vtkKWCanvas* vtkKWHSVColorSelector::HueSatWheelCanvas [protected]

Definition at line 188 of file vtkKWHSVColorSelector.h.

vtkKWCanvas* vtkKWHSVColorSelector::ValueBoxCanvas [protected]

Definition at line 189 of file vtkKWHSVColorSelector.h.

vtkKWLabel* vtkKWHSVColorSelector::HueSatLabel [protected]

Definition at line 190 of file vtkKWHSVColorSelector.h.

vtkKWLabel* vtkKWHSVColorSelector::ValueLabel [protected]

Definition at line 191 of file vtkKWHSVColorSelector.h.

---

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

• vtkKWHSVColorSelector.h