├── LICENSE
├── README.md
├── examples
├── examples.pdf
├── examples.typ
├── examples1.png
├── examples10.png
├── examples2.png
├── examples3.png
├── examples4.png
├── examples5.png
├── examples6.png
├── examples7.png
├── examples8.png
└── examples9.png
├── plotsy-3d.typ
└── typst.toml
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU LESSER GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 |
9 | This version of the GNU Lesser General Public License incorporates
10 | the terms and conditions of version 3 of the GNU General Public
11 | License, supplemented by the additional permissions listed below.
12 |
13 | 0. Additional Definitions.
14 |
15 | As used herein, "this License" refers to version 3 of the GNU Lesser
16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU
17 | General Public License.
18 |
19 | "The Library" refers to a covered work governed by this License,
20 | other than an Application or a Combined Work as defined below.
21 |
22 | An "Application" is any work that makes use of an interface provided
23 | by the Library, but which is not otherwise based on the Library.
24 | Defining a subclass of a class defined by the Library is deemed a mode
25 | of using an interface provided by the Library.
26 |
27 | A "Combined Work" is a work produced by combining or linking an
28 | Application with the Library. The particular version of the Library
29 | with which the Combined Work was made is also called the "Linked
30 | Version".
31 |
32 | The "Minimal Corresponding Source" for a Combined Work means the
33 | Corresponding Source for the Combined Work, excluding any source code
34 | for portions of the Combined Work that, considered in isolation, are
35 | based on the Application, and not on the Linked Version.
36 |
37 | The "Corresponding Application Code" for a Combined Work means the
38 | object code and/or source code for the Application, including any data
39 | and utility programs needed for reproducing the Combined Work from the
40 | Application, but excluding the System Libraries of the Combined Work.
41 |
42 | 1. Exception to Section 3 of the GNU GPL.
43 |
44 | You may convey a covered work under sections 3 and 4 of this License
45 | without being bound by section 3 of the GNU GPL.
46 |
47 | 2. Conveying Modified Versions.
48 |
49 | If you modify a copy of the Library, and, in your modifications, a
50 | facility refers to a function or data to be supplied by an Application
51 | that uses the facility (other than as an argument passed when the
52 | facility is invoked), then you may convey a copy of the modified
53 | version:
54 |
55 | a) under this License, provided that you make a good faith effort to
56 | ensure that, in the event an Application does not supply the
57 | function or data, the facility still operates, and performs
58 | whatever part of its purpose remains meaningful, or
59 |
60 | b) under the GNU GPL, with none of the additional permissions of
61 | this License applicable to that copy.
62 |
63 | 3. Object Code Incorporating Material from Library Header Files.
64 |
65 | The object code form of an Application may incorporate material from
66 | a header file that is part of the Library. You may convey such object
67 | code under terms of your choice, provided that, if the incorporated
68 | material is not limited to numerical parameters, data structure
69 | layouts and accessors, or small macros, inline functions and templates
70 | (ten or fewer lines in length), you do both of the following:
71 |
72 | a) Give prominent notice with each copy of the object code that the
73 | Library is used in it and that the Library and its use are
74 | covered by this License.
75 |
76 | b) Accompany the object code with a copy of the GNU GPL and this license
77 | document.
78 |
79 | 4. Combined Works.
80 |
81 | You may convey a Combined Work under terms of your choice that,
82 | taken together, effectively do not restrict modification of the
83 | portions of the Library contained in the Combined Work and reverse
84 | engineering for debugging such modifications, if you also do each of
85 | the following:
86 |
87 | a) Give prominent notice with each copy of the Combined Work that
88 | the Library is used in it and that the Library and its use are
89 | covered by this License.
90 |
91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license
92 | document.
93 |
94 | c) For a Combined Work that displays copyright notices during
95 | execution, include the copyright notice for the Library among
96 | these notices, as well as a reference directing the user to the
97 | copies of the GNU GPL and this license document.
98 |
99 | d) Do one of the following:
100 |
101 | 0) Convey the Minimal Corresponding Source under the terms of this
102 | License, and the Corresponding Application Code in a form
103 | suitable for, and under terms that permit, the user to
104 | recombine or relink the Application with a modified version of
105 | the Linked Version to produce a modified Combined Work, in the
106 | manner specified by section 6 of the GNU GPL for conveying
107 | Corresponding Source.
108 |
109 | 1) Use a suitable shared library mechanism for linking with the
110 | Library. A suitable mechanism is one that (a) uses at run time
111 | a copy of the Library already present on the user's computer
112 | system, and (b) will operate properly with a modified version
113 | of the Library that is interface-compatible with the Linked
114 | Version.
115 |
116 | e) Provide Installation Information, but only if you would otherwise
117 | be required to provide such information under section 6 of the
118 | GNU GPL, and only to the extent that such information is
119 | necessary to install and execute a modified version of the
120 | Combined Work produced by recombining or relinking the
121 | Application with a modified version of the Linked Version. (If
122 | you use option 4d0, the Installation Information must accompany
123 | the Minimal Corresponding Source and Corresponding Application
124 | Code. If you use option 4d1, you must provide the Installation
125 | Information in the manner specified by section 6 of the GNU GPL
126 | for conveying Corresponding Source.)
127 |
128 | 5. Combined Libraries.
129 |
130 | You may place library facilities that are a work based on the
131 | Library side by side in a single library together with other library
132 | facilities that are not Applications and are not covered by this
133 | License, and convey such a combined library under terms of your
134 | choice, if you do both of the following:
135 |
136 | a) Accompany the combined library with a copy of the same work based
137 | on the Library, uncombined with any other library facilities,
138 | conveyed under the terms of this License.
139 |
140 | b) Give prominent notice with the combined library that part of it
141 | is a work based on the Library, and explaining where to find the
142 | accompanying uncombined form of the same work.
143 |
144 | 6. Revised Versions of the GNU Lesser General Public License.
145 |
146 | The Free Software Foundation may publish revised and/or new versions
147 | of the GNU Lesser General Public License from time to time. Such new
148 | versions will be similar in spirit to the present version, but may
149 | differ in detail to address new problems or concerns.
150 |
151 | Each version is given a distinguishing version number. If the
152 | Library as you received it specifies that a certain numbered version
153 | of the GNU Lesser General Public License "or any later version"
154 | applies to it, you have the option of following the terms and
155 | conditions either of that published version or of any later version
156 | published by the Free Software Foundation. If the Library as you
157 | received it does not specify a version number of the GNU Lesser
158 | General Public License, you may choose any version of the GNU Lesser
159 | General Public License ever published by the Free Software Foundation.
160 |
161 | If the Library as you received it specifies that a proxy can decide
162 | whether future versions of the GNU Lesser General Public License shall
163 | apply, that proxy's public statement of acceptance of any version is
164 | permanent authorization for you to choose that version for the
165 | Library.
166 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # The `plotsy-3d` Package
2 |
Version 0.2.0 DEV
3 |
4 |
5 | **plotsy-3d** is a [Typst](https://github.com/typst/typst) package for rendering 3D objects built on top of [CeTZ](https://github.com/cetz-package/cetz). Similar functionality to pgfplots for LaTeX but currently less developed.
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 | ## Features:
24 |
25 | * 3D Function plotting of the form `z = f(x,y)`
26 | * Parametric curve plotting of the form `x(t), y(t), z(t)`
27 | * Parametric surface plotting of the form `x(u,v), y(u,v), z(u,v)`
28 | * Plots autoscale with font size for consistent style
29 |
30 | See **Usage** or `examples/examples.typ` for the code
31 |
32 |
33 | ## Future Plans (contributors welcome):
34 | - [ ] Nicer way to draw vectors
35 | - [ ] Better way to handle render order
36 | - [ ] Function to generate 2D plots for XZ XY YZ projections of any 3d render
37 | - [ ] User Manual
38 | - [ ] Make the code and api nicer
39 |
40 | ## Usage
41 |
42 | ### Parametric Function Plotting
43 | ```typ
44 | #import "@preview/plotsy-3d:0.1.0": plot-3d-parametric-curve
45 |
46 | #let xfunc(t) = 15*calc.cos(t)
47 | #let yfunc(t) = calc.sin(t)
48 | #let zfunc(t) = t
49 |
50 | == Parametric Curve
51 | $ x(t) = 15 cos(t), space y(t)= sin(t), space z(t)= t $
52 | #plot-3d-parametric-curve(
53 | xfunc,
54 | yfunc,
55 | zfunc,
56 | subdivisions:30, //number of line segments per unit
57 | scale-dim: (0.03,0.05,0.05), // relative and global scaling
58 | tdomain:(0,10),
59 | axis-step: (5,5,5), // adjust distance between x, y, z number labels
60 | dot-thickness: 0.05em,
61 | front-axis-thickness: 0.1em,
62 | front-axis-dot-scale: (0.04, 0.04),
63 | rear-axis-dot-scale: (0.08,0.08),
64 | rear-axis-text-size: 0.5em,
65 | axis-label-size: 1.5em,
66 | rotation-matrix: ((-2, 2, 4), (0, -1, 0)) // matrix.transform-rotate-dir() from cetz
67 | )
68 | ```
69 |
70 | ### 3D Surface Plotting
71 | ```typ
72 | #import "@preview/plotsy-3d:0.1.0": plot-3d-surface
73 |
74 | #let size = 10
75 | #let scale-factor = 0.11
76 | #let (xscale,yscale,zscale) = (0.3,0.3,0.02)
77 | #let scale-dim = (xscale*scale-factor,yscale*scale-factor, zscale*scale-factor)
78 | #let func(x,y) = x*x + y*y
79 | #let color-func(x, y, z, x-lo,x-hi,y-lo,y-hi,z-lo,z-hi) = {
80 | return blue.transparentize(20%).darken((y/(y-hi - y-lo))*100%).lighten((x/(x-hi - x-lo)) * 50%)
81 | }
82 |
83 | == 3D Surface
84 | $ z= x^2 + y^2 $
85 | #plot-3d-surface(
86 | func,
87 | color-func: color-func,
88 | subdivisions: 2,
89 | subdivision-mode: "decrease",
90 | scale-dim: scale-dim,
91 | xdomain: (-size,size),
92 | ydomain: (-size,size),
93 | pad-high: (0,0,0), // padding around the domain with no function displayed
94 | pad-low: (0,0,5),
95 | axis-step: (3,3,75),
96 | dot-thickness: 0.05em,
97 | front-axis-thickness: 0.1em,
98 | front-axis-dot-scale: (0.05,0.05),
99 | rear-axis-dot-scale: (0.08,0.08),
100 | rear-axis-text-size: 0.5em,
101 | axis-label-size: 1.5em,
102 | )
103 | ```
104 |
105 | ### Parametric Surface Plotting
106 | ```typ
107 | #import "@preview/plotsy-3d:0.1.0": plot-3d-parametric-surface
108 |
109 | #let xfunc(u,v) = u*calc.sin(v)
110 | #let yfunc(u,v) = u*calc.cos(v)
111 | #let zfunc(u,v) = u
112 | #let color-func(x, y, z, x-lo,x-hi,y-lo,y-hi,z-lo,z-hi) = {
113 | return purple.transparentize(20%).lighten((z/(z-hi - z-lo)) * 80%)
114 |
115 | }
116 | #let scale-factor = 0.25
117 | #let (xscale,yscale,zscale) = (0.3,0.2,0.3)
118 | #let scale-dim = (xscale*scale-factor,yscale*scale-factor, zscale*scale-factor)
119 |
120 | == Parametric Surface
121 | $ x(u,v) = u sin(v), space y(u,v)= u cos(v), space z(u,v)= u $
122 | #plot-3d-parametric-surface(
123 | xfunc,
124 | yfunc,
125 | zfunc,
126 | xaxis: (-5,5), // set the minimum axis size, scales with function if needed
127 | yaxis: (-5,5),
128 | zaxis: (0,5),
129 | color-func: color-func,
130 | subdivisions:5,
131 | scale-dim: scale-dim,
132 | udomain:(0, calc.pi+1), // note this gets truncated to an integer
133 | vdomain:(0, 2*calc.pi+1), // note this gets truncated to an integer
134 | axis-step: (5,5,5),
135 | dot-thickness: 0.05em,
136 | front-axis-thickness: 0.1em,
137 | front-axis-dot-scale: (0.04, 0.04),
138 | rear-axis-dot-scale: (0.08,0.08),
139 | rear-axis-text-size: 0.5em,
140 | axis-label-size: 1.5em,
141 | )
142 | ```
143 |
144 | ### Vector Field Plotting
145 | ```typ
146 | #import "@preview/plotsy-3d:0.1.0": plot-3d-vector-field
147 |
148 | #let size = 10
149 | #let scale-factor = 0.12
150 | #let (xscale,yscale,zscale) = (0.3,0.3,0.3)
151 | #let i-func(x,y,z) = x + 0.5
152 | #let j-func(x,y,z) = y + 0.5
153 | #let k-func(x,y,z) = z + 1
154 | #let color-func(x, y, z, x-lo,x-hi,y-lo,y-hi,z-lo,z-hi) = {
155 | return purple.darken(z/(z-hi - z-lo) * 100%)
156 | }
157 |
158 | == 3D Vector Field
159 | $ arrow(p)(x,y,z) = (x+0.5) hat(i) + (y+0.5) hat(j) + (z+1) hat(k) $
160 | #plot-3d-vector-field(
161 | i-func,
162 | j-func,
163 | k-func,
164 | color-func: color-func,
165 | subdivisions: 3,
166 | subdivision-mode: "decrease",
167 | scale-dim: (xscale*scale-factor,yscale*scale-factor, zscale*scale-factor),
168 | xdomain: (-size,size),
169 | ydomain: (-size,size),
170 | zdomain: (0,size),
171 | // pad-high: (0,0,2),
172 | rotation-matrix: ((-1.5, 1.2, 4), (0, -1, 0)),
173 | axis-label-offset: (0.4,0.2,0.2),
174 | axis-text-offset: 0.08,
175 | vector-size: 0.1em,
176 | )
177 | ```
178 |
179 | ### Custom Plotting
180 | For custom combinations of plots and lines, you can make a copy of the relevant plot function from `plotsy-3d.typ` and add multiple plots onto the same axis in the same cetz canvas using the backend render functions.
181 |
182 | ## More Examples
183 |
184 |
188 |
189 |