Click here to Skip to main content
15,867,568 members
Articles / Desktop Programming / WPF

UniPolygon: Universal Polygon

Rate me:
Please Sign up or sign in to vote.
4.90/5 (19 votes)
26 May 2011CPOL8 min read 38.4K   924   33   13
The article suggests the implementation of the figure of universal polygon UniPolygon. Construction of rich graphics of your user interface has become even easier in both WPF and Silverlight.

Contents

Introduction 

Universal polygon – why do we need it? The answer to this question could begin with a simple listing of tasks that it solves: rendering of rounding polygons with vertices in accordance with some rule of dynamic positioning. Why not? Standard solution of such tasks is usually reduced to the creation of Bezier curves, the vertices of which are computed by binding and converters. This solution is rather laborious and often requires not only complex and lengthy manipulations in the declarative code, but also a backspacing to imperative programming. But what is to be done, if you need to change the radii of curvature for all at once polygon vertices, or at least for one only? I would remind you that a cubic curve is defined by four vertices, while quadratic one is by three. One must be very careful, so that the curve did not “break down” as long as guiding lines of adjacent segments must pass along one line from the point of the joint. But what is to be done, if a vertex needs to be moved, and the curvature must remain unchanged? And if you change the curvature without changing vertices? And what if both of them are in a proportional relationship? And what if a natural circle, not a parabola, is needed, as a part of the curve? Amateur programmers act simply – they give a static picture. "This is not our way. We shall go another way!"(© V.I.Lenin) This will be considered further.

Implementation

In the previous section, there were formulated two basic objectives of universal polygons: rounding of the corners and their dynamic positioning. In the static form, this task can be settled by the definition of each polygon vertex with three values: two coordinates and a radius. In the dynamics, all the three values are divided into three more components: absolute value and three relative ones – horizontal and vertical values from zero to one. Of these nine values, as a rule, only seven are needed, and it is not always (rarely are needed such rules when the relative horizontal component should affect the vertical absolute value, or, the relative vertical value should affect the horizontal absolute value). At the moment of forming polygon figure, the polygon vertex is calculated as follows:

(xabs. + xrel.hor.•width + xrel.ver.•height, yabs. + yrel.hor.•width + yrel.ver.•height, rabs. + rrel.hor.•width + rrel.ver.•height),

Here:

  • xabs., yabs., rabs. – absolute components by coordinates and radius (range [-8,+8]);
  • xrel.hor., yrel.hor., rrel.hor. – relative components by coordinates and radius in projection on the horizontal axis (range [0,1]);
  • xrel.ver., yrel.ver., rrel.ver. – relative components by coordinates and radius in projection on the vertical axis (range [0,1]).

It is understood that the negative values of the radius cause confusion, therefore I would immediately mention, that the plus sign indicates the necessity to build a segment of the circle, iterating the vertices of the figure in the direct order, but the minus sign indicates the reverse order. The current implementation is such that ultimately the result is the same (thereby this information is rather familiarizing than practical).

Below there is a part of the signature of UniPoint class, which implements the vertices of the universal polygon UniPolygon. Properties with suffix “0” specify absolute values; properties with suffixes “w” and “h” specify relative values in width and height accordingly.

C#
public class UniPoint : 
    DependencyObject, INotifyPropertyChanged {
    //  . . .
    public double X0 { get; set; }
    public double Y0 { get; set; }
    public double R0 { get; set; }
    public double Xw { get; set; }
    public double Yw { get; set; }
    public double Rw { get; set; }
    public double Xh { get; set; }
    public double Yh { get; set; }
    public double Rh { get; set; }
    //  . . .
    public override string ToString();
    public static UniPoint Parse(string s);

Listed in the signature properties of the object UniPoint are dependency properties and they cover data binding.

In order to simplify XAML markup, the conversions of string values into objects of UniPoint type and vice versa are provided. The format of strings is as follows: X0[, Xw[, Xh]]; Y0[, Yh[, Yw]][; R0[, Rw[, Rh]]] [;;]. In square brackets, there are optional parameters. Particular emphasis is placed on the fact that relative components on the vertical axis are in reverse order: first by height and then by width: Y0[, Yh[, Yw]]. It is done in order to reduce markup records, since it is rarely necessary to specify the dependence of the vertical values on the width of the object; and to indicate zeros each time only in order to point then the height factor is not rational.

It should also be told about separators. As it can be seen, the absolute values are separated from the relative ones by commas; the values on X, Y and radius R are delimited by a semicolon. If used regional settings are such that the decimal delimiter contains a comma, then the separator between the absolute and relative values is now taken as a semicolon, and the separator between X, Y and radius R will be a pipe symbol «|». If it turns out that the decimal delimiter contains a symbol of semicolon, then the separators will be a pipe symbol «|» and a diesis sign «#». To put it in simple words, the logics can be expressed in a chain of characters «.,;|#», in which there is a shift from the left side to the right one in case of coincidence of a character from the left side and the symbol of the decimal delimiter of regional settings.

UniPoint vertices are placed in the UniPointCollection, which also covers conversion of string values into the collection and vice versa. Below there is a part of the signature of this class:

C#
public sealed class UniPointCollection :
ObservableCollection<UniPoint> {
//  . . .
public override string ToString();
public string ToString(IFormatProvider tProvider, string sFormat);
public static UniPointCollection Parse(string s);
public static UniPointCollection Parse(IFormatProvider tProvider, string s);

Displaying of UniPoint vertices of UniPointCollection lies entirely on the UniPolygon class. Its concise signature is given below:

C#
public sealed class UniPolygon : Shape {
//  . . .
public UniPointCollection Points { get; set; }
public double DefaultRadiusIn { get; set; }
public double DefaultRadiusOut { get; set; }
public double Offset { get; set; }
public bool IsClosed { get; set; }

Let's consider its properties.

PropertyDescription
PointsCollection of polygon vertices.
DefaultRadiusInRadius by default for the interior angles of the polygon. Default is 0.
DefaultRadiusOutRadius by default for the exterior angles of the polygon. Default is 0.
OffsetIndent from the boundaries of the polygon. Positive values increase the size of the figure, while negative ones decrease it. Default is 0.
IsClosedClosure of the figure. Defines the need to connect the first and the last points of the polygon. Default is true.
GeometryReturns Geometry object of polygon; can be used to create composite shapes, particularly of the cut areas.

If the fillet radius is not explicitly indicated for the polygon vertex, then there are used radii given by DefaultRadiusIn and DefaultRadiusOut properties by default. If the radius is too big to enter the circle into the polygon corner, then the rounding of the corner is not performed.

Application

Lunching the program, attached to the article, we will see the window similar to the following:

Screenshot: UniPolygon in action

Almost all the figures of this window are the objects of the universal polygon UniPolygon. Exceptions are the circles of the buttons to minimize and to close the window and a few rectangles. But even these exceptions could have been avoided, if it would be rational for the specific task. Take note when resizing the window, its constituent elements are subordinate to certain rules. The buttons to minimize and close the window are always located in the upper right corner and have a fixed size; the radii of rounding of the window polygon are also fixed and do not stretch or shrink as you resize the window, which certainly would be marked at the use of Bezier curves as a base figure. Note also that the head size and the leg thickness of the bull figure and the thickness of the hare’s paws are not changed when their total size changes. To achieve a similar effect by means of standard WPF graphics would not be easy, but here one figure is determined by only one XAML element.

On the picture above, there is something which looks like a shadow of the hare. This effect can be achieved by creating CombinedGeometry object with settled property GeometryCombineMode=”Exclude”, and with bound Geometry2 property to the property UniPolygon.Geometry of the hare polygon.

XML
<Path
  x:Name="x_tPlgHareGhost"
  Fill="LightBlue" Stroke="Aqua" Opacity="0.3"
  HorizontalAlignment="Right" Margin="20,113,25,45"
>
  <Path.Data>
    <CombinedGeometry
      GeometryCombineMode="Exclude"
      Geometry2="{Binding ElementName=m_tPlgHare, Path=Geometry}">
      <CombinedGeometry.Geometry1>
        <RectangleGeometry Rect="0,0,100,900"></RectangleGeometry>
      </CombinedGeometry.Geometry1>
    </CombinedGeometry>
  </Path.Data>
</Path>

A simple example will demonstrate the use of UniPlygon object. Let's create a pentagon as a rectangle, the upper side of which is curved slightly inwards, and define the radii of curvature. This kind of object can be defined by markup of XAML-code similar to the following:

XML
<b:UniPolygon
  x:Name="m_tPlg1"
  Points="
    50;           50      ;;
     0,  0.5;     75      ;;
  -100,    1;     50      ;;
  -100,    1;     -100,0,1;;
    50,    1;     -100,0,1;;
  "
  DefaultRadiusIn="50"
  DefaultRadiusOut="150"
  Stroke="YellowGreen" 
  Stretch="None"
  Margin="0"
  Offset="0"
  IsClosed="False"
  StrokeThickness="5.01">
  <b:UniPolygon.Fill>
    <SolidColorBrush Color="Yellow" Opacity="0.4"/>
  </b:UniPolygon.Fill>
</b:UniPolygon>

Absolutely the same shape can be defined with a slightly different markup, its collection of polygon nodes is not already determined by a string value, but by a set of UniPoint elements, the first two of which have explicitly defined parameters, and the last three are specified by a string value. The form of writing applied for the first two vertices is more appropriate when there is need to bind values with some data.

XML
<b:UniPolygon
  x:Name="m_tPlg2"
  DefaultRadiusIn="50"
  DefaultRadiusOut="150"
  Stroke="YellowGreen" 
  Offset="0"
  IsClosed="False"
  StrokeThickness="5.01">
  <b:UniPolygon.Points>
    <b:UniPoint X0="50" Y0="50"/>
    <b:UniPoint Xw="0.5" Y0="75"/>
    <b:UniPoint> -100,    1;   50        </b:UniPoint>
    <b:UniPoint> -100,    1; -100, 0,  1 </b:UniPoint>
    <b:UniPoint>   50      ; -100, 0,  1 </b:UniPoint>
  </b:UniPolygon.Points>
  <b:UniPolygon.Fill>
    <SolidColorBrush Color="Yellow" Opacity="0.4"/>
  </b:UniPolygon.Fill>
</b:UniPolygon>

Now let's create a figure which repeats the previous one, but which has a size of 8 units fewer than the first one. For this, we will bind the Points property of the new figure and the old one, and determine Offset indent from the polygon outline with value “-4”:

XML
<b:UniPolygon
  x:Name="m_tOP2"
  Points="{Binding ElementName=m_tOP1, Path=Points}"
  StrokeThickness="0.1"
  Offset="-4">
  <b:UniPolygon.Fill>
    <LinearGradientBrush Opacity="0.8">
      <GradientStop Color="LightGray" Offset="0"/>
      <GradientStop Color="Snow" Offset=".75" />
      <GradientStop Color="LightGray" Offset="1" />
    </LinearGradientBrush>
  </b:UniPolygon.Fill>
</b:UniPolygon>

As a result, there are two parallel figures. On the picture above, the result is represented by a curved inwards at the top rectangle of olive green with bright green contour.

For those of you who wanted to use UniPlygon in imperative code, here is a sample:

C#
var t = new UniPolygon();
t.ToolTip = "This figure was programmed\nin imperative code.";
t.DefaultRadiusIn = 3;
t.StrokeThickness = 2;
t.Fill = Brushes.BlanchedAlmond;
t.Stroke = Brushes.BlueViolet;
t.Opacity = 0.5;
t.Points.Add(new UniPoint(0, 0, 20, 0));
t.Points.Add(new UniPoint(X0: 20, Y0: 20));
t.Points.Add(new UniPoint(X0: 20, Y0: 35, R0: 10));
t.Points.Add(new UniPoint(X0: 40, Y0: 35, R0: 10));
t.Points.Add(new UniPoint(X0: 40, Y0: 20));
t.Points.Add(new UniPoint(X0: -10, Xw: 0.5, Y0: 20));
t.Points.Add(new UniPoint(X0: 21, Xw: 0.5, Y0: 65, R0: 8));
t.Points.Add(new UniPoint(X0: 35, Xw: 0.5, Y0: 55, R0: 8));
t.Points.Add(new UniPoint(X0: 14, Xw: 0.5, Y0: 25));
t.Points.Add(new UniPoint(X0: 20, Xw: 0.5, Y0: 20));
t.Points.Add(new UniPoint(X0: 51, Xw: 0.5, Y0: 65, R0: 8));
t.Points.Add(new UniPoint(X0: 65, Xw: 0.5, Y0: 55, R0: 8));
t.Points.Add(new UniPoint(X0: 40, Xw: 0.5, Y0: 20));
t.Points.Add(new UniPoint(X0: 0, Xw: 1, Y0: 20, R0: 20));
t.Points.Add(new UniPoint() { X0 = 0, Xw = 1, Y0 = 0, Yh = 1 });
t.Points.Add(new UniPoint() { X0 = -20, Xw = 1, Y0 = 0, Yh = 1 });
t.Points.Add(new UniPoint() { X0 = -20, Xw = 1, Y0 = -20, Yh = 1, R0 = 10 });
t.Points.Add(new UniPoint() { X0 = -40, Xw = 1, Y0 = -20, Yh = 1, R0 = 10 });
t.Points.Add(new UniPoint() { X0 = -40, Xw = 1, Y0 = 0, Yh = 1 });
t.Points.Add(new UniPoint() { X0 = -60, Xw = 1, Y0 = 0, Yh = 1 });
t.Points.Add(new UniPoint() { X0 = -60, Xw = 1, Y0 = -20, Yh = 1, R0 = 10 });
t.Points.Add(new UniPoint() { X0 = -80, Xw = 1, Y0 = -20, Yh = 1, R0 = 10 });
t.Points.Add(new UniPoint() { X0 = -80, Xw = 1, Y0 = 0, Yh = 1 });
t.Points.Add(new UniPoint() { X0 = 0, Y0 = 0, Yh = 1, R0 = 20 });
t.Points.Add(new UniPoint(X0: 0, Y0: 70));
var tUniPoint1 = new UniPoint(X0: 5, Xw: 0.5, Y0: 70, R0: 10);
t.Points.Add(tUniPoint1);
t.Points.Add(new UniPoint(X0: 5, Xw: 0.5, Y0: 50, R0: 10));
t.Points.Add(new UniPoint(X0: 0, Y0: 50));
m_tGrid.Children.Add(t);

Everything is quite simple, convenient and quick. The aim is achieved!

Conclusion

The material presented in this article has long gained great currency in my work. If it was useful to you too, please vote for the article. Complaints, suggestions and comments are gratefully accepted always and now. Thanks for your attention!

History

  • 2011/05/09 - Initial version
  • 2011/05/26 - Update 1
    • Added sample of figure programmed in imperative code
    • Implemented some new overloads for UniPoint constructors

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
Russian Federation Russian Federation
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralMy vote of 5 Pin
Phil J Pearson27-May-11 4:25
Phil J Pearson27-May-11 4:25 
AnswerRe: My vote of 5 Pin
Bourlesque27-May-11 9:17
Bourlesque27-May-11 9:17 
GeneralMy vote of 5 Pin
OtherControls27-May-11 2:48
OtherControls27-May-11 2:48 
AnswerRe: My vote of 5 Pin
Bourlesque27-May-11 9:18
Bourlesque27-May-11 9:18 
GeneralMy vote of 5 Pin
Filip D'haene26-May-11 4:26
Filip D'haene26-May-11 4:26 
AnswerRe: My vote of 5 Pin
Bourlesque26-May-11 10:03
Bourlesque26-May-11 10:03 
GeneralMy vote of 4 Pin
Gilad Keinan24-May-11 6:22
Gilad Keinan24-May-11 6:22 
GeneralRe: My vote of 4 Pin
Bourlesque24-May-11 20:38
Bourlesque24-May-11 20:38 
AnswerRe: My vote of 4 [modified] Pin
Bourlesque26-May-11 0:27
Bourlesque26-May-11 0:27 
GeneralMy vote of 5 Pin
Dennis Dykstra16-May-11 16:48
Dennis Dykstra16-May-11 16:48 
AnswerRe: My vote of 5 Pin
Bourlesque16-May-11 21:07
Bourlesque16-May-11 21:07 
GeneralMy vote of 5 Pin
Marcelo Ricardo de Oliveira9-May-11 7:50
mvaMarcelo Ricardo de Oliveira9-May-11 7:50 
GeneralRe: My vote of 5 Pin
Bourlesque9-May-11 18:10
Bourlesque9-May-11 18:10 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.