aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/protocol.lisp
diff options
context:
space:
mode:
authorColin Okay <colin@cicadas.surf>2022-07-08 11:00:07 -0500
committerColin Okay <colin@cicadas.surf>2022-07-08 11:00:07 -0500
commit8bf0e572ee084e6659f56b2fecd44a54e2775b6c (patch)
tree5c7324babdd7007f9bd6865f2cb4c3390f47c40c /src/protocol.lisp
parentdd354e5caee002be931501062bf3aaa68f1d63e6 (diff)
[docs] added docstrings to exports
Diffstat (limited to 'src/protocol.lisp')
-rw-r--r--src/protocol.lisp18
1 files changed, 12 insertions, 6 deletions
diff --git a/src/protocol.lisp b/src/protocol.lisp
index df3c170..002aad6 100644
--- a/src/protocol.lisp
+++ b/src/protocol.lisp
@@ -46,17 +46,23 @@
(defgeneric (setf height) (new-height thing)
(:documentation "sets the effective height of thing to new-height"))
-(defgeneric rotation (thing))
+(defgeneric rotation (thing)
+ (:documentation "Rotational angle of thing in radians about its center."))
(defgeneric (setf rotation) (newval thing))
-(defgeneric x (thing))
+(defgeneric x (thing)
+ (:documentation "X position of the bottom left corner in scaled coordinates"))
(defgeneric (setf x) (newval thing))
-(defgeneric y (thing))
+(defgeneric y (thing)
+ (:documentation "Y position of bottom left corner in scaled coordinates"))
(defgeneric (setf y) (newval thing))
-(defgeneric scale-x (thing))
+(defgeneric scale-x (thing)
+ (:documentation "Horizontal scale factor"))
(defgeneric (setf scale-x) (newvval thing))
-(defgeneric scale-y (thing))
+(defgeneric scale-y (thing)
+ (:documentation "Vertical Scale Vactor"))
(defgeneric (setf scale-y) (newval thing))
+
(defgeneric get-rect (affine)
(:documentation "Returns a list of vectors representing the path of
the smallest rectangle that encloses the affine-unit. The rectangle
- is scaled and rotated."))
+ is scaled and rotated. These vectors have been made using 3D-VECTORS:VEC"))