Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-29 02:21:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Impove Mechanism2D documentation (NFC) (#3584)

Browse Source
This commit is contained in:
sciencewhiz
2021-09-17 22:54:10 -07:00
committed by GitHub
parent fe59e4b9fe
commit 4d5fca27ef
6 changed files with 27 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
wpilibc/src/main/native/include/frc/smartdashboard/Mechanism2d.h
View File

@@ -19,11 +19,12 @@
namespace frc {
/**
* Visual 2D representation of arms, elevators, and general mechanisms; through
* Visual 2D representation of arms, elevators, and general mechanisms through
* a node-based API.
*
* A Mechanism2d object is published and contains at least one root node. Other
* nodes (such as ligaments) are recursively based on other nodes.
* A Mechanism2d object is published and contains at least one root node. A root
* is the anchor point of other nodes (such as ligaments). Other nodes are
* recursively appended based on other nodes.
*
* Except for the Mechanism2d container object, none of the objects should be
* passed or interacted with by value! Obtain pointers from factory methods such
@@ -42,6 +43,9 @@ class Mechanism2d : public nt::NTSendable,
/**
* Create a new Mechanism2d with the given dimensions and background color.
*
* The dimensions represent the canvas that all the nodes are drawn on. The
* default color is dark blue.
*
* @param width the width
* @param height the height
*/