wLineStyleComponent.hpp

Go to the documentation of this file.

/*
+---------------------------------------------------------------------------------------------------------------------------------------------------+
Created by Wilfried Koch.
Copyright @ 2025 Wilfried Koch. All rights reserved.
+---------------------------------------------------------------------------------------------------------------------------------------------------+
*/
 
#ifndef W_LINE_STYLE_COMPONENT_HPP
#define W_LINE_STYLE_COMPONENT_HPP
 
#include "../srcEntity/wComponent.hpp"
 
namespace wEngine
{

    class LineStyleComponent : public Component
    {
        public:
            enum class LineStyle
            {
                Solid,
                Dotted,
                Dashed
            };

            LineStyleComponent( LineStyle style = LineStyle::Solid );
 
            /*
             * @brief Virtual destructor.
             */
            virtual ~LineStyleComponent( ) = default;

            [[nodiscard]] LineStyle getStyle( ) const;

            void setStyle( LineStyle style );

            [[nodiscard]] float getDashLength( ) const;

            void setDashLength( float dashLength );

            [[nodiscard]] float getGapLength( ) const;

            void setGapLength( float gapLength );
 
            /*
             * @brief Outputs the current style and parameters to the console.
             */
            void debugPrint( ) const;
        private:
            LineStyle mStyle;
            float mDashLength;
            float mGapLength;
    };
 
}//End of namespace wEngine
 
#endif