Skip to content

feat: add kwargs to all functions so that they can be passed thru #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
connorferster merged 1 commit into from
Jun 18, 2025
Merged

feat: add kwargs to all functions so that they can be passed thru #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions src/plotly_3d_primitives/shapes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ def cube(
bounds: Optional[tuple[float]] = None,
color: str = "#aaa",
opacity: float = 0.5,
**kwargs
) -> go.Mesh3d:
if bounds is not None and len(bounds) == 6:
x0, x1, y0, y1, z0, z1 = bounds
Expand All @@ -34,7 +35,7 @@ def cube(
k_array = [3, 3, 7, 7, 4, 5, 4, 7, 7, 6, 6, 7]

mesh = go.Mesh3d(
x=x_array, y=y_array, z=z_array, opacity=opacity, color=color, alphahull=0
x=x_array, y=y_array, z=z_array, opacity=opacity, color=color, alphahull=0, **kwargs
)
# mesh = go.Mesh3d(
# x=x_array,
Expand All @@ -58,6 +59,7 @@ def prism(
capping=True,
color: str = "#aaa",
opacity: float = 0.5,
**kwargs
) -> go.Mesh3d:
anchor_x, anchor_y, anchor_z = center

Expand All @@ -73,7 +75,7 @@ def prism(
x_array, y_array, z_array = apply_transformations(x_array, y_array, z_array, center, direction)

return go.Mesh3d(
x=x_array, y=y_array, z=z_array, alphahull=0, color=color, opacity=opacity
x=x_array, y=y_array, z=z_array, alphahull=0, color=color, opacity=opacity, **kwargs
)


Expand All @@ -87,6 +89,7 @@ def cone(
resolution: int = 6,
color: str = "#aaa",
opacity: float = 0.5,
**kwargs
) -> go.Mesh3d:
anchor_x, anchor_y, anchor_z = center

Expand All @@ -107,7 +110,7 @@ def cone(
x_array, y_array, z_array = apply_transformations(x_array, y_array, z_array, center, direction)

return go.Mesh3d(
x=x_array, y=y_array, z=z_array, alphahull=0, color=color, opacity=opacity
x=x_array, y=y_array, z=z_array, alphahull=0, color=color, opacity=opacity, **kwargs
)


Expand All @@ -123,6 +126,7 @@ def sphere(
end_phi=180.0,
color="#555",
opacity=0.5,
**kwargs
) -> go.Mesh3d:
anchor_x, anchor_y, anchor_z = (0., 0., 0.)
phi = np.linspace(start_phi, 2 * np.radians(end_phi), phi_resolution + 1)
Expand All @@ -138,7 +142,7 @@ def sphere(
# print(center, direction)
# print(y_array)
return go.Mesh3d(
x=x_array, y=y_array, z=z_array, alphahull=0, color=color, opacity=opacity
x=x_array, y=y_array, z=z_array, alphahull=0, color=color, opacity=opacity, **kwargs
)


Expand All @@ -149,6 +153,7 @@ def line(
color: str = "#aaa",
line_width: float = 1.0,
opacity: float = 0.8,
**kwargs
):
"""
Returns a trace of a line in 3d space.
Expand All @@ -168,6 +173,7 @@ def line(
opacity=opacity,
mode="lines",
line=line_properties,
**kwargs
)


Expand All @@ -181,6 +187,7 @@ def circular_arc_from_normal(
opacity=0.5,
line_width=1.0,
return_points=False,
**kwargs
) -> go.Mesh3d:
"""
Create a circular arc defined by normal to the plane of the arc, and an
Expand Down Expand Up @@ -231,6 +238,7 @@ def circular_arc_from_normal(
line=line_properties,
opacity=opacity,
mode="lines",
**kwargs
), points
else:
return go.Scatter3d(
Expand All @@ -240,6 +248,7 @@ def circular_arc_from_normal(
line=line_properties,
opacity=opacity,
mode="lines",
**kwargs
)


Expand All @@ -250,6 +259,7 @@ def rectangle(
normal=(1.0, 0.0, 0.0),
color: str = "#aaa",
opacity: float = 0.5,
**kwargs
) -> go.Mesh3d:
z0 = center[2] - b / 2
z1 = center[2] + b / 2
Expand All @@ -273,6 +283,7 @@ def rectangle(
opacity=opacity,
color=color,
alphahull=0,
**kwargs
)
return mesh

Expand Down