Skip to content
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.

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

Adding more TrajectoryBuilders in the Builder Reference #384

Open
ArushYadlapati opened this issue Jun 29, 2024 · 2 comments
Open

Adding more TrajectoryBuilders in the Builder Reference #384

ArushYadlapati opened this issue Jun 29, 2024 · 2 comments

Comments

@ArushYadlapati
Copy link

ArushYadlapati commented Jun 29, 2024

RR FTC Version

1.0

Observed Behavior

The current Builder Reference in the official Road Runner 1.0 docs only has a few TrajectoryBuilder methods, and does not explain them very well in depth. I am currently working on a complete reference for more methods in the TrajectoryBuilder class for Road Runner 1.0.

However, in order to create this, I need to know how rr.brott.dev was created, and if possible, make it open source to make contributing to it easier, similar to LearnRoadRunner. If I could get a copy of the code for the current Builder Reference page that I can add onto, that would also work as well. Finally, I am trying to embed LaTeX into this, so I would appreciate any pointers on doing so (sending me the current Builder Reference file should also work). @rbrott

Below is this list of TrajectoryBuilder's that I will be adding references to (using the Road Runner 1.0 Playground).

                 .waitSeconds(time)
                 .turn(angle)
                 .turnTo(heading)
                 .setTangent(r)
                 .setReversed(reversed)

                 .lineToY(y)/.lineToYConstantHeading(y)
                 .lineToYLinearHeading(y, heading)
                 .lineToYSplineHeading(y, heading)

                 .lineToX(x)/.lineToYConstantHeading(x)
                 .lineToXLinearHeading(x, heading)
                 .lineToXSplineHeading(x, heading)

                 .strafeTo(new Vector2d(x, y))/.strafeToConstantHeading(new Vector2d(x, y))
                 .strafeToLinearHeading(new Vector2d(x, y), Math.toRadians(heading))
                 .strafeToSplineHeading(new Vector2d(x, y), Math.toRadians(heading))

                 .splineTo(new Vector2d(x, y), tangent)
                 .splineToConstantHeading(new Vector2d(x, y), tangent)
                 .splineToSplineHeading(new Pose2d(x, y, Math.toRadians(heading)), tangent)
                 .splineToLinearHeading(new Pose2d(x, y, Math.toRadians(heading)), tangent)

Tuning Files

No response

Robot Logs

No response

@rbrott
Copy link
Member

rbrott commented Jul 8, 2024

The main source file for this page is index.md.

In general I want to have more editorial control over the docs, and I don't want to accept PRs. I may make the website source available in some form but it's not fully open source. I know not everyone is happy with this form of unattributed, ad hoc contribution, so I want you to be aware before you put any more time into this.

@ArushYadlapati
Copy link
Author

I thought this might be the case, so I also made it available as a new recipe in the Cookbook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants