axmol/cocos/ui/UISlider.h

325 lines
10 KiB
C
Raw Normal View History

2014-03-11 17:13:54 +08:00
/****************************************************************************
Copyright (c) 2013-2014 Chukong Technologies Inc.
http://www.cocos2d-x.org
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#ifndef __UISLIDER_H__
#define __UISLIDER_H__
#include "ui/UIWidget.h"
#include "ui/GUIExport.h"
2014-03-11 17:13:54 +08:00
NS_CC_BEGIN
2015-03-24 18:22:52 +08:00
/**
* @addtogroup ui
* @{
*/
2014-06-04 14:26:21 +08:00
class Sprite;
2014-03-11 17:13:54 +08:00
namespace ui {
2014-07-30 15:52:27 +08:00
class Scale9Sprite;
typedef enum
2014-03-11 17:13:54 +08:00
{
SLIDER_PERCENTCHANGED
}SliderEventType;
typedef void (Ref::*SEL_SlidPercentChangedEvent)(Ref*,SliderEventType);
2014-03-11 17:13:54 +08:00
#define sliderpercentchangedselector(_SELECTOR) (SEL_SlidPercentChangedEvent)(&_SELECTOR)
2015-03-24 18:22:52 +08:00
/** @class Slider
* @brief UI Slider widget.
* @js NA
* @lua NA
*/
class CC_GUI_DLL Slider : public Widget
2014-03-11 17:13:54 +08:00
{
DECLARE_CLASS_GUI_INFO
public:
2015-03-24 18:22:52 +08:00
/** EventType Slider event type.
*/
2014-05-12 11:17:06 +08:00
enum class EventType
{
ON_PERCENTAGE_CHANGED
};
typedef std::function<void(Ref*,EventType)> ccSliderCallback;
2014-03-11 17:13:54 +08:00
/**
2015-03-24 18:22:52 +08:00
* Default constructor.
2014-03-11 17:13:54 +08:00
*/
Slider();
/**
2015-03-24 18:22:52 +08:00
* Default destructor.
2014-03-11 17:13:54 +08:00
*/
virtual ~Slider();
2015-03-24 18:22:52 +08:00
/** Create a slider widget.
*
* @return An autoreleased Slider object.
2014-03-11 17:13:54 +08:00
*/
static Slider* create();
2015-03-24 18:22:52 +08:00
/** Create a slider widget with bar texture, ball texture and texture resource type.
*
* @param barTextureName Bar texture file name.
* @param normalBallTextureName Ball texture file name.
* @param resType Texture resource type.
* @return An autoreleased Slider object.
*/
2014-12-23 15:03:31 +08:00
static Slider* create(const std::string& barTextureName,
const std::string& normalBallTextureName,
TextureResType resType = TextureResType::LOCAL);
2014-03-11 17:13:54 +08:00
/**
* Load texture for slider bar.
*
2015-03-24 18:22:52 +08:00
* @param fileName File name of texture.
* @param resType @see TextureResType .
2014-03-11 17:13:54 +08:00
*/
2014-12-23 15:03:31 +08:00
void loadBarTexture(const std::string& fileName,TextureResType resType = TextureResType::LOCAL);
2014-03-11 17:13:54 +08:00
/**
* Sets if slider is using scale9 renderer.
2015-03-24 18:22:52 +08:00
* @param able True that using scale9 renderer, false otherwise.
2014-03-11 17:13:54 +08:00
*/
void setScale9Enabled(bool able);
2015-03-24 18:22:52 +08:00
/**
* Gets If slider is using scale9 renderer.
* @return True that using scale9 renderer, false otherwise.
*/
2014-05-27 10:52:30 +08:00
bool isScale9Enabled()const;
2014-03-11 17:13:54 +08:00
/**
* Sets capinsets for slider, if slider is using scale9 renderer.
2015-03-24 18:22:52 +08:00
* @param capInsets Capinsets for slider.
2014-03-11 17:13:54 +08:00
*/
void setCapInsets(const Rect &capInsets);
/**
2015-03-24 18:22:52 +08:00
* Sets capinsets for bar slider, if slider is using scale9 renderer.
* @param capInsets Capinsets for bar slider.
2014-03-11 17:13:54 +08:00
*/
void setCapInsetsBarRenderer(const Rect &capInsets);
2015-03-24 18:22:52 +08:00
/**
* Gets capinsets for bar slider, if slider is using scale9 renderer.
* @return capInsets Capinsets for bar slider.
*/
2014-05-27 10:52:30 +08:00
const Rect& getCapInsetsBarRenderer()const;
2014-03-11 17:13:54 +08:00
/**
2015-03-24 18:22:52 +08:00
* Sets capinsets for progress bar slider, if slider is using scale9 renderer.
* @param capInsets Capinsets for progress bar slider.
2014-03-11 17:13:54 +08:00
*/
void setCapInsetProgressBarRebderer(const Rect &capInsets);
2015-03-24 18:22:52 +08:00
/**
* Gets capinsets for progress bar slider, if slider is using scale9 renderer.
* @return Capinsets for progress bar slider.
*/
2014-05-27 10:52:30 +08:00
const Rect& getCapInsetsProgressBarRebderer()const;
2014-03-11 17:13:54 +08:00
/**
* Load textures for slider ball.
*
2015-03-24 18:22:52 +08:00
* @param normal Normal state texture.
* @param pressed Pressed state texture.
* @param disabled Disabled state texture.
* @param texType @see TextureResType .
2014-03-11 17:13:54 +08:00
*/
2014-04-03 15:33:57 +08:00
void loadSlidBallTextures(const std::string& normal,
2014-12-23 15:03:31 +08:00
const std::string& pressed = "",
const std::string& disabled = "",
TextureResType texType = TextureResType::LOCAL);
2014-03-11 17:13:54 +08:00
/**
* Load normal state texture for slider ball.
*
2015-03-24 18:22:52 +08:00
* @param normal Normal state texture.
* @param resType @see TextureResType .
2014-03-11 17:13:54 +08:00
*/
2014-12-23 15:03:31 +08:00
void loadSlidBallTextureNormal(const std::string& normal,TextureResType resType = TextureResType::LOCAL);
2014-03-11 17:13:54 +08:00
/**
2015-03-24 18:22:52 +08:00
* Load pressed state texture for slider ball.
2014-03-11 17:13:54 +08:00
*
2015-03-24 18:22:52 +08:00
* @param pressed Pressed state texture.
* @param resType @see TextureResType .
2014-03-11 17:13:54 +08:00
*/
2014-12-23 15:03:31 +08:00
void loadSlidBallTexturePressed(const std::string& pressed,TextureResType resType = TextureResType::LOCAL);
2014-03-11 17:13:54 +08:00
/**
2015-03-24 18:22:52 +08:00
* Load disabled state texture for slider ball.
2014-03-11 17:13:54 +08:00
*
2015-03-24 18:22:52 +08:00
* @param disabled Disabled state texture.
* @param resType @see TextureResType .
2014-03-11 17:13:54 +08:00
*/
2014-12-23 15:03:31 +08:00
void loadSlidBallTextureDisabled(const std::string& disabled,TextureResType resType = TextureResType::LOCAL);
2014-03-11 17:13:54 +08:00
/**
* Load dark state texture for slider progress bar.
*
2015-03-24 18:22:52 +08:00
* @param fileName File path of texture.
* @param resType @see TextureResType .
2014-03-11 17:13:54 +08:00
*/
2014-12-23 15:03:31 +08:00
void loadProgressBarTexture(const std::string& fileName, TextureResType resType = TextureResType::LOCAL);
2014-03-11 17:13:54 +08:00
/**
* Changes the progress direction of slider.
2015-03-24 18:22:52 +08:00
* @param percent Percent value from 1 to 100.
2014-03-11 17:13:54 +08:00
*/
void setPercent(int percent);
/**
* Gets the progress direction of slider.
*
2015-03-24 18:22:52 +08:00
* @return percent Percent value from 1 to 100.
2014-03-11 17:13:54 +08:00
*/
2014-05-27 10:52:30 +08:00
int getPercent()const;
2014-03-11 17:13:54 +08:00
/**
* Add call back function called when slider's percent has changed to slider.
2015-03-24 18:22:52 +08:00
*
* @param callback An given call back function called when slider's percent has changed to slider.
2014-03-11 17:13:54 +08:00
*/
2014-05-12 11:17:06 +08:00
CC_DEPRECATED_ATTRIBUTE void addEventListenerSlider(Ref* target,SEL_SlidPercentChangedEvent selector);
void addEventListener(const ccSliderCallback& callback);
2014-03-11 17:13:54 +08:00
virtual bool onTouchBegan(Touch *touch, Event *unusedEvent) override;
virtual void onTouchMoved(Touch *touch, Event *unusedEvent) override;
virtual void onTouchEnded(Touch *touch, Event *unusedEvent) override;
virtual void onTouchCancelled(Touch *touch, Event *unusedEvent) override;
2014-04-17 14:08:25 +08:00
//override "getVirtualRendererSize" method of widget.
2014-09-12 14:39:22 +08:00
virtual Size getVirtualRendererSize() const override;
2014-03-11 17:13:54 +08:00
//override "getVirtualRenderer" method of widget.
virtual Node* getVirtualRenderer() override;
//override "ignoreContentAdaptWithSize" method of widget.
virtual void ignoreContentAdaptWithSize(bool ignore) override;
//override the widget's hitTest function to perfom its own
Squashed commit of the following: commit a9572b8913f3a38b59adbd7b4017ab9848a6b2b5 Author: Ricardo Quesada <ricardoquesada@gmail.com> Date: Wed May 14 10:03:44 2014 -0700 math renames `Vector2` -> `Vec2` `Vector3` -> `Vec3` `Vector4` -> `Vec4` `Matrix` -> `Mat4` commit 4e107f4bd854c26bfceb52b063d6bd9cea02d6a3 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 09:24:28 2014 -0700 raw version of rename Vector3 commit 1d115573ebe96a5fc815fa44fbe6417ea7dba841 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 09:07:14 2014 -0700 rename Vector2 after merge commit ab2ed58c129dbc30a4c0970ed94568c5d271657b Merge: 1978d2d 86fb75a Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 09:05:30 2014 -0700 Merge branch 'v3' into v3_renameMathClassName Conflicts: tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UIButtonTest/UIButtonTest_Editor.cpp tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UICheckBoxTest/UICheckBoxTest_Editor.cpp tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UISliderTest/UISliderTest_Editor.cpp tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UITextFieldTest/UITextFieldTest.cpp tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UITextFieldTest/UITextFieldTest_Editor.cpp commit 1978d2d174877172ccddc083020a1bbf43ad3b39 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 08:51:45 2014 -0700 rename vector2 in tests/cpp-empty-test folder commit d4e0ff13dcce62724d2fece656543f26aa28e467 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:58:23 2014 -0700 rename vector2 in tests/cpp-tests cpp files commit be50ca2ec75e0fd32a6fcdaa15fe1ebb4cafe79f Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:52:57 2014 -0700 rename vector2 in tests/cpp-tests head files commit 6daef564400d4e28c4ce20859a68e0f583fed125 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:49:48 2014 -0700 rename vector2 in extension folder commit 8f3f0f65ceea92c9e7a0d87ab54e62220c5572e2 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:47:22 2014 -0700 rename vector2 in cocos/2d cpp files commit e1f3105aae06d595661a3030f519f7cc13aefbed Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:44:39 2014 -0700 rename vector2 in cocos/2d head files commit 6708d890bfe486109120c3cd4b9fe5c078b7108f Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:40:59 2014 -0700 rename vector2 in cocos/base folder commit d3978fa5447c31ea2f3ece5469b7e746dfba4248 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:40:43 2014 -0700 rename vector2 in cocos/deprecated folder commit 4bff45139363d6b9706edbbcf9f322d48b4fd019 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:40:26 2014 -0700 rename vector2 in cocos/editor-support folder commit 353d244c995f8b5d14f635c52aed8bc5e5fc1a6f Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:36:48 2014 -0700 rename vector2 in cocos/ui folder commit 758b8f4d513084b9922d7242e9b8f2c7f316de6c Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:32:39 2014 -0700 rename vector2 in cocos/renderer folder commit 0bd2710dd8714cecb993880bc37affd9ecb05c27 Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:32:15 2014 -0700 rename vector2 in cocos/physics folder commit b7f0581c4587348bdbc1478d5374c2325735f21d Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:25:01 2014 -0700 rename vector2 in cocos/math folder commit a8631a8e1a4e2740807ccd9be9d70de6ecaad7dd Author: Huabing.Xu <dabingnn@gmail.com> Date: Wed May 14 00:16:55 2014 -0700 rename Vector2 to Vec2 deprecate typedef Vector2
2014-05-15 01:07:09 +08:00
virtual bool hitTest(const Vec2 &pt) override;
2014-03-11 17:13:54 +08:00
/**
* Returns the "class name" of widget.
*/
virtual std::string getDescription() const override;
2014-12-23 15:03:31 +08:00
/** When user pressed the button, the button will zoom to a scale.
* The final scale of the button equals (button original scale + _zoomScale)
* @since v3.3
*/
void setZoomScale(float scale);
/**
* @brief Return a zoom scale
* @since v3.3
*/
float getZoomScale()const;
CC_CONSTRUCTOR_ACCESS:
virtual bool init() override;
2014-03-11 17:13:54 +08:00
protected:
virtual void initRenderer() override;
2014-05-27 10:52:30 +08:00
float getPercentWithBallPos(float location)const;
2014-03-11 17:13:54 +08:00
void percentChangedEvent();
virtual void onPressStateChangedToNormal() override;
virtual void onPressStateChangedToPressed() override;
virtual void onPressStateChangedToDisabled() override;
virtual void onSizeChanged() override;
2014-06-06 16:07:47 +08:00
2014-03-11 17:13:54 +08:00
void barRendererScaleChangedWithSize();
void progressBarRendererScaleChangedWithSize();
virtual Widget* createCloneInstance() override;
virtual void copySpecialProperties(Widget* model) override;
2014-04-17 14:08:25 +08:00
virtual void adaptRenderers() override;
2014-03-11 17:13:54 +08:00
protected:
2014-07-30 15:52:27 +08:00
Scale9Sprite* _barRenderer;
Scale9Sprite* _progressBarRenderer;
2015-01-20 20:57:54 +08:00
Size _barTextureSize;
2014-03-11 17:13:54 +08:00
Size _progressBarTextureSize;
Sprite* _slidBallNormalRenderer;
Sprite* _slidBallPressedRenderer;
Sprite* _slidBallDisabledRenderer;
Node* _slidBallRenderer;
float _barLength;
int _percent;
bool _scale9Enabled;
bool _prevIgnoreSize;
2014-12-23 15:03:31 +08:00
float _zoomScale;
float _sliderBallNormalTextureScaleX;
float _sliderBallNormalTextureScaleY;
2014-03-11 17:13:54 +08:00
std::string _textureFile;
std::string _progressBarTextureFile;
std::string _slidBallNormalTextureFile;
std::string _slidBallPressedTextureFile;
std::string _slidBallDisabledTextureFile;
Rect _capInsetsBarRenderer;
Rect _capInsetsProgressBarRenderer;
Ref* _sliderEventListener;
2014-05-12 11:17:06 +08:00
#if defined(__GNUC__) && ((__GNUC__ >= 4) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)))
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#elif _MSC_VER >= 1400 //vs 2005 or higher
#pragma warning (push)
#pragma warning (disable: 4996)
#endif
2014-03-11 17:13:54 +08:00
SEL_SlidPercentChangedEvent _sliderEventSelector;
2014-05-12 11:17:06 +08:00
#if defined(__GNUC__) && ((__GNUC__ >= 4) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)))
#pragma GCC diagnostic warning "-Wdeprecated-declarations"
#elif _MSC_VER >= 1400 //vs 2005 or higher
#pragma warning (pop)
#endif
ccSliderCallback _eventCallback;
2014-03-11 17:13:54 +08:00
TextureResType _barTexType;
TextureResType _progressBarTexType;
TextureResType _ballNTexType;
TextureResType _ballPTexType;
TextureResType _ballDTexType;
2014-04-17 14:08:25 +08:00
bool _barRendererAdaptDirty;
bool _progressBarRendererDirty;
2014-03-11 17:13:54 +08:00
};
}
2015-03-24 18:22:52 +08:00
// end of ui group
/// @}
2014-03-11 17:13:54 +08:00
NS_CC_END
#endif /* defined(__CocoGUI__Slider__) */