HorizontalLine.cs

Go to the documentation of this file.
00001 /*
00002 NPlot - A charting library for .NET
00003 
00004 HorizontalLine.cs
00005 Copyright (C) 2003
00006 Matt Howlett
00007 
00008 Redistribution and use of NPlot or parts there-of in source and
00009 binary forms, with or without modification, are permitted provided
00010 that the following conditions are met:
00011 
00012 1. Re-distributions in source form must retain at the head of each
00013    source file the above copyright notice, this list of conditions
00014    and the following disclaimer.
00015 
00016 2. Any product ("the product") that makes use NPlot or parts 
00017    there-of must either:
00018   
00019     (a) allow any user of the product to obtain a complete machine-
00020         readable copy of the corresponding source code for the 
00021         product and the version of NPlot used for a charge no more
00022         than your cost of physically performing source distribution,
00023         on a medium customarily used for software interchange, or:
00024 
00025     (b) reproduce the following text in the documentation, about 
00026         box or other materials intended to be read by human users
00027         of the product that is provided to every human user of the
00028         product: 
00029    
00030               "This product includes software developed as 
00031               part of the NPlot library project available 
00032               from: http://www.nplot.com/" 
00033 
00034         The words "This product" may optionally be replace with 
00035         the actual name of the product.
00036 
00037 ------------------------------------------------------------------------
00038 
00039 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00040 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00041 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00042 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00043 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00044 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00045 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00046 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00047 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00048 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00049 
00050 */
00051 
00052 using System;
00053 using System.Drawing;
00054 
00055 namespace NPlot
00056 {
00057 
00061         public class HorizontalLine : IPlot
00062         {
00063 
00068                 public HorizontalLine( double ordinateValue )
00069                 {
00070                         this.value_ = ordinateValue;
00071                 }
00072 
00073 
00079                 public HorizontalLine( double ordinateValue, Color color )
00080                 {
00081                         this.value_ = ordinateValue;
00082                         this.pen_ = new Pen( color );
00083                 }
00084 
00090                 public HorizontalLine( double ordinateValue, Pen pen )
00091                 {
00092                         this.value_ = ordinateValue;
00093                         this.pen_ = pen;
00094                 }
00095 
00096                 
00102                 public void DrawInLegend(System.Drawing.Graphics g, System.Drawing.Rectangle startEnd)
00103                 {
00104                         g.DrawLine( pen_, startEnd.Left, (startEnd.Top + startEnd.Bottom)/2, 
00105                                 startEnd.Right, (startEnd.Top + startEnd.Bottom)/2 );
00106                 }
00107 
00108 
00112                 public string Label
00113                 {
00114                         get
00115                         {
00116                                 return label_;
00117                         }
00118                         set
00119                         {
00120                                 this.label_ = value;
00121                         }
00122                 }
00123                 
00124                 private string label_ = "";
00125 
00126 
00130                 public bool ShowInLegend
00131                 {
00132                         get
00133                         {
00134                                 return showInLegend_;
00135                         }
00136                         set
00137                         {
00138                                 this.showInLegend_ = value;
00139                         }
00140                 }
00141                 private bool showInLegend_ = false;
00142 
00143 
00148                 public Axis SuggestXAxis()
00149                 {
00150                         return null;
00151                 }
00152 
00153 
00158                 public Axis SuggestYAxis()
00159                 {
00160                         return new LinearAxis( this.value_, this.value_ );
00161                 }
00162 
00171                 public void WriteData(System.Text.StringBuilder sb, RectangleD region, bool onlyInRegion)
00172                 {
00173 
00174                         // return if line is not in plot region and 
00175                         if (value_ > region.Y+region.Height || value_ < region.Y)
00176                         {
00177                                 if (onlyInRegion)
00178                                 {
00179                                         return;
00180                                 }
00181                         }
00182 
00183                         sb.Append( "Label: " );
00184                         sb.Append( this.Label );
00185                         sb.Append( "\r\n" );
00186                         sb.Append( value_.ToString() );
00187                         sb.Append( "\r\n" );
00188 
00189                 }
00190 
00197                 public void Draw(System.Drawing.Graphics g, PhysicalAxis xAxis, PhysicalAxis yAxis)
00198                 {
00199                         int xMin = xAxis.PhysicalMin.X;
00200                         int xMax = xAxis.PhysicalMax.X;
00201                         
00202                         xMin += pixelIndent_;
00203                         xMax -= pixelIndent_;
00204 
00205                         float length = Math.Abs(xMax - xMin);
00206                         float lengthDiff = length - length*scale_;
00207                         float indentAmount = lengthDiff/2;
00208 
00209                         xMin += (int)indentAmount;
00210                         xMax -= (int)indentAmount;
00211 
00212                         int yPos = (int)yAxis.WorldToPhysical( value_, false ).Y;
00213                 
00214                         g.DrawLine( pen_, new System.Drawing.Point( xMin, yPos ), new System.Drawing.Point( xMax, yPos ) );
00215 
00216                         // todo:  clip and proper logic for flipped axis min max.
00217                 }
00218 
00219                 private double value_;
00223                 public double OrdinateValue
00224                 {
00225                         get
00226                         {
00227                                 return value_;
00228                         }
00229                         set
00230                         {
00231                                 value_ = value;
00232                         }
00233                 }
00234 
00235                 private Pen pen_ = new Pen( Color.Black );
00239                 public Pen Pen
00240                 {
00241                         get
00242                         {
00243                                 return pen_;
00244                         }
00245                         set
00246                         {
00247                                 pen_ = value;
00248                         }
00249                 }
00250 
00251                 
00255                 public int PixelIndent
00256                 {
00257                         get
00258                         {
00259                                 return pixelIndent_;
00260                         }
00261                         set
00262                         {
00263                                 pixelIndent_ = value;
00264                         }
00265                 }
00266                 private int pixelIndent_ = 0;
00267 
00268 
00273                 public float LengthScale
00274                 {
00275                         get
00276                         {
00277                                 return scale_;
00278                         }
00279                         set
00280                         {
00281                                 scale_ = value;
00282                         }
00283                 }
00284                 private float scale_ = 1.0f;
00285 
00286         }
00287 }

Generated on Sat Nov 5 01:04:06 2005 for NPlot by  doxygen 1.4.5