Update docs for custom shapes and related features #7734
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issues
Addresses #6560
Addresses #6766
Pull requests
Changes
This PR updates docs for user-facing changes to custom shapes and related features.
Custom shapes:
vertex()
docstexture()
, but not yet documented on ref page forvertex()
bezierOrder()
quadraticVertex()
and move them herebezierVertex()
docsx, y, u, v
andx, y, z, u, v
signaturesbezierOrder()
?quadraticVertex()
docs (if needed)- relevant PRs: #7373, 7600
- relevant Issue: #6766
splineVertex()
curveVertex()
docssplineProperty()
and link to it?)curveVertex()
(it's already supported by the 1.x compatibility add-on for shapes)vertexProperty()
docssplineProperty()
vertexProperty()
,curveTightness()
splineProperties()
beginShape()
docsPATH
is the new name for the default shape kindbeginContour()
docsendShape/Contour(CLOSE)
behavior for splinessplineVertex()
?)endContour(CLOSE)
docsOPEN
)Curves:
curve()
docs to reflect name change tospline()
(if needed)curveTightness()
docs if neededcurvePoint()
docs to reflect name change tosplinePoint()
(if needed)curveTangent()
docs to reflect name change tosplineTangent()
(if needed)curveDetail()
docs, possibly incorporating adapted examples frombezierDetail()
docsbezierDetail()
docs (if needed)3D:
beginGeometry()
/endGeometry()
docs (if needed)buildGeometry()
.beginGeometry()
/endGeometry()
eliminates an inconsistency withbeginShape()
/endShape()
, reduces the size of the user-facing API, and prevents confusion (endGeometry()
is effectively used as a constructor, in contrast with how objects are usually created in p5)."Notes
endShape(CLOSE)
for Bézier curves was discussed; decided we can implement this for 2.0Screenshots
[Reminder] Might be helpful to provide screenshots of top-level listings from main reference page.
PR Checklist
npm run lint
passesFootnotes
Here, reference dependency refers to a reference page that depends on one of the new or changed features mentioned under the Changes section, either because it mentions it or because it uses it in a code example. ↩