diff options
Diffstat (limited to 'tikzit/src/common/RegularPolyShape.h')
-rw-r--r-- | tikzit/src/common/RegularPolyShape.h | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/tikzit/src/common/RegularPolyShape.h b/tikzit/src/common/RegularPolyShape.h index 663561e..1fd8f1e 100644 --- a/tikzit/src/common/RegularPolyShape.h +++ b/tikzit/src/common/RegularPolyShape.h @@ -24,10 +24,26 @@ #import <Foundation/Foundation.h> #import "Shape.h" +/** + * A regular polygon + * + * Matches the "regular polygon" shape in the shapes.geometric + * PGF/TikZ library. + */ @interface RegularPolyShape : Shape { } -- (id)initWithSides:(int)s rotation:(float)r; +/** + * Initialise a regular polygon + * + * A rotation of 0 will produce a polygon with one + * edge flat along the bottom (just like PGF/TikZ + * does it). + * + * @param sides the number of sides the polygon should have + * @param rotation the rotation of the polygon, in degrees + */ +- (id)initWithSides:(int)sides rotation:(int)rotation; @end |