Click here to Skip to main content
15,896,497 members
Articles / Desktop Programming / Windows Forms

TurboSprite: A Simple 2D Sprite Engine for .NET Framework 2.0

Rate me:
Please Sign up or sign in to vote.
4.96/5 (26 votes)
26 May 2008BSD11 min read 76.3K   1.9K   82  
A simple, object-oriented 2D Sprite Engine for .NET 2.0.
#region copyright
/*
* Copyright (c) 2008, Dion Kurczek
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of the <organization> nor the
*       names of its contributors may be used to endorse or promote products
*       derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY DION KURCZEK ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL DION KURCZEK BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#endregion
using System;
using System.Collections.Generic;
using System.Text;
using System.Drawing;

namespace SCG.TurboSprite
{
    public class PolygonSprite : Sprite
    {
        //Public members

        //Construct a PolygonSprite with the specified array of points
        public PolygonSprite(params PointF[] points)
        {
            Points = points;
            _drawnPoints = new PointF[_points.Length];
            _unrotated = new PointF[_points.Length];
            _points.CopyTo(_unrotated, 0);
        }
        public PolygonSprite(params float[] values)
        {
            PointF[] points = new PointF[values.Length / 2];
            int i = 0;
            int idx = 0;
            while (i < values.Length)
            {
                points[idx].X = values[i++];
                points[idx++].Y = values[i++];
            }
            Points = points;
            _drawnPoints = new PointF[points.Length];
            _unrotated = new PointF[_points.Length];
            _points.CopyTo(_unrotated, 0);
        }

        //Access Points collection, allow it to change
        public PointF[] Points
        {
            get
            {
                return _points;
            }
            set
            {
                _points = value;

                //Set the shape of the sprite based on largest dimension from center
                float x1 = 0;
                float y1 = 0;
                float x2 = 0;
                float y2 = 0;
                foreach (PointF pt in _points)
                {
                    if (pt.X < x1)
                        x1 = pt.X;
                    if (pt.X > x2)
                        x2 = pt.X;
                    if (pt.Y < y1)
                        y1 = pt.Y;
                    if (pt.Y > y2)
                        y2 = pt.Y;
                }
                Shape = new RectangleF(x1, y1, x2 - x1, y2 - y1);              
            }
        }

        //Access line color
        public Color Color
        {
            get
            {
                return _color;
            }
            set
            {
                _color = value;
            }
        }

        //Access line width
        public int LineWidth
        {
            get
            {
                return _width;
            }
            set
            {
                _width = value;
            }
        }

        //Determine whether the Sprite is filled
        public bool IsFilled
        {
            get
            {
                return _filled;
            }
            set
            {
                _filled = value;
            }
        }

        //Access the fill color
        public Color FillColor
        {
            get
            {
                return _fillColor;
            }
            set
            {
                _fillColor = value;
            }
        }

        //Private members
        private PointF[] _points;
        private PointF[] _drawnPoints;
        private PointF[] _unrotated;
        private Color _color = Color.Red;
        private int _width;
        private bool _filled;
        private Color _fillColor = Color.Empty;
        private int _lastAngle;

        //Process the sprite on each animation cycle - handle rotation
        protected internal override void Process()
        {
            //Process rotation of shape
            if (FacingAngle != _lastAngle)
            {
                float sin = Sprite.Sin(FacingAngle);
                float cos = Sprite.Cos(FacingAngle);
                _lastAngle = FacingAngle;
                for (int p = 0; p < _points.Length; p++)
                {
                    _points[p].X = _unrotated[p].X * cos - _unrotated[p].Y * sin;
                    _points[p].Y = _unrotated[p].Y * cos + _unrotated[p].X * sin;
                }

                //This causes shape to be correctly recalculated
                Points = _points;
            }
        }

        //Render the sprite - draw the polygon
        protected internal override void Render(System.Drawing.Graphics g)
        {
            //Transform polygon into viewport coordinates
            for(int pt = 0; pt < _points.Length; pt++)
            {
                _drawnPoints[pt].X = _points[pt].X + X - Surface.OffsetX;
                _drawnPoints[pt].Y = _points[pt].Y + Y - Surface.OffsetY;
            }

            //Fill it?
            if (_filled)
            {
                Brush brush = new SolidBrush(_fillColor);
                using (brush)
                {
                    g.FillPolygon(brush, _drawnPoints);
                }
            }

            //Draw outline
            Pen pen = new Pen(_color, _width);
            using(pen)
            {
                g.DrawPolygon(pen, _drawnPoints);
            }
        }
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The BSD License


Written By
United States United States
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions