irrlicht/src/CGUISkin.h

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#pragma once

#include "IGUISkin.h"
#include "irrString.h"

namespace irr
{
namespace video
{
class IVideoDriver;
}
namespace gui
{

class CGUISkin : public IGUISkin
{
public:
	CGUISkin(EGUI_SKIN_TYPE type, video::IVideoDriver *driver);

	//! destructor
	virtual ~CGUISkin();

	//! returns default color
	video::SColor getColor(EGUI_DEFAULT_COLOR color) const override;

	//! sets a default color
	void setColor(EGUI_DEFAULT_COLOR which, video::SColor newColor) override;

	//! returns size for the given size type
	s32 getSize(EGUI_DEFAULT_SIZE size) const override;

	//! sets a default size
	void setSize(EGUI_DEFAULT_SIZE which, s32 size) override;

	//! returns the default font
	IGUIFont *getFont(EGUI_DEFAULT_FONT which = EGDF_DEFAULT) const override;

	//! sets a default font
	void setFont(IGUIFont *font, EGUI_DEFAULT_FONT which = EGDF_DEFAULT) override;

	//! sets the sprite bank used for drawing icons
	void setSpriteBank(IGUISpriteBank *bank) override;

	//! gets the sprite bank used for drawing icons
	IGUISpriteBank *getSpriteBank() const override;

	//! Returns a default icon
	/** Returns the sprite index within the sprite bank */
	u32 getIcon(EGUI_DEFAULT_ICON icon) const override;

	//! Sets a default icon
	/** Sets the sprite index used for drawing icons like arrows,
	close buttons and ticks in checkboxes
	\param icon: Enum specifying which icon to change
	\param index: The sprite index used to draw this icon */
	void setIcon(EGUI_DEFAULT_ICON icon, u32 index) override;

	//! Returns a default text.
	/** For example for Message box button captions:
	"OK", "Cancel", "Yes", "No" and so on. */
	const wchar_t *getDefaultText(EGUI_DEFAULT_TEXT text) const override;

	//! Sets a default text.
	/** For example for Message box button captions:
	"OK", "Cancel", "Yes", "No" and so on. */
	void setDefaultText(EGUI_DEFAULT_TEXT which, const wchar_t *newText) override;

	//! draws a standard 3d button pane
	/** Used for drawing for example buttons in normal state.
	It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and
	EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
	\param rect: Defining area where to draw.
	\param clip: Clip area.
	\param element: Pointer to the element which wishes to draw this. This parameter
	is usually not used by ISkin, but can be used for example by more complex
	implementations to find out how to draw the part exactly. */
	virtual void draw3DButtonPaneStandard(IGUIElement *element,
			const core::rect<s32> &rect,
			const core::rect<s32> *clip = 0) override;

	//! draws a pressed 3d button pane
	/** Used for drawing for example buttons in pressed state.
	It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and
	EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
	\param rect: Defining area where to draw.
	\param clip: Clip area.
	\param element: Pointer to the element which wishes to draw this. This parameter
	is usually not used by ISkin, but can be used for example by more complex
	implementations to find out how to draw the part exactly. */
	virtual void draw3DButtonPanePressed(IGUIElement *element,
			const core::rect<s32> &rect,
			const core::rect<s32> *clip = 0) override;

	//! draws a sunken 3d pane
	/** Used for drawing the background of edit, combo or check boxes.
	\param element: Pointer to the element which wishes to draw this. This parameter
	is usually not used by ISkin, but can be used for example by more complex
	implementations to find out how to draw the part exactly.
	\param bgcolor: Background color.
	\param flat: Specifies if the sunken pane should be flat or displayed as sunken
	deep into the ground.
	\param rect: Defining area where to draw.
	\param clip: Clip area.	*/
	virtual void draw3DSunkenPane(IGUIElement *element,
			video::SColor bgcolor, bool flat,
			bool fillBackGround,
			const core::rect<s32> &rect,
			const core::rect<s32> *clip = 0) override;

	//! draws a window background
	/** Used for drawing the background of dialogs and windows.
	\param element: Pointer to the element which wishes to draw this. This parameter
	is usually not used by ISkin, but can be used for example by more complex
	implementations to find out how to draw the part exactly.
	\param titleBarColor: Title color.
	\param drawTitleBar: True to enable title drawing.
	\param rect: Defining area where to draw.
	\param clip: Clip area.
	\param checkClientArea: When set to non-null the function will not draw anything,
	but will instead return the clientArea which can be used for drawing by the calling window.
	That is the area without borders and without titlebar.
	\return Returns rect where it would be good to draw title bar text. This will
	work even when checkClientArea is set to a non-null value.*/
	virtual core::rect<s32> draw3DWindowBackground(IGUIElement *element,
			bool drawTitleBar, video::SColor titleBarColor,
			const core::rect<s32> &rect,
			const core::rect<s32> *clip,
			core::rect<s32> *checkClientArea) override;

	//! draws a standard 3d menu pane
	/** Used for drawing for menus and context menus.
	It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and
	EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
	\param element: Pointer to the element which wishes to draw this. This parameter
	is usually not used by ISkin, but can be used for example by more complex
	implementations to find out how to draw the part exactly.
	\param rect: Defining area where to draw.
	\param clip: Clip area.	*/
	virtual void draw3DMenuPane(IGUIElement *element,
			const core::rect<s32> &rect,
			const core::rect<s32> *clip = 0) override;

	//! draws a standard 3d tool bar
	/** Used for drawing for toolbars and menus.
	\param element: Pointer to the element which wishes to draw this. This parameter
	is usually not used by ISkin, but can be used for example by more complex
	implementations to find out how to draw the part exactly.
	\param rect: Defining area where to draw.
	\param clip: Clip area.	*/
	virtual void draw3DToolBar(IGUIElement *element,
			const core::rect<s32> &rect,
			const core::rect<s32> *clip = 0) override;

	//! draws a tab button
	/** Used for drawing for tab buttons on top of tabs.
	\param element: Pointer to the element which wishes to draw this. This parameter
	is usually not used by ISkin, but can be used for example by more complex
	implementations to find out how to draw the part exactly.
	\param active: Specifies if the tab is currently active.
	\param rect: Defining area where to draw.
	\param clip: Clip area.	*/
	virtual void draw3DTabButton(IGUIElement *element, bool active,
			const core::rect<s32> &rect, const core::rect<s32> *clip = 0,
			EGUI_ALIGNMENT alignment = EGUIA_UPPERLEFT) override;

	//! draws a tab control body
	/** \param element: Pointer to the element which wishes to draw this. This parameter
	is usually not used by ISkin, but can be used for example by more complex
	implementations to find out how to draw the part exactly.
	\param border: Specifies if the border should be drawn.
	\param background: Specifies if the background should be drawn.
	\param rect: Defining area where to draw.
	\param clip: Clip area.	*/
	virtual void draw3DTabBody(IGUIElement *element, bool border, bool background,
			const core::rect<s32> &rect, const core::rect<s32> *clip = 0, s32 tabHeight = -1,
			EGUI_ALIGNMENT alignment = EGUIA_UPPERLEFT) override;

	//! draws an icon, usually from the skin's sprite bank
	/** \param element: Pointer to the element which wishes to draw this icon.
	This parameter is usually not used by IGUISkin, but can be used for example
	by more complex implementations to find out how to draw the part exactly.
	\param icon: Specifies the icon to be drawn.
	\param position: The position to draw the icon
	\param starttime: The time at the start of the animation
	\param currenttime: The present time, used to calculate the frame number
	\param loop: Whether the animation should loop or not
	\param clip: Clip area.	*/
	virtual void drawIcon(IGUIElement *element, EGUI_DEFAULT_ICON icon,
			const core::position2di position,
			u32 starttime = 0, u32 currenttime = 0,
			bool loop = false, const core::rect<s32> *clip = 0) override;

	//! draws a 2d rectangle.
	/** \param element: Pointer to the element which wishes to draw this icon.
	This parameter is usually not used by IGUISkin, but can be used for example
	by more complex implementations to find out how to draw the part exactly.
	\param color: Color of the rectangle to draw. The alpha component specifies how
	transparent the rectangle will be.
	\param pos: Position of the rectangle.
	\param clip: Pointer to rectangle against which the rectangle will be clipped.
	If the pointer is null, no clipping will be performed. */
	virtual void draw2DRectangle(IGUIElement *element, const video::SColor &color,
			const core::rect<s32> &pos, const core::rect<s32> *clip = 0) override;

	//! get the type of this skin
	EGUI_SKIN_TYPE getType() const override;

private:
	video::SColor Colors[EGDC_COUNT];
	s32 Sizes[EGDS_COUNT];
	u32 Icons[EGDI_COUNT];
	IGUIFont *Fonts[EGDF_COUNT];
	IGUISpriteBank *SpriteBank;
	core::stringw Texts[EGDT_COUNT];
	video::IVideoDriver *Driver;
	bool UseGradient;

	EGUI_SKIN_TYPE Type;
};

} // end namespace gui
} // end namespace irr