jan/masque
1
1
Fork 0
Code Issues Pull requests Releases Wiki Activity

various doc updates

Browse source
This commit is contained in:
jan 2023-09-17 21:33:22 -07:00
commit e2c7f8c8cc
7 changed files with 132 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

17
masque/ref.py
View file

@ -1,9 +1,7 @@
"""
Ref provides basic support for nesting Pattern objects within each other, by adding
offset, rotation, scaling, and other such properties to the reference.
Ref provides basic support for nesting Pattern objects within each other.
It carries offset, rotation, mirroring, and scaling data for each individual instance.
"""
#TODO more top-level documentation for ref
from typing import Mapping, TYPE_CHECKING, Self
import copy
@ -28,10 +26,15 @@ class Ref(
PivotableImpl, Copyable, RepeatableImpl, AnnotatableImpl,
):
"""
`Ref` provides basic support for nesting Pattern objects within each other, by adding
offset, rotation, scaling, and associated methods.
`Ref` provides basic support for nesting Pattern objects within each other.
Note: Order is (mirror, rotate, scale, translate, repeat)
It containts the transformation (mirror, rotation, scale, offset, repetition)
and annotations for a single instantiation of a `Pattern`.
Note that the target (i.e. which pattern a `Ref` instantiates) is not stored within the
`Ref` itself, but is specified by the containing `Pattern`.
Order of operations is (mirror, rotate, scale, translate, repeat).
"""
__slots__ = (
'_mirrored',