Skip to content

Commit 97dccc8

Browse files
committed
Prettify
1 parent 3e5c15a commit 97dccc8

File tree

5 files changed

+22
-22
lines changed

5 files changed

+22
-22
lines changed

src/controls.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ interface IJoints {
99
}
1010

1111
/**
12-
* URDFControls: a GUI panel for controlling the viewer settings and
12+
* URDFControls: a GUI panel for controlling the viewer settings and
1313
* the robot joints
1414
*/
1515
export class URDFControls extends GUI {
@@ -76,7 +76,7 @@ export class URDFControls extends GUI {
7676

7777
/**
7878
* Checks if a given object is empty {}
79-
*
79+
*
8080
* @param obj - The object to check
8181
* @returns - True when the object is empty, or false when it is not empty
8282
*/
@@ -86,7 +86,7 @@ export class URDFControls extends GUI {
8686

8787
/**
8888
* Creates an input box and a button to modify the working path
89-
*
89+
*
9090
* @param workingPath - The path where the loader looks for mesh files
9191
* @returns - The controls to trigger callbacks when the path is changed
9292
*/
@@ -111,7 +111,7 @@ export class URDFControls extends GUI {
111111

112112
/**
113113
* Creates color selectors to modify the scene background and grid
114-
*
114+
*
115115
* @param bgColor - The background color as a three.js Color
116116
* @param gridColor - The grid color as a three.js Color
117117
* @returns - The controls to trigger callbacks when the colors are changed
@@ -154,7 +154,7 @@ export class URDFControls extends GUI {
154154

155155
/**
156156
* Converts a three.js Color to an RGB Array
157-
*
157+
*
158158
* @param color - The three.js Color to convert
159159
* @returns - The [R, G, B] Array with range [0, 255]
160160
*/
@@ -172,7 +172,7 @@ export class URDFControls extends GUI {
172172

173173
/**
174174
* Creates number sliders for each movable robot joint
175-
*
175+
*
176176
* @param joints - An object containing all of the robot's joints
177177
* @returns - The controls to trigger callbacks when any joint value changes
178178
*/

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import { IEditorLanguageRegistry } from '@jupyterlab/codemirror';
3232
// Name of the factory that creates the URDF widgets
3333
const FACTORY = 'URDF Widget Factory';
3434

35-
/**
35+
/**
3636
* Export token so other extensions can require it
3737
*/
3838
export const IURDFTracker = new Token<IWidgetTracker<URDFWidget>>(

src/layout.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export class URDFLayout extends PanelLayout {
8484

8585
/**
8686
* Updates the viewer with any new changes on the file
87-
*
87+
*
8888
* @param urdfString - The contents of the file with the new changes
8989
*/
9090
updateURDF(urdfString: string): void {
@@ -94,7 +94,7 @@ export class URDFLayout extends PanelLayout {
9494

9595
/**
9696
* Sets the robot model initially and configures loader with default values
97-
*
97+
*
9898
* @param context - Contains the URDF file and its parameters
9999
*/
100100
setURDF(context: DocumentRegistry.IContext<DocumentModel>): void {
@@ -118,7 +118,7 @@ export class URDFLayout extends PanelLayout {
118118

119119
/**
120120
* Retrieves the values for any color variable declared in CSS
121-
*
121+
*
122122
* @param colorName - The variable name of the color. Ex: '--jp-layout-color1'
123123
* @returns - The values of the color as a three.js Color
124124
*/
@@ -131,7 +131,7 @@ export class URDFLayout extends PanelLayout {
131131

132132
/**
133133
* Converts keyword or hex color definitions into three.js Color
134-
*
134+
*
135135
* @param color - A color string such as: 'red', '#aaa', or '#232323'
136136
* @returns - The same color transformed to a three.js Color
137137
*/

src/renderer.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ export class URDFRenderer extends THREE.WebGLRenderer {
2727

2828
/**
2929
* Creates a renderer to manage the scene elements
30-
*
30+
*
3131
* @param colorSky - The color of the scene background
32-
* @param colorGround - The color of the ground (grid)
32+
* @param colorGround - The color of the ground (grid)
3333
*/
3434
constructor(
3535
colorSky = new THREE.Color(0x263238),
@@ -57,7 +57,7 @@ export class URDFRenderer extends THREE.WebGLRenderer {
5757
}
5858

5959
/**
60-
* Initializes the camera
60+
* Initializes the camera
6161
*/
6262
private _initCamera(): void {
6363
this._camera.position.set(4, 4, 4);
@@ -195,7 +195,7 @@ export class URDFRenderer extends THREE.WebGLRenderer {
195195

196196
/**
197197
* Changes the height of the grid in the vertical axis (y-axis for three.js)
198-
*
198+
*
199199
* @param height - The height to shift the grid to
200200
*/
201201
setGridHeight(height = 0): void {
@@ -208,8 +208,8 @@ export class URDFRenderer extends THREE.WebGLRenderer {
208208

209209
/**
210210
* Adds a robot to the scene or updates the existing robot
211-
*
212-
* @param robot
211+
*
212+
* @param robot
213213
*/
214214
setRobot(robot: URDFRobot): void {
215215
if (this._robotIndex < 0) {

src/robot.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ import { LoadingManager } from 'three';
1818

1919
/**
2020
* XacroLoaderWithPath: a XacroLoader with a workingPath property
21-
*
21+
*
2222
* Note: XacroLoader already has a workingPath property because it is derived
23-
* from XacroParser, but it is not possible to modify directly. Thus,
23+
* from XacroParser, but it is not possible to modify directly. Thus,
2424
* workingPath is overwritten with this class.
2525
*/
2626
class XacroLoaderWithPath extends XacroLoader {
@@ -53,7 +53,7 @@ export class URDFLoadingManager extends LoadingManager {
5353

5454
/**
5555
* Sets the path where the loaders will search for robot description files
56-
*
56+
*
5757
* @param workingPath - The path to the robot files
5858
*/
5959
setWorkingPath(workingPath: string): void {
@@ -83,8 +83,8 @@ export class URDFLoadingManager extends LoadingManager {
8383
}
8484

8585
/**
86-
* Creates a robot model from a given URDF
87-
*
86+
* Creates a robot model from a given URDF
87+
*
8888
* @param robotString - The robot description in the URDF file
8989
*/
9090
setRobot(robotString = ''): void {

0 commit comments

Comments
 (0)