summaryrefslogtreecommitdiffstats
path: root/src/ui/knot/README
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 18:24:48 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 18:24:48 +0000
commitcca66b9ec4e494c1d919bff0f71a820d8afab1fa (patch)
tree146f39ded1c938019e1ed42d30923c2ac9e86789 /src/ui/knot/README
parentInitial commit. (diff)
downloadinkscape-upstream.tar.xz
inkscape-upstream.zip
Adding upstream version 1.2.2.upstream/1.2.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--src/ui/knot/README62
1 files changed, 62 insertions, 0 deletions
diff --git a/src/ui/knot/README b/src/ui/knot/README
new file mode 100644
index 0000000..7a76593
--- /dev/null
+++ b/src/ui/knot/README
@@ -0,0 +1,62 @@
+
+
+This directory contains code related to on-screen editing knots.
+
+Note that there are classes with similar functionality based on the ControlPoint class in src/ui/tool.
+
+Classes here:
+
+ * SPKnot A class that describes a knot (size, type, position, state, etc.) with some signals.
+
+ * KnotHolderEntity A class that has an SPKnot with some signals connections.
+
+ Derived classes:
+
+ LPEKnotHolderEntity
+ PatternKnotHolderEntity
+ HatchKnotHolderEntity
+ FilterKnotHolderEntity
+ RectKnotHolderEntityRX
+ RectKnotHolderEntityRY
+ RectKnotHolderEntityWH
+ RectKnotHolderEntityXY
+ RectKnotHolderEntityCenter
+ Box3DKnotHolderEntity
+ Box3DKnotHolderEntityCenter
+ ArcKnotHolderEntityStart
+ ArcKnotHolderEntityEnd
+ ArcKnotHolderEntityRX
+ ArcKnotHolderEntityRY
+ ArcKnotHolderEntityCenter
+ StarKnotHolderEntity1
+ StarKnotHolderEntity2
+ StarKnotHolderEntityCenter
+ SpiralKnotHolderEntityInner
+ SpiralKnotHolderEntityOuter
+ SpiralKnotHolderEntityCenter
+ OffsetKnotHolderEntity
+ TextKnotHolderEntityInlineSize
+ TextKnotHolderEntityShapeInside
+ FilletChamferKnotHolderEntity
+ TransformedPointParamKnotHolderEntity_Vector
+ PowerStrokePointArrayParamKnotHolderEntity
+ PowerStrokePointArrayParamKnotHolderEntity
+ PointParamKnotHolderEntity
+ VectorParamKnotHolderEntity_Origin
+ VectorParamKnotHolderEntity_Vector
+
+ And many classes derived from above!
+
+ * KnotHolder A class that has one or more overlapping knots via KnotHolderEntity's.
+
+ Derived classes:
+
+ ArcKnotHolder
+ Box3DKnotHolder
+ FlowtextKnotHolder
+ MiscKnotHolder
+ OffsetKnotHolder
+ RectKnotHolder
+ SpiralKnotHolder
+ StarKnotHolder
+ TextKnotHolder