summaryrefslogtreecommitdiff
path: root/doc/classes/Curve3D.xml
AgeCommit message (Collapse)Author
2022-12-03Fix Curve3D::get_closest_point() brokenYaohua Xiong
The problem is caused by calling adaptive tessellation baking function by mistake, which produce too few points for straight lines. Calling the even length tessellation fix the problem. The code for `get_closest_point()` and `get_closest_offset()` are also updated. They used to assume bake interval to be exact, which is no longer true. The out dated document for `get_closest_point()` is also updated.
2022-11-24Refactor Curve3D::_bake() methodYaohua Xiong
The main change is to caculate tangent directly from bezier curve, without going through discretized polyline, avoiding pitfalls of discretization. Other changes are: 1. Add an bezier_derivative() method for Vector3, Vector2, and Math; 2. Add an tesselate_even_length() method to Curve3D, which tesselate bezier curve to even length segments adaptively; 3. Cache the tangent vectors in baked_tangent_vector_cache;
2022-11-12Refactor Curv3D and PathFollow3DYaohua Xiong
This commit makes the following major changes 1. Add "sample_baked_with_rotation()" to Curve3D, making it usable independently. A similar change was made to Curve2D previously. 2. Refactor the _bake() method on Curve3D, using Parallel Transport Frame instead of Frenet Frame. 3. Refactor the sample_* methods, including: i. Factor out common binary search code, following the DRY principe ii. sample_up_vector() interpolated up vector as part of rotation frame(posture) for consistancy and accuracy.
2022-08-30Rename Curve/Curve2D/Curve3D/Gradient `interpolate()` to `sample()`Hugo Locurcio
"sampling" is a more accurate term than "interpolating" for what's happening when using that function.
2022-08-15Clarify the Line2D, Curve2D/3D documentation and fix parameter namesYuri Sizov
2022-08-12[doc] Use "param" instead of "code" to refer to parameters (7)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-05-17Expose Curve points in the inspectorRaul Santos
Exposes the Curve, Curve2D and Curve3D points as an array property.
2022-03-11Clarify the position of points in `Curve{2D,3D}.add_point()`Hugo Locurcio
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-06-18Better format arguments in variant parserMichael Alexsander Silva Dias
2021-02-28Clarify Curve.get_closest_point uses baked points.Ryan Roden-Corrent
Based on the doc, I wasn't sure if get_closest_point would return the closest baked point or the closest "source" point. It seems to use baked: https://github.com/godotengine/godot/blob/8faecd6a470aeef41084a32d74f4a131a5ef42b6/scene/resources/curve.cpp#L809
2020-12-01Fix incorrect `Curve3D.interpolate_baked()` descriptionHugo Locurcio
The offset is in 3D units, not pixels. This closes https://github.com/godotengine/godot-docs/issues/4339.
2020-11-16Clarify Curve3D.get_point_{in,out} position in doc.Ryan Roden-Corrent
I verified this experimentally. I added a point at roughly (1,0,0), and dragged a handle back to the origin. The result was: ``` get_point_position: (0.991079, 0, -0.000069) get_point_in: (0.993409, 0, 0) get_point_out: (-0.993409, 0, 0) ```
2020-03-30doc: Update classref with node renamesRémi Verschelde
A few extra renames for classes which were missed in last week's PRs.
2020-02-25doc: Sync classref for Packed{Int,Float}{32,64}Array additionsRémi Verschelde
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-27doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde
2019-04-22Merge pull request #28125 from KoBeWi/code_true_codeRémi Verschelde
Consistently wrap booleans in [code]
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-17Consistently wrap booleans in [code]Tomasz Chabora
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-01-16Rename OrientedPathFollow to PathFollowOrientedDanilo Villa (Davi)
2019-01-07doc: Fix wrong references found by new makerst.pyRémi Verschelde
Thanks @PJB3005
2018-12-29doc: Fix references to setters and misc formattingRémi Verschelde
2018-09-23[Docs] Remove double-spaces from descriptions, as well a couple other small ↵LikeLakers2
fixes
2018-05-20Up vector implementation and OrientedPathFollow.danilo2205
2018-05-12Sync classref with current sourceRémi Verschelde
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Update version string in headerRémi Verschelde
2018-01-25doc: Sync with current sourceRémi Verschelde
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
2018-01-13doc: Update version string in XMLRémi Verschelde
2017-12-13[DOCS] Animation, CanvasItem, Curve3D, CurveWill Nations
2017-12-07doc: Sync classref after a496dd4d, removing NOEDITOR properties from docRémi Verschelde
2017-11-24doc: Remove setters and getters now exposed via properties/membersRémi Verschelde
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-15doc: Remove revision.module_config from version stringRémi Verschelde
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-09-20Rename pos to position in user facing methods and variablesletheed
Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-13doc: Sync classref with current sourceRémi Verschelde
[ci skip]
2017-09-12Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky
possible to save module files in module directories and the build system will recognize them.