Sprite.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2020 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
 
#ifndef TGUI_SPRITE_HPP
#define TGUI_SPRITE_HPP
 
#include <TGUI/Texture.hpp>
#include <TGUI/Vector2f.hpp>
#include <TGUI/FloatRect.hpp>
#include <TGUI/Color.hpp>
#include <TGUI/Aurora/SmartPtr/CopiedPtr.hpp>
#include <SFML/Graphics/Transformable.hpp>
#include <SFML/Graphics/RenderStates.hpp>
#include <SFML/Graphics/Vertex.hpp>
 
 
namespace tgui
{
 
 class TGUI_API Sprite : public sf::Transformable
 {
 public:
 
 enum class ScalingType
 {
 Normal, 
 Horizontal, 
 Vertical, 
 NineSlice 
 };
 
 
 public:
 
 
 Sprite() = default;
 
 
 Sprite(const Texture& texture);
 
 
 void setTexture(const Texture& texture);
 
 
 const Texture& getTexture() const;
 
#ifndef TGUI_NEXT
 Texture& getTexture();
#endif
 
 bool isSet() const;
 
 
 void setSize(const Vector2f& size);
 
 
 Vector2f getSize() const;
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
 TGUI_DEPRECATED("Color should be changed through the texture") void setColor(const Color& color);
 
 
 TGUI_DEPRECATED("Color should be changed through the texture") const Color& getColor() const;
#endif
 
 virtual void setOpacity(float opacity);
 
 
 float getOpacity() const;
 
 
 void setVisibleRect(const FloatRect& visibleRect);
 
 
 FloatRect getVisibleRect() const;
 
 
 bool isTransparentPixel(Vector2f pos) const;
 
 
 ScalingType getScalingType() const;
 
 
 void draw(sf::RenderTarget& target, sf::RenderStates states) const;
 
 
 private:
 
 // Update the location of the vertices
 void updateVertices();
 
 
 private:
 
 Vector2f m_size;
 Texture m_texture;
 aurora::CopiedPtr<sf::Texture> m_svgTexture;
 std::vector<sf::Vertex> m_vertices;
 
 FloatRect m_visibleRect;
 
 sf::Shader* m_shader = nullptr;
 Color m_vertexColor = Color::White;
 float m_opacity = 1;
 
 ScalingType m_scalingType = ScalingType::Normal;
 };
 
}
 
 
#endif // TGUI_SPRITE_HPP