Arrow.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2016 Jan Haller
//
// 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 THOR_ARROW_HPP
#define THOR_ARROW_HPP

#include <Thor/Config.hpp>

#include <SFML/Graphics/Drawable.hpp>
#include <SFML/Graphics/Transformable.hpp>
#include <SFML/Graphics/ConvexShape.hpp>


namespace thor
{


class THOR_API Arrow : public sf::Drawable, public sf::Transformable
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public types
    public:
        enum Style
        {
            Line,       
            Forward,    
        };


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public static member functions
    public:
        static void                 setZeroVectorTolerance(float tolerance);

        static float                getZeroVectorTolerance();


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    Arrow(sf::Vector2f position = sf::Vector2f(), sf::Vector2f direction = sf::Vector2f(),
                                        const sf::Color& color = sf::Color::White, float thickness = 3.f);

        void                        setDirection(sf::Vector2f direction);

        void                        setDirection(float dirX, float dirY);

        sf::Vector2f                getDirection() const;

        void                        setThickness(float thickness);

        float                       getThickness() const;

        void                        setColor(const sf::Color& color);

        sf::Color                   getColor() const;

        void                        setStyle(Style style);

        Style                       getStyle() const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private member functions
    private:
        float                       getTriangleHeight() const;
        void                        adaptLine() const;
        void                        adaptTriangle() const;
        void                        draw(sf::RenderTarget& target, sf::RenderStates states) const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        float                       mThickness;
        float                       mLength;
        sf::Vector2f                mDirection;
        sf::Color                   mColor;
        Style                       mStyle;

        mutable bool                mNeedsShapeUpdate;
        mutable sf::ConvexShape     mLine;
        mutable sf::ConvexShape     mTriangle;

        static float                zeroVectorTolerance;

};


} // namespace thor

#endif // THOR_ARROW_HPP