Changeset 1234 for trunk/sources/HeuristicLab.Visualization/IShape.cs

Timestamp:

02/28/09 23:12:10 (16 years ago)

Author:

mstoeger

Message:

Added Xml comments for IShape, WorldShape and Transforms. (#406)

File:

• trunk/sources/HeuristicLab.Visualization/IShape.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Visualization/IShape.cs

@@ -2 +2 @@
 
 namespace HeuristicLab.Visualization {
+  /// <summary>
+  /// This is the base interface that has to be implemented by all shapes.
+  /// 
+  /// View port
+  ///   The view port is the available drawing area on the screen.
+  ///   It is specified in the GDI coordinate system.
+  /// 
+  /// Clipping area
+  ///   The clipping area is the range of values visible on the view port.
+  ///   Values outside this area will not be visible (they "get clipped").
+  ///   It can either be inherited from the parent, or it can be overriden
+  ///   to create distorted realities (see world shapes).
+  ///   It is specified in a world coordinate system.
+  /// 
+  /// Bounding box
+  ///   The bounding box is the location and the size of a shape on its parent.
+  ///   It is specified in the parent's world coordinate system.
+  /// </summary>
   public interface IShape {
-    void Draw(Graphics graphics, Rectangle viewport, RectangleD clippingArea);
+    /// <summary>
+    /// Draws the shape
+    /// </summary>
+    /// <param name="graphics">The Graphics object used to draw the shape</param>
+    /// <param name="parentViewport">The parent's view port</param>
+    /// <param name="parentClippingArea">The parent's clipping area</param>
+    void Draw(Graphics graphics, Rectangle parentViewport, RectangleD parentClippingArea);
+
+    /// <summary>
+    /// The shape's bounding box
+    /// </summary>
     RectangleD BoundingBox { get; }
   }