Skip to content

Commit 23ad908

Browse files
committed
add more primitive docs
1 parent 3fdfd6c commit 23ad908

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

lib/scenic/primitive/line.ex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,11 @@ defmodule Scenic.Primitive.Line do
6262
def default_pin(data), do: centroid(data)
6363

6464
# --------------------------------------------------------
65+
@doc """
66+
Returns a the midpoint of the line. This is used as the default pin when applying
67+
rotate or scale transforms.
68+
"""
6569
def centroid(data)
66-
6770
def centroid({{x0, y0}, {x1, y1}}) do
6871
{
6972
(x0 + x1) / 2,

lib/scenic/primitive/rectangle.ex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,11 @@ defmodule Scenic.Primitive.Rectangle do
5757
def default_pin(data), do: centroid(data)
5858

5959
# --------------------------------------------------------
60+
@doc """
61+
Returns the centroid of the rectangle. This is used as the default pin when applying
62+
rotate or scale transforms.
63+
"""
6064
def centroid(data)
61-
6265
def centroid({width, height}) do
6366
{width / 2, height / 2}
6467
end

lib/scenic/primitive/rounded_rectangle.ex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,11 @@ defmodule Scenic.Primitive.RoundedRectangle do
8181
def default_pin(data), do: centroid(data)
8282

8383
# --------------------------------------------------------
84+
@doc """
85+
Returns a the centroid of the rectangle. This is used as the default pin when applying
86+
rotate or scale transforms.
87+
"""
8488
def centroid(data)
85-
8689
def centroid({width, height, _}) do
8790
{width / 2, height / 2}
8891
end

lib/scenic/primitive/triangle.ex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,11 @@ defmodule Scenic.Primitive.Triangle do
6060
def default_pin(data), do: centroid(data)
6161

6262
# --------------------------------------------------------
63+
@doc """
64+
Returns the centroid of the triangle. This is used as the default pin when applying
65+
rotate or scale transforms.
66+
"""
6367
def centroid(data)
64-
6568
def centroid({{x0, y0}, {x1, y1}, {x2, y2}}) do
6669
{
6770
(x0 + x1 + x2) / 3,

0 commit comments

Comments
 (0)