//********************************** Banshee Engine (www.banshee3d.com) **************************************************// //**************** Copyright (c) 2016 Marko Pintera (marko.pintera@gmail.com). All rights reserved. **********************// #pragma once #include "BsScriptEditorPrerequisites.h" #include "GUI/BsGUIElementContainer.h" namespace bs { /** @addtogroup SBansheeEditor * @{ */ /** * GUI object that displays a field in which a Texture can be dragged and dropped. The field accepts a Texture of a * specific type and displays an optional label. If texture is referenced its image is displayed in the field. */ class BS_SCR_BED_EXPORT GUITextureField : public GUIElementContainer { struct PrivatelyConstruct {}; public: /** Returns type name of the GUI element used for finding GUI element styles. */ static const String& getGUITypeName(); /** * Creates a new texture GUI editor field with a label. * * @param[in] labelContent Content to display in the editor field label. * @param[in] labelWidth Width of the label in pixels. * @param[in] options Options that allow you to control how is the element positioned and sized. This will * override any similar options set by style. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const GUIContent& labelContent, UINT32 labelWidth, const GUIOptions& options, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field with a label. * * @param[in] labelContent Content to display in the editor field label. * @param[in] options Options that allow you to control how is the element positioned and sized. This will * override any similar options set by style. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const GUIContent& labelContent, const GUIOptions& options, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field with a label. * * @param[in] labelText Text to display in the editor field label. * @param[in] labelWidth Width of the label in pixels. * @param[in] options Options that allow you to control how is the element positioned and sized. This will * override any similar options set by style. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const HString& labelText, UINT32 labelWidth, const GUIOptions& options, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field with a label. * * @param[in] labelText Text to display in the editor field label. * @param[in] options Options that allow you to control how is the element positioned and sized. This will * override any similar options set by style. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const HString& labelText, const GUIOptions& options, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field without a label. * * @param[in] options Options that allow you to control how is the element positioned and sized. This will * override any similar options set by style. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const GUIOptions& options, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field with a label. * * @param[in] labelContent Content to display in the editor field label. * @param[in] labelWidth Width of the label in pixels. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const GUIContent& labelContent, UINT32 labelWidth, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field with a label. * * @param[in] labelContent Content to display in the editor field label. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const GUIContent& labelContent, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field with a label. * * @param[in] labelText Text to display in the editor field label. * @param[in] labelWidth Width of the label in pixels. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const HString& labelText, UINT32 labelWidth, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field with a label. * * @param[in] labelText Text to display in the editor field label. * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const HString& labelText, const String& style = StringUtil::BLANK); /** * Creates a new texture GUI editor field without a label. * * @param[in] style Optional style to use for the element. Style will be retrieved from GUISkin of the * GUIWidget the element is used on. If not specified default style is used. */ static GUITextureField* create(const String& style = StringUtil::BLANK); GUITextureField(const PrivatelyConstruct& dummy, const GUIContent& labelContent, UINT32 labelWidth, const String& style, const GUIDimensions& dimensions, bool withLabel); /** Returns the texture referenced by the field, if any. This will load the texture if it is not already loaded. */ HTexture getValue() const; /** Sets the texture referenced by the field. */ void setValue(const HTexture& value); /** Returns a weak reference to the texture referenced by the field, if any. */ WeakResourceHandle getValueWeak() const; /** Sets a weak reference to the texture referenced by the field. */ void setValueWeak(const WeakResourceHandle& value); /** Returns the texture referenced by the field. Returns empty string with no texture is referenced. */ UUID getUUID() const { return mUUID; } /** @copydoc GUIElement::setTint */ void setTint(const Color& color) override; /** @copydoc GUIElement::_updateLayoutInternal */ void _updateLayoutInternal(const GUILayoutData& data) override; /** @copydoc GUIElement::_getOptimalSize */ Vector2I _getOptimalSize() const override; /** * Triggered whenever the referenced texture changes. Provides a weak handle to the resource, or empty handle if no * texture is referenced. */ Event&)> onValueChanged; private: virtual ~GUITextureField(); /** @copydoc GUIElement::styleUpdated */ void styleUpdated() override; /** * Sets the texture referenced by the field by finding the texture with the provided UUID. * * @param[in] uuid Unique resource identifier of the texture to show, or empty string if no texture. * @param[in] triggerEvent Determines should the onValueChanged() event be triggered if the new UUID is * different from the previous one. */ void setUUID(const UUID& uuid, bool triggerEvent = true); /** Triggered when a drag and drop operation finishes over this element. */ void dataDropped(void* data); /** Triggered when the drop button that displays the game object label is clicked. */ void onDropButtonClicked(); /** Triggered when the clear button is clicked. */ void onClearButtonClicked(); private: static const UINT32 DEFAULT_LABEL_WIDTH; GUILayout* mLayout; GUILabel* mLabel; GUIDropButton* mDropButton; GUIButton* mClearButton; UUID mUUID; }; /** @} */ }