collision_outline.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
**    Magnus Norddahl
**    James Wynn
**    Emanuel Greisen
*/


#pragma once

#include "../api_display.h"
#include <vector>
#include "contour.h"
#include "outline_accuracy.h"
#include "../Render/graphic_context.h"
#include "../../Core/Resources/resource.h"
#include "../../Core/Math/cl_math.h"
#include "../../Core/Math/origin.h"
#include "../../Core/Math/circle.h"
#include "../../Core/IOData/virtual_directory.h"

class CL_CollisionOutline_Generic;
class CL_ResourceManager;
class CL_PixelBufferRef;
class CL_OutputSourceProvider;
class CL_GraphicContext;
class CL_Color;

struct CL_CollisionPoint
{
        CL_Pointf point;

        CL_Pointf normal;

        bool is_entry;

        int contour1_line_start, contour2_line_start, contour1_line_end, contour2_line_end;
};

struct CL_CollidingContours
{
        const CL_Contour *contour1;
        const CL_Contour *contour2;
        bool inside;
        std::vector<CL_CollisionPoint> points;

        CL_Pointf penetration_normal;
        float penetration_depth;
        CL_Pointf contour1_deep_point;
        CL_Pointf contour2_deep_point;

        CL_CollidingContours(const CL_Contour *c1, const CL_Contour *c2, bool in=false) :
                contour1(c1),
                contour2(c2),
                inside(in),
                penetration_normal(0.0, 0.0),
                penetration_depth(0.0),
                contour1_deep_point(0.0, 0.0),
                contour2_deep_point(0.0, 0.0)
        {
                points.clear();
        }
};

class CL_API_DISPLAY CL_CollisionOutline
{
public:
        CL_CollisionOutline();

        CL_CollisionOutline(const CL_PixelBufferRef &pbuf, int alpha_limit=128, CL_OutlineAccuracy accuracy=accuracy_medium );

        CL_CollisionOutline(const CL_StringRef &fullname, int alpha_limit=128, CL_OutlineAccuracy accuracy=accuracy_medium, bool get_insides=true);

        CL_CollisionOutline(CL_IODevice &file, const CL_String &file_extension, int alpha_limit=128, CL_OutlineAccuracy accuracy=accuracy_medium, bool get_insides=true);

        CL_CollisionOutline(const CL_StringRef &filename, const CL_VirtualDirectory &directory, int alpha_limit=128, CL_OutlineAccuracy accuracy=accuracy_medium, bool get_insides=true);

        CL_CollisionOutline(const CL_StringRef &resource_id, CL_ResourceManager *manager );

        CL_CollisionOutline(std::vector<CL_Contour> contours, int width, int height);

        ~CL_CollisionOutline();

public:
        const CL_Contour &get_object_bounding_box() const;


        CL_Circlef get_minimum_enclosing_disc() const;

        bool get_inside_test() const;

        std::vector<CL_Contour> &get_contours();
        const std::vector<CL_Contour> &get_contours() const;

        CL_Pointf get_translation() const;

        CL_Pointf get_scale() const;

        float get_angle() const;

        unsigned int get_width() const;

        unsigned int get_height() const;

        void get_alignment( CL_Origin &origin, float &x, float &y ) const;

        void get_rotation_hotspot( CL_Origin &origin, float &x, float &y) const;

        const std::vector<CL_CollidingContours> &get_collision_info() const;

        void get_collision_info_state(bool &points, bool &normals, bool &metadata, bool &pendepth) const;

        CL_Resource resource;

public:
        void load(const CL_StringRef &fullname);

        void load(const CL_StringRef &filename, const CL_VirtualDirectory &directory);

        void load(CL_IODevice &file);

        CL_CollisionOutline &copy(const CL_CollisionOutline &other);

        void optimize( unsigned char check_distance=3, float corner_angle = CL_PI / 5.0 );

        void draw(
                float x,
                float y,
                const CL_Colorf &color,
                CL_GraphicContext &gc);

        void draw_sub_circles(
                float x,
                float y,
                const CL_Colorf &color,
                CL_GraphicContext &gc);

        void draw_smallest_enclosing_disc(
                float x,
                float y,
                const CL_Colorf &color,
                CL_GraphicContext &gc);

        void set_alignment( CL_Origin origin, float x=0, float y=0 );

        void set_rotation_hotspot( CL_Origin origin, float x=0, float y=0 );

        void set_translation( float x, float y );

        void set_scale( float x, float y );

        void set_angle(const CL_Angle &angle);

        void rotate(const CL_Angle &angle);

        void set_inside_test( bool value );

        void enable_collision_info( bool points=true, bool normals=false, bool metadata=false, bool pen_depth=false);

        void set_collision_info(const std::vector<CL_CollidingContours> &colinfo);

        void clean_collision_info();

        void calculate_radius();

        void calculate_sub_circles(float radius_multiplier=3.5);

        void calculate_smallest_enclosing_discs();

        void calculate_convex_hulls();

        void save(const CL_StringRef &fullname) const;

        void save(const CL_StringRef &filename, CL_VirtualDirectory &directory) const;

        void save(CL_IODevice &file) const;

        bool collide( const CL_CollisionOutline &outline, bool remove_old_collision_info=true );

        static void calculate_penetration_depth(std::vector<CL_CollidingContours> &collision_info);

        bool point_inside( const CL_Pointf &point ) const;

private:
        CL_SharedPtr<CL_CollisionOutline_Generic> impl;
};

---