pen.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  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.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Harry Storbacka
*/


#pragma once

#include "../api_display.h"
#include "../../Core/System/sharedptr.h"

enum CL_PointSpriteOrigin
{
        cl_point_sprite_origin_upper_left,
        cl_point_sprite_origin_lower_left
};

class CL_Pen_Impl;

class CL_API_DISPLAY CL_Pen
{
public:
        CL_Pen();

        virtual ~CL_Pen();

public:
        float get_point_size() const;

        float get_max_point_size() const;

        float get_min_point_size() const;

        float get_point_fade_treshold_size() const;

        void get_point_distance_attenuation(float &a, float &b, float &c) const;

        bool is_point_antialiased() const;

        // Returns the line width.
        float get_line_width() const;

        unsigned short get_line_stipple_pattern() const;

        int get_line_stipple_repeat_count() const;

        bool is_line_stippled() const;

        bool is_line_antialiased() const;

        bool is_using_point_sprites() const;

        bool is_using_vertex_program_point_sizes() const;

        CL_PointSpriteOrigin get_point_sprite_origin() const;

public:
        void set_point_size(float);

        void set_max_point_size(float);

        void set_min_point_size(float);

        void set_point_fade_treshold_size(float);

        void set_point_distance_attenuation(float a, float b, float c);


        void enable_point_antialiasing(bool enabled);


        void set_line_width(float);


        void set_line_stipple_pattern(unsigned short);


        void set_line_stipple_repeat_count(int);


        void enable_line_stipple(bool enabled);


        void enable_line_antialiasing(bool enabled);

        void enable_point_sprite(bool enable);

        void enable_vertex_program_point_size(bool enable);

        void set_point_sprite_origin(CL_PointSpriteOrigin origin);

private:
        CL_SharedPtr<CL_Pen_Impl> impl;
};

---