@wandelbots/wandelbots-js-react-components 1.4.3 → 1.5.1

package/README.md

@@ -28,7 +28,7 @@ import { WandelscriptEditor, ... } from '@wandelbots/wandelbots-js-react-compone
         </ul>
         <li><a href="#viewport">3D Viewport</a></li>
         <ul>
-          <li><a href="#robots">Robots</a></li>
+          <li><a href="#robot">Robot</a></li>
           <li><a href="#lightning">Lightning</a></li>
           <li><a href="#safety">Safety Zones</a></li>
         </ul>
@@ -56,27 +56,64 @@ type WandelscriptEditorProps = {
 
 ### Viewport
 
-#### Robots
+#### Robot
 
-This `SupportedRobot` component adds the robot to the 3D viewport. Use it together with the `connectedMotionGroup` from `@wandelbots/wandelbots-js`.
+<img width="20%" alt="Screenshot 2024-08-08 at 14 17 55" src="https://github.com/user-attachments/assets/da661136-8b53-48ba-85de-63b09e3b51f3">
+
+This `Robot` component adds the robot to the 3D viewport. Use it together with the `connectedMotionGroup` from `@wandelbots/wandelbots-js`.
 
 ```tsx
-<SupportedRobot connectedMotionGroup={activeRobot} />
+<Robot connectedMotionGroup={connectedMotionGroup} />
 ```
 
 The robot model are loaded from the [jsdelivr CDN](https://cdn.jsdelivr.net/gh/wandelbotsgmbh/wandelbots-js-react-components/public/models/).
 
-In case you want to use the application offline, you can download the models and host them locally. You can override the URL resolver of the `SupportedRobot` component by passing a `getModel` function like:
+In case you want to use the application offline, you can download the models and host them locally. You can override the URL resolver of the `Robot` component by passing a `getModel` function like:
+
+```tsx
+<Robot
+  getModel={() =>
+    `public/${connectedMotionGroup.modelFromController}.glb`
+  }
+  connectedMotionGroup={connectedMotionGroup}
+/>
+```
+
+```tsx
+export type ConnectecMotionGroupRobotProps = {
+  connectedMotionGroup: ConnectedMotionGroup // The connected motion group from wandelbots-js
+  getModel?: (modelFromController: string) => string // A function that returns the URL of the robot model
+  isGhost?: boolean // Whether the robot should be displayed transparently
+} & GroupProps
+```
+
+##### SupportedRobot
+
+The `SupportedRobot` can be used to display a robot model without the need for a `connectedMotionGroup` from `@wandelbots/wandelbots-js`.
 
 ```tsx
 <SupportedRobot
+  rapidlyChangingMotionState={
+    rapidlyChangingMotionState
+  }
+  dhParameters={dhParameters as any}
+  modelFromController={modelFromController || ""}
   getModel={() =>
-    `public/${activeRobot.modelFromController}.glb`
+    `./robot-pad/models/${modelFromController}.glb`
   }
-  connectedMotionGroup={activeRobot}
 />
 ```
 
+```tsx
+export type SupportedRobotProps = {
+  rapidlyChangingMotionState: MotionGroupStateResponse // The motion state of the robot
+  modelFromController: string // The model name of the robot
+  dhParameters: DHParameter[] // The DH parameters of the robot
+  getModel?: (modelFromController: string) => string // A function that returns the URL of the robot model
+  isGhost?: boolean // Whether the robot should be displayed transparently
+} & GroupProps
+```
+
 #### Lightning 
 
 The `PresetEnvironment` component adds a default lighting setup to the 3D viewport.
@@ -90,7 +127,7 @@ The `PresetEnvironment` component adds a default lighting setup to the 3D viewpo
 The `SafetyZonesRenderer` component visualizes the safety zones of the controller.
 
 ```tsx
-<SafetyZonesRenderer safetyZones={activeRobot.safetyZones||[]}/>
+<SafetyZonesRenderer safetyZones={connectedMotionGroup.safetyZones||[]}/>
 ```
 
 

package/dist/components/robots/Robot.d.ts

@@ -3,6 +3,7 @@ import type { ConnectedMotionGroup } from "@wandelbots/wandelbots-js";
 export type ConnectecMotionGroupRobotProps = {
     connectedMotionGroup: ConnectedMotionGroup;
     getModel?: (modelFromController: string) => string;
+    isGhost?: boolean;
 } & GroupProps;
 /**
  * The Robot component is a wrapper around the SupportedRobot component
@@ -15,5 +16,5 @@ export type ConnectecMotionGroupRobotProps = {
  *
  * @returns {JSX.Element} The rendered SupportedRobot component.
  */
-export declare function Robot({ connectedMotionGroup, getModel, ...props }: ConnectecMotionGroupRobotProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function Robot({ connectedMotionGroup, getModel, isGhost, ...props }: ConnectecMotionGroupRobotProps): import("react/jsx-runtime").JSX.Element | null;
 //# sourceMappingURL=Robot.d.ts.map

package/dist/components/robots/Robot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Robot.d.ts","sourceRoot":"","sources":["../../../src/components/robots/Robot.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAEpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAGrE,MAAM,MAAM,8BAA8B,GAAG;IAC3C,oBAAoB,EAAE,oBAAoB,CAAA;IAC1C,QAAQ,CAAC,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,MAAM,CAAA;CACnD,GAAG,UAAU,CAAA;AAEd;;;;;;;;;;GAUG;AACH,wBAAgB,KAAK,CAAC,EACpB,oBAAoB,EACpB,QAA0B,EAC1B,GAAG,KAAK,EACT,EAAE,8BAA8B,kDAgBhC"}
+{"version":3,"file":"Robot.d.ts","sourceRoot":"","sources":["../../../src/components/robots/Robot.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAEpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAGrE,MAAM,MAAM,8BAA8B,GAAG;IAC3C,oBAAoB,EAAE,oBAAoB,CAAA;IAC1C,QAAQ,CAAC,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,MAAM,CAAA;IAClD,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,GAAG,UAAU,CAAA;AAEd;;;;;;;;;;GAUG;AACH,wBAAgB,KAAK,CAAC,EACpB,oBAAoB,EACpB,QAA0B,EAC1B,OAAe,EACf,GAAG,KAAK,EACT,EAAE,8BAA8B,kDAiBhC"}

package/dist/components/robots/SupportedRobot.d.ts

@@ -13,7 +13,8 @@ export type SupportedRobotProps = {
     modelFromController: string;
     dhParameters: DHParameter[];
     getModel?: (modelFromController: string) => string;
+    isGhost?: boolean;
 } & GroupProps;
 export declare function defaultGetModel(modelFromController: string): string;
-export declare function SupportedRobot({ rapidlyChangingMotionState, modelFromController, dhParameters, getModel, ...props }: SupportedRobotProps): import("react/jsx-runtime").JSX.Element;
+export declare function SupportedRobot({ rapidlyChangingMotionState, modelFromController, dhParameters, getModel, isGhost, ...props }: SupportedRobotProps): import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=SupportedRobot.d.ts.map

package/dist/components/robots/SupportedRobot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SupportedRobot.d.ts","sourceRoot":"","sources":["../../../src/components/robots/SupportedRobot.tsx"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EACV,wBAAwB,EACxB,WAAW,EACZ,MAAM,mCAAmC,CAAA;AAG1C,MAAM,MAAM,YAAY,GAAG;IACzB,0BAA0B,EAAE,wBAAwB,CAAA;IACpD,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;CACjC,GAAG,UAAU,CAAA;AAEd,MAAM,MAAM,UAAU,GAAG;IACvB,0BAA0B,EAAE,wBAAwB,CAAA;IACpD,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,UAAU,CAAA;AAEd,MAAM,MAAM,mBAAmB,GAAG;IAChC,0BAA0B,EAAE,wBAAwB,CAAA;IACpD,mBAAmB,EAAE,MAAM,CAAA;IAC3B,YAAY,EAAE,WAAW,EAAE,CAAA;IAC3B,QAAQ,CAAC,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,MAAM,CAAA;CACnD,GAAG,UAAU,CAAA;AAEd,wBAAgB,eAAe,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,wBAAgB,cAAc,CAAC,EAC7B,0BAA0B,EAC1B,mBAAmB,EACnB,YAAY,EACZ,QAA0B,EAC1B,GAAG,KAAK,EACT,EAAE,mBAAmB,2CA0FrB"}
+{"version":3,"file":"SupportedRobot.d.ts","sourceRoot":"","sources":["../../../src/components/robots/SupportedRobot.tsx"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EACV,wBAAwB,EACxB,WAAW,EACZ,MAAM,mCAAmC,CAAA;AAK1C,MAAM,MAAM,YAAY,GAAG;IACzB,0BAA0B,EAAE,wBAAwB,CAAA;IACpD,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;CACjC,GAAG,UAAU,CAAA;AAEd,MAAM,MAAM,UAAU,GAAG;IACvB,0BAA0B,EAAE,wBAAwB,CAAA;IACpD,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,UAAU,CAAA;AAEd,MAAM,MAAM,mBAAmB,GAAG;IAChC,0BAA0B,EAAE,wBAAwB,CAAA;IACpD,mBAAmB,EAAE,MAAM,CAAA;IAC3B,YAAY,EAAE,WAAW,EAAE,CAAA;IAC3B,QAAQ,CAAC,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,MAAM,CAAA;IAClD,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,GAAG,UAAU,CAAA;AAEd,wBAAgB,eAAe,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,wBAAgB,cAAc,CAAC,EAC7B,0BAA0B,EAC1B,mBAAmB,EACnB,YAAY,EACZ,QAA0B,EAC1B,OAAe,EACf,GAAG,KAAK,EACT,EAAE,mBAAmB,2CAkMrB"}

package/dist/icons/robot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"robot.d.ts","sourceRoot":"","sources":["../../src/icons/robot.tsx"],"names":[],"mappings":"AAEA,wBAAgB,SAAS,4CAWxB"}
+{"version":3,"file":"robot.d.ts","sourceRoot":"","sources":["../../src/icons/robot.tsx"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,4CAiBxB"}