CEGUI::ColourPickerControls Class Reference

Base class for the ColourPickerControls widget. More...

Inheritance diagram for CEGUI::ColourPickerControls:

Collaboration diagram for CEGUI::ColourPickerControls:

List of all members.

Public Types
enum	SliderMode {   SliderMode_Lab_L = 1, SliderMode_Lab_A = 1 << 1, SliderMode_Lab_B = 1 << 2, SliderMode_HSV_H = 1 << 3,   SliderMode_HSV_S = 1 << 4, SliderMode_HSV_V = 1 << 5 }
Public Member Functions
	ColourPickerControls (const String &type, const String &name)
	Constructor for ColourPickerControls class.
	~ColourPickerControls ()
	Destructor for ColourPickerControls class.
RGB_Colour	getSelectedColourRGB ()
void	setColours (const Colour &newColour)
	Set the current colour of the colour picker manually and refresh the ColourPickerControls elements accordingly.
void	setPreviousColour (const Colour &previousColour)
void	refreshAllElements ()
void	setCallingColourPicker (ColourPicker *colourPicker)
	Set the local d_callingColourPicker pointer to the colour picker window.
void	initialiseComponents ()
	Initialises the Window based object ready for use.
Static Public Attributes
static const String	EventNamespace
	Namespace for global events.
static const String	WidgetTypeName
	Window type name.
static const String	EventColourAccepted
static const String	EventClosed
Protected Member Functions
void	initColourPickerControlsImageSet ()
void	deinitColourPickerControlsTexture ()
void	refreshColourPickerControlsTextures ()
void	refreshColourSliderImage ()
void	refreshColourPickingImage ()
void	refreshAlphaSliderImage ()
void	reloadColourPickerControlsTexture ()
Lab_Colour	getColourSliderPositionColourLAB (float value)
Lab_Colour	getColourPickingPositionColourLAB (float xAbs, float yAbs)
HSV_Colour	getColourSliderPositionColourHSV (float value)
HSV_Colour	getColourPickingPositionColourHSV (float xAbs, float yAbs)
RGB_Colour	getAlphaSliderPositionColour (int x, int y)
Vector2f	getColourPickingColourPosition ()
void	getColourPickingColourPositionHSV (float &x, float &y)
bool	handleCancelButtonClicked (const EventArgs &e)
bool	handleAcceptButtonClicked (const EventArgs &e)
bool	handleEditboxDeactivated (const EventArgs &args)
bool	handleRadioButtonModeSelection (const EventArgs &args)
bool	handleHexadecimalEditboxTextChanged (const EventArgs &args)
bool	handleRGBEditboxTextChanged (const EventArgs &args)
bool	handleLABEditboxTextChanged (const EventArgs &args)
bool	handleHSVEditboxTextChanged (const EventArgs &args)
bool	handleAlphaEditboxTextChanged (const EventArgs &args)
bool	handleColourPickerStaticImageMouseLeaves (const EventArgs &args)
bool	handleColourPickerStaticImageMouseButtonUp (const EventArgs &args)
bool	handleColourPickerStaticImageMouseButtonDown (const EventArgs &args)
bool	handleColourPickerStaticImageMouseMove (const EventArgs &args)
virtual void	onCancelButtonClicked (WindowEventArgs &e)
virtual void	onAcceptButtonClicked (WindowEventArgs &e)
void	onColourCursorPositionChanged ()
void	onColourSliderChanged ()
void	refreshColourPickerCursorPosition (const MouseEventArgs &mouseEventArgs)
void	refreshAlpha ()
void	refreshOnlyColourSliderImage ()
bool	handleColourPickerSliderValueChanged (const EventArgs &args)
bool	handleAlphaSliderValueChanged (const EventArgs &args)
void	refreshEditboxesAndColourRects ()
void	refreshColourRects ()
void	positionColourPickerCursorAbsolute (float x, float y)
void	positionColourPickerCursorRelative (float x, float y)
void	setColours (const Lab_Colour &newColourLAB)
void	setColours (const RGB_Colour &newColourRGB)
void	setColours (const HSV_Colour &newColourHSV)
void	setColourAlpha (float alphaValue)
void	refreshColourPickerCursorPosition ()
void	refreshColourSliderPosition ()
void	initColourPicker ()
PushButton *	getCancelButton ()
PushButton *	getAcceptButton ()
Window *	getHexadecimalDescription ()
Editbox *	getHexadecimalEditbox ()
Titlebar *	getTitleBar ()
Slider *	getColourPickerImageSlider ()
Slider *	getColourPickerAlphaSlider ()
Window *	getColourPickerStaticImage ()
Window *	getNewColourDescription ()
Window *	getOldColourDescription ()
Window *	getNewColourRect ()
Window *	getOldColourRect ()
Window *	getColourEditBoxRDescription ()
Window *	getColourEditBoxGDescription ()
Window *	getColourEditBoxBDescription ()
Editbox *	getColourEditBoxR ()
Editbox *	getColourEditBoxG ()
Editbox *	getColourEditBoxB ()
RadioButton *	getHSVRadioButtonH ()
RadioButton *	getHSVRadioButtonS ()
RadioButton *	getHSVRadioButtonV ()
Editbox *	getHSVEditBoxH ()
Editbox *	getHSVEditBoxS ()
Editbox *	getHSVEditBoxV ()
RadioButton *	getLabRadioButtonL ()
RadioButton *	getLabRadioButtonA ()
RadioButton *	getLabRadioButtonB ()
Editbox *	getLabEditBoxL ()
Editbox *	getLabEditBoxA ()
Editbox *	getLabEditBoxB ()
Editbox *	getAlphaEditBox ()
Window *	getColourPickerCursorStaticImage ()
Protected Attributes
ColourPicker *	d_callingColourPicker
Window *	d_colourPickerCursor
SliderMode	d_sliderMode
Colour	d_selectedColour
	selected colour of the ColourPickerControls as CEGUI colour
RGB_Colour	d_selectedColourRGB
Lab_Colour	d_selectedColourLAB
HSV_Colour	d_selectedColourHSV
Colour	d_previouslySelectedColour
	Previously selected colour of the ColourPickerControls.
TextureTarget *	d_colourPickerControlsTextureTarget
int	d_colourPickerImageOffset
int	d_colourPickerPickingImageHeight
int	d_colourPickerPickingImageWidth
int	d_colourPickerColourSliderImageWidth
int	d_colourPickerColourSliderImageHeight
int	d_colourPickerAlphaSliderImageWidth
int	d_colourPickerAlphaSliderImageHeight
int	d_colourPickerControlsTextureSize
bool	d_draggingColourPickerCursor
RGB_Colour *	d_colourPickingTexture
bool	d_ignoreEvents
RegexMatcher &	d_regexMatcher
Static Protected Attributes
static const String	CancelButtonName
	Widget name for the cancel button component.
static const String	AcceptButtonName
	Widget name for the accept button component.
static const String	HexaDecimalDescriptionName
	Widget name for the static text label of the hexadecimal colour value EditBox.
static const String	HexaDecimalEditBoxName
	Widget name for the colour value EditBox.
static const String	TitleBarName
static const String	ColourPickerStaticImageName
static const String	ColourPickerImageSliderName
static const String	ColourPickerAlphaSliderName
static const String	NewColourDescriptionName
static const String	OldColourDescriptionName
static const String	NewColourRectName
static const String	OldColourRectName
static const String	ColourEditBoxRDescriptionName
static const String	ColourEditBoxGDescriptionName
static const String	ColourEditBoxBDescriptionName
static const String	ColourEditBoxRName
static const String	ColourEditBoxGName
static const String	ColourEditBoxBName
static const String	HSVRadioButtonHName
static const String	HSVRadioButtonSName
static const String	HSVRadioButtonVName
static const String	HSVEditBoxHName
static const String	HSVEditBoxSName
static const String	HSVEditBoxVName
static const String	LabRadioButtonLName
static const String	LabRadioButtonAName
static const String	LabRadioButtonBName
static const String	LabEditBoxLName
static const String	LabEditBoxAName
static const String	LabEditBoxBName
static const String	AlphaEditBoxName
static const String	ColourPickerCursorName
static const String	ColourPickerControlsPickingTextureImageName
	Name of the Picking Texture Image in the ImageSet.
static const String	ColourPickerControlsColourSliderTextureImageName
	Name of the Slider Texture Image in the ImageSet.
static const String	ColourPickerControlsAlphaSliderTextureImageName
	Name of the Slider Texture Image in the ImageSet.
static const String	ColourRectPropertyName
	Name of the colour defining ColourRectProperty of ColourRect windows.
static const float	LAB_L_MIN
static const float	LAB_L_MAX
static const float	LAB_L_DIFF
static const float	LAB_A_MIN
static const float	LAB_A_MAX
static const float	LAB_A_DIFF
static const float	LAB_B_MIN
static const float	LAB_B_MAX
static const float	LAB_B_DIFF

---

Detailed Description

Base class for the ColourPickerControls widget.

---

Constructor & Destructor Documentation

CEGUI::ColourPickerControls::~ColourPickerControls

(

)

Destructor for ColourPickerControls class.

Namespace for global events

---

Member Function Documentation

void CEGUI::ColourPickerControls::initialiseComponents

(

void

)

[virtual]

Initialises the Window based object ready for use.

Note:

This must be called for every window created. Normally this is handled automatically by the WindowManager.

Returns:

Nothing

Reimplemented from CEGUI::Window.

void CEGUI::ColourPickerControls::setCallingColourPicker

(

ColourPicker *

colourPicker

)

Set the local d_callingColourPicker pointer to the colour picker window.

Parameters:

setting

colourPicker the ColourPicker window.

void CEGUI::ColourPickerControls::setColours

(

const Colour &

newColour

)

Set the current colour of the colour picker manually and refresh the ColourPickerControls elements accordingly.

Parameters:

setting

newColour the selected Colour for the ColourPickerControls

---

Member Data Documentation

HSV_Colour CEGUI::ColourPickerControls::d_selectedColourHSV [protected]

selected colour of the ColourPickerControls as HSV_Colour (Each component as float)

Lab_Colour CEGUI::ColourPickerControls::d_selectedColourLAB [protected]

selected colour of the ColourPickerControls as Lab_Colour (Each component as float)

RGB_Colour CEGUI::ColourPickerControls::d_selectedColourRGB [protected]

selected colour of the ColourPickerControls as RGB_Colour (Each colour component as unsigned char 0 - 255)

const String CEGUI::ColourPickerControls::EventColourAccepted [static]

Event fired when the button is clicked. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the PushButton that was clicked.