Skip to content

Commit

Permalink
Add class comments for all tools.
Browse files Browse the repository at this point in the history
  • Loading branch information
@RogerAK
RogerAK committed Aug 2, 2022
1 parent 4e59eb6 commit e8024c7
Show file tree
Hide file tree
Showing 60 changed files with 60 additions and 30 deletions.
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ActionTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ActionTool is an M2Tool which is an abstract class for all action tools that are only a one-time action or a single click.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ActionTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:39",
"instvars" : [
],
"name" : "M2ActionTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2BrushTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2BrushTool is an M2Tool which is an abstract superclass for all tools that mimic the behavior of brushes, pencils or erasers.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2BrushTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:46",
"instvars" : [
"pen" ],
"name" : "M2BrushTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2CircleBrushTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2CircleBrushTool is an M2RoundBrushTool which mimics a brush with a circular nib.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2CircleBrushTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:40",
"instvars" : [
],
"name" : "M2CircleBrushTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ClearCanvasTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ClearCanvasTool is an M2ActionTool which can be used to clear the current layer.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ClearCanvasTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:15",
"instvars" : [
],
"name" : "M2ClearCanvasTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2EllipseShape.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2EllipseShape is an M2ResizingGeometricshape which can be used to create ellipses and circles.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2EllipseShape.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:12",
"instvars" : [
],
"name" : "M2EllipseShape",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2EraserBrushTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2EraserBrushTool is an M2RoundBrushTool which mimics an eraser.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2EraserBrushTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 17:03",
"instvars" : [
],
"name" : "M2EraserBrushTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ExportMorphTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ExportMorphTool is an M2ActionTool which exports all layers combined as a morph.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ExportMorphTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:58",
"instvars" : [
],
"name" : "M2ExportMorphTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ExportPNGTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ExportPNGTool is an M2ActionTool which exports all layers combined as a PNG-file.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ExportPNGTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:39",
"instvars" : [
],
"name" : "M2ExportPNGTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2FillAreaTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2FillAreaTool is an M2Tool which can be used to fill a certain area or the entire canvas with a selected color.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2FillAreaTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:42",
"instvars" : [
],
"name" : "M2FillAreaTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2GeometricShape.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2GeometricShape is an abstract superclass for different geometric shapes that can be used by different tools.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2GeometricShape.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:14",
"instvars" : [
"context",
"morph" ],
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2GeometricTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2GeometricTool is an M2TemporaryMorphTool which is used to draw geometric shapes.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2GeometricTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 17:01",
"instvars" : [
],
"name" : "M2GeometricTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ImportImageTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ImportImageTool is an M2ActionTool which can be used to import an image.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ImportImageTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:54",
"instvars" : [
],
"name" : "M2ImportImageTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2InsertSelectionTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2InsertSelectionTool is an M2Tool which can be used to paste the current selection from the clipboard onto the canvas.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2InsertSelectionTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:58",
"instvars" : [
],
"name" : "M2InsertSelectionTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2LassoShape.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2LassoShape is an M2GeometricShape which can be used to create free form shapes.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2LassoShape.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:24",
"instvars" : [
],
"name" : "M2LassoShape",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2PencilBrushTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2PencilBrushTool is an M2RoundBrushTool which mimics a pencil.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2PencilBrushTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:47",
"instvars" : [
],
"name" : "M2PencilBrushTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2PipetteTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2PipetteTool is an M2ActionTool which can be used to select a color from the entire screen.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2PipetteTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:41",
"instvars" : [
],
"name" : "M2PipetteTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2RectangleBrushTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2RectangleBrushTool is an M2BrushTool which mimics a brush with a rectangular nib.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2RectangleBrushTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:40",
"instvars" : [
],
"name" : "M2RectangleBrushTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2RectangleShape.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2RectangleShape is an M2ResizingGeometricshape which can be used to create rectangles.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2RectangleShape.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:13",
"instvars" : [
],
"name" : "M2RectangleShape",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ResizingGeometricShape.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ResizingGeometricShape is an M2GeometricShape which is an abstract supperclass for all geometric shapes which can be resized.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ResizingGeometricShape.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:52",
"instvars" : [
"startPoint" ],
"name" : "M2ResizingGeometricShape",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2RoundBrushTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2RoundBrushTool is an M2BrushTool which is an abstract superclass for all rounded brush tools.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2RoundBrushTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:37",
"instvars" : [
],
"name" : "M2RoundBrushTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2SelectTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2SelectTool is an M2TemporaryMorphTool which shows a preview of the selected area until another tool is selected and at the same time it also copies the selected area into the clipboard.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2SelectTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 17:01",
"instvars" : [
],
"name" : "M2SelectTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2TemporaryMorphTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2TemporaryMorphTool is an M2Tool which is an abstract superclass for all tools which create M2TemporaryGeometricMorphs.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2TemporaryMorphTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:59",
"instvars" : [
"morph",
"shapeClass",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2TextFontTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2TextFontTool is an M2Tool wich can be used to choose the font style of texts.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2TextFontTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 17:02",
"instvars" : [
],
"name" : "M2TextFontTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2TextTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2TextTool is an M2Tool which can be used to insert text.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2TextTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:47",
"instvars" : [
"nextStartFinishes",
"temporaryTextMorph" ],
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2Tool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2Tool is an abstract superclass for all tools which can be used by the user.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2Tool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:34",
"instvars" : [
"context",
"isActive" ],
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2TriangleBrushTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2TriangleBrushTool is an M2BrushTool which mimics a brush with a triangular nib.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2TriangleBrushTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:42",
"instvars" : [
],
"name" : "M2TriangleBrushTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2TriangleShape.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2TriangleShape is an M2ResizingGeometricshape which can be used to create equilateral and isosceles triangles.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2TriangleShape.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 16:28",
"instvars" : [
],
"name" : "M2TriangleShape",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ZoomDefaultTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ZoomDefaultTool is an M2ActionTool which resets the canvas zoom to 100%.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ZoomDefaultTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:17",
"instvars" : [
],
"name" : "M2ZoomDefaultTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ZoomInTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ZoomInTool is an M2ActionTool which can be used to zoom in the canvas.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ZoomInTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 15:17",
"instvars" : [
],
"name" : "M2ZoomInTool",
Expand Down
1 change: 1 addition & 0 deletions packages/SketchMorph2-Tools.package/M2ZoomOutTool.class/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An M2ZoomOutTool is an M2ActionTool which can be used to zoom out the canvas.
2 changes: 1 addition & 1 deletion packages/SketchMorph2-Tools.package/M2ZoomOutTool.class/properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"classvars" : [
],
"commentStamp" : "",
"commentStamp" : "KR 8/2/2022 17:04",
"instvars" : [
],
"name" : "M2ZoomOutTool",
Expand Down

0 comments on commit e8024c7

Please sign in to comment.