[Mirrorable / Flippable] clarify docs
This commit is contained in:
parent
504f89796c
commit
07a25ec290
1 changed files with 6 additions and 5 deletions
|
|
@ -25,8 +25,9 @@ class Mirrorable(metaclass=ABCMeta):
|
||||||
to (0, 0), this is equivalent to mirroring in the container's coordinate system.
|
to (0, 0), this is equivalent to mirroring in the container's coordinate system.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
axis: Axis to mirror across (0: x-axis, 1: y-axis).
|
axis: Axis to mirror across:
|
||||||
|
0: X-axis (flip y coords),
|
||||||
|
1: Y-axis (flip x coords)
|
||||||
Returns:
|
Returns:
|
||||||
self
|
self
|
||||||
"""
|
"""
|
||||||
|
|
@ -37,8 +38,8 @@ class Mirrorable(metaclass=ABCMeta):
|
||||||
Optionally mirror the entity across both axes through its origin.
|
Optionally mirror the entity across both axes through its origin.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
across_x: Mirror across x axis (flip y)
|
across_x: Mirror across the horizontal X-axis (flip Y coordinates).
|
||||||
across_y: Mirror across y axis (flip x)
|
across_y: Mirror across the vertical Y-axis (flip X coordinates).
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
self
|
self
|
||||||
|
|
@ -81,7 +82,7 @@ class Flippable(Positionable, metaclass=ABCMeta):
|
||||||
into account.
|
into account.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
axis: Axis to mirror across. 0 mirrors across y=0. 1 mirrors across x=0.
|
axis: Axis to mirror across. 0: x-axis (flip y coord), 1: y-axis (flip x coord).
|
||||||
x: Vertical line x=val to mirror across.
|
x: Vertical line x=val to mirror across.
|
||||||
y: Horizontal line y=val to mirror across.
|
y: Horizontal line y=val to mirror across.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue