Skip to content

Commit

Permalink
Add relative links, fix github button in toml
Browse files Browse the repository at this point in the history
  • Loading branch information
@ArushYadlapati
ArushYadlapati committed Sep 5, 2024
1 parent cd1dacb commit d669370
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
4 changes: 2 additions & 2 deletions book.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ kt = "# "
[output.html]
mathjax-support = true
site-url = "/cookbook/"
git-repository-url = "https://github.com/ArushYadlapati/cookbook/tree/main"
edit-url-template = "https://github.com/ArushYadlapati/cookbook/tree/main/{path}"
git-repository-url = "https://github.com/dr-hextanium/cookbook/tree/main"
edit-url-template = "https://github.com/dr-hextanium/cookbook/tree/main/{path}"
44 changes: 22 additions & 22 deletions src/roadrunner_10/complete_trajectorybuilder_reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,34 @@ The current [TrajectoryBuilder Reference](https://rr.brott.dev/docs/v1-0/builder

### Table of Contents

#### [Path Primitives:](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#path-primitives-1)
1. [`waitSeconds(double: seconds)`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#waitsecondsdouble-seconds)
2. [`turn(Math.toRadians(double: angle))`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#turnmathtoradiansdouble-angle)
3. [`turnTo(Math.toRadians(double: heading))`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#turntomathtoradiansdouble-heading)
4. [`setTangent(double: r)`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#settangentdouble-r)
5. [`setReversed(boolean: reversed)`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#setreversedboolean-reversed)
6. [`.strafeTo(new Vector2d(double: x, double: y))` & `.strafeToConstantHeading(new Vector2d(x: double, y: double))`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#strafetonew-vector2ddouble-x-double-y--strafetoconstantheadingnew-vector2dx-double-y-double)
7. [`strafeToLinearHeading(new Vector2d(x, y), Math.toRadians(heading))`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#strafetolinearheadingnew-vector2dx-y-mathtoradiansheading)
8. [`strafeToSplineHeading(new Vector2d(x, y), Math.toRadians(heading))`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#strafetosplineheadingnew-vector2dx-y-mathtoradiansheading)
9. [`lineToX(x: double) & .lineToXConstantHeading(x: double)`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#linetoxx-double--linetoxconstantheadingx-double)
10. [`lineToY(y: double) & .lineToYConstantHeading(y: double)`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#linetoyy-double--linetoyconstantheadingy-double)
11. [`splineTo(new Vector2d(x, y), tangent)`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#splinetonew-vector2dx-y-tangent--heading-is--fracpi6-)
#### [Path Primitives:](../roadrunner_10/complete_trajectorybuilder_reference.md#path-primitives-1)
1. [`waitSeconds(double: seconds)`](../roadrunner_10/complete_trajectorybuilder_reference.md#waitsecondsdouble-seconds)
2. [`turn(Math.toRadians(double: angle))`](../roadrunner_10/complete_trajectorybuilder_reference.md#turnmathtoradiansdouble-angle)
3. [`turnTo(Math.toRadians(double: heading))`](../roadrunner_10/complete_trajectorybuilder_reference.md#turntomathtoradiansdouble-heading)
4. [`setTangent(double: r)`](../roadrunner_10/complete_trajectorybuilder_reference.md#settangentdouble-r)
5. [`setReversed(boolean: reversed)`](../roadrunner_10/complete_trajectorybuilder_reference.md#setreversedboolean-reversed)
6. [`.strafeTo(new Vector2d(double: x, double: y))` & `.strafeToConstantHeading(new Vector2d(x: double, y: double))`](../roadrunner_10/complete_trajectorybuilder_reference.md#strafetonew-vector2ddouble-x-double-y--strafetoconstantheadingnew-vector2dx-double-y-double)
7. [`strafeToLinearHeading(new Vector2d(x, y), Math.toRadians(heading))`](../roadrunner_10/complete_trajectorybuilder_reference.md#strafetolinearheadingnew-vector2dx-y-mathtoradiansheading)
8. [`strafeToSplineHeading(new Vector2d(x, y), Math.toRadians(heading))`](../roadrunner_10/complete_trajectorybuilder_reference.md#strafetosplineheadingnew-vector2dx-y-mathtoradiansheading)
9. [`lineToX(x: double) & .lineToXConstantHeading(x: double)`](../roadrunner_10/complete_trajectorybuilder_reference.md#linetoxx-double--linetoxconstantheadingx-double)
10. [`lineToY(y: double) & .lineToYConstantHeading(y: double)`](../roadrunner_10/complete_trajectorybuilder_reference.md#linetoyy-double--linetoyconstantheadingy-double)
11. [`splineTo(new Vector2d(x, y), tangent)`](../roadrunner_10/complete_trajectorybuilder_reference.md#splinetonew-vector2dx-y-tangent--heading-is--fracpi6-)

#### [Heading Primitives:](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#heading-primitives-1)
12. [`Tangent Heading (default)`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#tangent-heading-default)
13. [`Constant Heading`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#constant-heading)
14. [`Linear Heading`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#linear-heading)
15. [`Spline Heading`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#spline-heading)
#### [Heading Primitives:](../roadrunner_10/complete_trajectorybuilder_reference.md#heading-primitives-1)
12. [`Tangent Heading (default)`](../roadrunner_10/complete_trajectorybuilder_reference.md#tangent-heading-default)
13. [`Constant Heading`](../roadrunner_10/complete_trajectorybuilder_reference.md#constant-heading)
14. [`Linear Heading`](../roadrunner_10/complete_trajectorybuilder_reference.md#linear-heading)
15. [`Spline Heading`](../roadrunner_10/complete_trajectorybuilder_reference.md#spline-heading)

### Path Primitives

The begin pose is the origin `(0,0)` with a heading of \\( \frac{\pi}{6} \\), with the exception of [`splineTo(new Vector2d(x, y), tangent)`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html#splinetonew-vector2dx-y-tangent--heading-is--fracpi6-), which has a heading of \\( \frac{\pi}{2} \\).
The begin pose is the origin `(0,0)` with a heading of \\( \frac{\pi}{6} \\), with the exception of [`splineTo(new Vector2d(x, y), tangent)`](../roadrunner_10/complete_trajectorybuilder_reference.md#splinetonew-vector2dx-y-tangent--heading-is--fracpi6-), which has a heading of \\( \frac{\pi}{2} \\).


#### `waitSeconds(double: seconds)`

> 🚨 **WARNING:** 🚨
> Ensure that you are using `waitSeconds()` and not `wait()`. All Java objects have a `wait()` function which causes the current thread to wait until another thread invokes a `notify()` or `notifyAll()` method. See further details in the [Oracle JavaDoc](https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html#wait()). We don't care for this function but it does show up in intellisense. Make sure you are using the `waitSeconds()` function instead of `wait()`.
> Ensure that you are using `waitSeconds()` and not `wait()`. All Java objects have a `wait()` function which causes the current thread to wait until another thread invokes a `notify()` or `notifyAll()` method. See further details in the [Oracle JavaDoc](https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html#wait()). We don't care for this function, but it does show up in intellisense. Make sure you are using the `waitSeconds()` function instead of `wait()`.
```java
{{#rustdoc_include BuilderReference.java:1:4}}
Expand Down Expand Up @@ -359,7 +359,7 @@ The begin pose is the origin `(0,0)` with a heading of \\( \frac{\pi}{6} \\), wi
#### `lineToX(x: double)` & `.lineToXConstantHeading(x: double)`

> 🚨 **WARNING:** 🚨
> It is **HIGHLY RECOMMENDED** to use [`.strafeTo()`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html) instead of any `lineTo()`'s! 🚨
> It is **HIGHLY RECOMMENDED** to use [`.strafeTo()`](../roadrunner_10/complete_trajectorybuilder_reference.md) instead of any `lineTo()`'s! 🚨
```java
{{#rustdoc_include BuilderReference.java:90:95}}
Expand Down Expand Up @@ -399,13 +399,13 @@ The begin pose is the origin `(0,0)` with a heading of \\( \frac{\pi}{6} \\), wi
#### `lineToY(y: double)` & `.lineToYConstantHeading(y: double)`

> 🚨 **WARNING:** 🚨
> It is **HIGHLY RECOMMENDED** to use [`.strafeTo()`](https://arushyadlapati.github.io/cookbook/roadrunner_10/complete_trajectorybuilder_reference.html) instead of any `lineTo()`'s! 🚨
> It is **HIGHLY RECOMMENDED** to use [`.strafeTo()`](../roadrunner_10/complete_trajectorybuilder_reference.md) instead of any `lineTo()`'s! 🚨
```java
{{#rustdoc_include BuilderReference.java:99:104}}
```

<div class = "video-container-13">
<div class = "video-container-10">
<iframe width="505" height="650"
src="https://rr-playground-server.brott.dev/4929bf3f-74f5-45d8-bd1d-244c9ffaaa0d.mp4?autoplay=0" title="waitSeconds()" style="border: none;">
</iframe>
Expand Down

0 comments on commit d669370

Please sign in to comment.