@babylonjs/inspector 6.39.0 → 6.40.0

package/dist/babylon.inspector.module.d.ts

@@ -604,12 +604,16 @@ export class Context {
      * If any current active animation has a key at the received frameNumber,
      * return the index of the animation in the active animation array, and
      * the index of the frame on the animation.
-     * @param frameNumber
+     * @param frameNumber the frame number to look for
+     * @returns null if no key was found, or an object with the animation index and key index
      */
     getKeyAtAnyFrameIndex(frameNumber: number): {
         animationIndex: number;
         keyIndex: number;
     } | null;
+    /**
+     * @returns true if any active animation has a quaternion animation
+     */
     hasActiveQuaternionAnimationKeyPoints(): boolean;
 }
 
@@ -2368,6 +2372,118 @@ export class MeshPropertyGridComponent extends React.Component<IMeshPropertyGrid
 }
 export {};
 
+}
+declare module "@babylonjs/inspector/components/actionTabs/tabs/propertyGrids/meshes/physics/physicsBodyGridComponent" {
+/// <reference types="react" />
+import { Observable } from "@babylonjs/core/Misc/observable";
+import { PhysicsBody } from "@babylonjs/core/Physics/v2/physicsBody";
+import { GlobalState } from "@babylonjs/inspector/components/globalState";
+import { PropertyChangedEvent } from "@babylonjs/inspector/propertyChangedEvent";
+import { LockObject } from "@babylonjs/inspector/tabs/propertyGrids/lockObject";
+/**
+ * Properties of the physics body grid component.
+ */
+export interface IPhysicsBodyGridComponentProps {
+    /**
+     * Lock object
+     */
+    lockObject: LockObject;
+    /**
+     * Callback raised on the property changed event
+     */
+    onPropertyChangedObservable?: Observable<PropertyChangedEvent>;
+    /**
+     * Physics body to edit
+     */
+    body: PhysicsBody;
+    /**
+     * Global state
+     */
+    globalState: GlobalState;
+}
+/**
+ * Component that allows displaying and tweaking a physics body's properties.
+ * @param props the component props
+ * @returns the component
+ */
+export function PhysicsBodyGridComponent(props: IPhysicsBodyGridComponentProps): JSX.Element;
+
+}
+declare module "@babylonjs/inspector/components/actionTabs/tabs/propertyGrids/meshes/physics/physicsMassPropertiesGridComponent" {
+/// <reference types="react" />
+import { Observable } from "@babylonjs/core/Misc/observable";
+import { PhysicsBody } from "@babylonjs/core/Physics/v2/physicsBody";
+import { GlobalState } from "@babylonjs/inspector/components/globalState";
+import { PropertyChangedEvent } from "@babylonjs/inspector/components/propertyChangedEvent";
+import { LockObject } from "@babylonjs/inspector/tabs/propertyGrids/lockObject";
+/**
+ * Properties of the physics mass properties grid component.
+ */
+export interface IPhysicsMassPropertiesGridComponentProps {
+    /**
+     * Lock object
+     */
+    lockObject: LockObject;
+    /**
+     * Callback raised on the property changed event
+     */
+    onPropertyChangedObservable?: Observable<PropertyChangedEvent>;
+    /**
+     * Physics body to edit
+     */
+    body: PhysicsBody;
+    /**
+     * Global state
+     */
+    globalState: GlobalState;
+    /**
+     * Index of the instance to edit
+     */
+    instanceIndex?: number;
+}
+/**
+ * Component that displays the mass properties of a physics body.
+ * @param props the component props
+ * @returns the component
+ */
+export function PhysicsMassPropertiesGridComponent(props: IPhysicsMassPropertiesGridComponentProps): JSX.Element;
+
+}
+declare module "@babylonjs/inspector/components/actionTabs/tabs/propertyGrids/meshes/physics/physicsMaterialGridComponent" {
+/// <reference types="react" />
+import { Observable } from "@babylonjs/core/Misc/observable";
+import { PhysicsBody } from "@babylonjs/core/Physics/v2/physicsBody";
+import { GlobalState } from "@babylonjs/inspector/components/globalState";
+import { PropertyChangedEvent } from "@babylonjs/inspector/propertyChangedEvent";
+import { LockObject } from "@babylonjs/inspector/tabs/propertyGrids/lockObject";
+/**
+ * Properties of the physics material grid component.
+ */
+export interface IPhysicsMaterialGridComponentProps {
+    /**
+     * Lock object
+     */
+    lockObject: LockObject;
+    /**
+     * Callback raised on the property changed event
+     */
+    onPropertyChangedObservable?: Observable<PropertyChangedEvent>;
+    /**
+     * Physics body to edit
+     */
+    body: PhysicsBody;
+    /**
+     * Global state
+     */
+    globalState: GlobalState;
+}
+/**
+ * Component that displays the physic material properties of a physics body.
+ * @param props the component props
+ * @returns the component
+ */
+export function PhysicsMaterialGridComponent(props: IPhysicsMaterialGridComponentProps): JSX.Element;
+
 }
 declare module "@babylonjs/inspector/components/actionTabs/tabs/propertyGrids/meshes/skeletonPropertyGridComponent" {
 import * as React from "react";
@@ -2432,7 +2548,7 @@ enum MetadataTypes {
     OBJECT = "Object",
     JSON = "JSON"
 }
-/** @ignorenaming */
+/** Metadata Grid Component */
 export class MetadataGridComponent extends React.Component<IMetadataComponentProps, {
     selectedEntityMetadata: string;
     dirty: boolean;
@@ -2443,17 +2559,25 @@ export class MetadataGridComponent extends React.Component<IMetadataComponentPro
     isValidJson: boolean;
 }> {
     private readonly _textAreaHost;
-    /** @ignorenaming */
+    /**
+     * @param props - component props
+     */
     constructor(props: IMetadataComponentProps);
     /** @ignorenaming */
     componentDidMount(): void;
-    /** @ignorenaming */
+    /**
+     * @param prevProps - previous component props
+     */
     componentDidUpdate(prevProps: Readonly<IMetadataComponentProps>): void;
     /** on entity refresh */
     refreshSelected(): void;
-    /** @ignorenaming */
+    /**
+     * @param disabled - is disabled
+     */
     setTextAreaDisabled(disabled: boolean): void;
-    /** textarea style */
+    /**
+     * @returns class name
+     */
     getClassName(): string;
     /**
      * Determines the Metadata type
@@ -2461,13 +2585,26 @@ export class MetadataGridComponent extends React.Component<IMetadataComponentPro
      * @returns MetadataTypes
      */
     getEntityType(entity: any): MetadataTypes;
-    /** @ignorenaming */
+    /**
+     * @param input - any input
+     * @returns is string
+     */
     isString(input: any): boolean;
-    /** @ignorenaming */
+    /**
+     * @param object - any object
+     * @returns is parsable
+     */
     parsableJson(object: Object): boolean;
-    /** @ignorenaming */
+    /**
+     * @param string - any string
+     * @returns parsable string
+     */
     parsableString(string: string): JSON | null;
-    /** @ignorenaming */
+    /**
+     * @param validJson - a valid json
+     * @param metadata - any metadata
+     * @returns parsed metadata
+     */
     parseMetaObject(validJson: boolean, metadata: any): any;
     /**
      * Recurse through an object to check for any Functions, returns False if found at least one
@@ -2478,7 +2615,9 @@ export class MetadataGridComponent extends React.Component<IMetadataComponentPro
     copyToClipboard(): void;
     /** Safely checks if valid JSON then appends necessary props without overwriting existing */
     populateGltfExtras(): void;
-    /** @ignorenaming */
+    /** render
+     * @returns the component
+     */
     render(): JSX.Element;
 }
 export {};
@@ -4488,6 +4627,7 @@ export class TextureHelper {
      * @param height the height of the result, which does not have to match the source texture height
      * @param face if the texture has multiple faces, the face index to use for the source
      * @param channels a filter for which of the RGBA channels to return in the result
+     * @param globalState the global state to use for rendering the texture
      * @param lod if the texture has multiple LODs, the lod index to use for the source
      * @returns the 8-bit texture data
      */
@@ -4806,6 +4946,8 @@ export interface IDraggableIconProps {
 }
 /**
  * An icon that can be dragged by the user
+ * @param props properties
+ * @returns draggable icon element
  */
 export const DraggableIcon: FC<IDraggableIconProps>;
 
@@ -4847,6 +4989,8 @@ export interface IFlexibleDragHandlerProps {
 }
 /**
  * This component receives the drop events and updates the layout accordingly
+ * @param props properties
+ * @returns DragHandler element
  */
 export const FlexibleDragHandler: FC<IFlexibleDragHandlerProps>;
 
@@ -4869,6 +5013,8 @@ export interface IFlexibleDropZoneProps {
 /**
  * This component contains the drag and drop zone for the resize bars that
  * allow redefining width and height of layout elements
+ * @param props properties
+ * @returns drop zone element
  */
 export const FlexibleDropZone: FC<IFlexibleDropZoneProps>;
 
@@ -4882,6 +5028,7 @@ export interface IFlexibleGridContainerProps {
 }
 /**
  * Component responsible for mapping the layout to the actual components
+ * @returns GridContainer element
  */
 export const FlexibleGridContainer: FC<IFlexibleGridContainerProps>;
 
@@ -4901,6 +5048,8 @@ export interface IFlexibleGridLayoutProps {
 /**
  * This component represents a grid layout that can be resized and rearranged
  * by the user.
+ * @param props properties
+ * @returns layout element
  */
 export const FlexibleGridLayout: FC<IFlexibleGridLayoutProps>;
 
@@ -4944,6 +5093,8 @@ export type ResizeItem = {
 };
 /**
  * A component that renders a bar that the user can drag to resize.
+ * @param props properties
+ * @returns resize bar element
  */
 export const FlexibleResizeBar: FC<IFlexibleRowResizerProps>;
 
@@ -4981,6 +5132,8 @@ export interface IFlexibleTabProps {
  * to activate or drag to reorder. It also listens for
  * drop events if the user wants to drop another tab
  * after it.
+ * @param props properties
+ * @returns FlexibleTab element
  */
 export const FlexibleTab: FC<IFlexibleTabProps>;
 
@@ -5012,6 +5165,8 @@ export interface IFlexibleTabsContainerProps {
 /**
  * This component contains a set of tabs of which only one is visible at a time.
  * The tabs can also be dragged from and to different containers.
+ * @param props properties
+ * @returns tabs container element
  */
 export const FlexibleTabsContainer: FC<IFlexibleTabsContainerProps>;
 
@@ -5135,11 +5290,15 @@ export const getPosInLayout: (layout: Layout, column: number, row?: number) => L
 export const removeLayoutRowAndRedistributePercentages: (layout: Layout, column: number, row: number) => void;
 /**
  * Add a percentage string to a number
+ * @param p1 the percentage string
+ * @param p2 the number
+ * @returns the sum of the percentage string and the number
  */
 export const addPercentageStringToNumber: (p1: string, p2: number) => number;
 /**
  * Parses a percentage string into a number
  * @param p the percentage string
+ * @returns the parsed number
  */
 export const parsePercentage: (p: string) => number;
 
@@ -5351,6 +5510,7 @@ export interface IGraphConnectorHandlerProps {
 /**
  * This component is used to initiate a connection between two nodes. Simply
  * drag the handle in a node and drop it in another node to create a connection.
+ * @returns connector element
  */
 export const GraphConnectorHandler: FC<IGraphConnectorHandlerProps>;
 
@@ -5420,6 +5580,8 @@ export const MarkerArrowId = "arrow";
 /**
  * This component draws a SVG line between two points, with an optional marker
  * indicating direction
+ * @param props properties
+ * @returns graph line element
  */
 export const GraphLine: FC<IGraphLineProps>;
 
@@ -5467,6 +5629,8 @@ export interface IGraphContainerProps {
 }
 /**
  * This component contains all the nodes and handles their dragging
+ * @param props properties
+ * @returns graph node container element
  */
 export const GraphNodesContainer: FC<IGraphContainerProps>;
 
@@ -5562,6 +5726,8 @@ export interface ITextInputProps {
 }
 /**
  * This component represents a text input that can be submitted or cancelled on buttons
+ * @param props properties
+ * @returns TextInputWithSubmit element
  */
 export const TextInputWithSubmit: (props: ITextInputProps) => JSX.Element;
 
@@ -5844,6 +6010,7 @@ interface IFloatLineComponentProps {
     unit?: React.ReactNode;
     onDragStart?: (newValue: number) => void;
     onDragStop?: (newValue: number) => void;
+    disabled?: boolean;
 }
 export class FloatLineComponent extends React.Component<IFloatLineComponentProps, {
     value: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@babylonjs/inspector",
-    "version": "6.39.0",
+    "version": "6.40.0",
     "module": "dist/babylon.inspector.bundle.max.js",
     "main": "dist/babylon.inspector.bundle.max.js",
     "typings": "dist/babylon.inspector.module.d.ts",
@@ -32,12 +32,12 @@
         "@types/react-dom": ">=16.0.9"
     },
     "devDependencies": {
-        "@babylonjs/core": "^6.39.0",
-        "@babylonjs/gui": "^6.39.0",
-        "@babylonjs/gui-editor": "^6.39.0",
-        "@babylonjs/loaders": "^6.39.0",
-        "@babylonjs/materials": "^6.39.0",
-        "@babylonjs/serializers": "^6.39.0",
+        "@babylonjs/core": "^6.40.0",
+        "@babylonjs/gui": "^6.40.0",
+        "@babylonjs/gui-editor": "^6.40.0",
+        "@babylonjs/loaders": "^6.40.0",
+        "@babylonjs/materials": "^6.40.0",
+        "@babylonjs/serializers": "^6.40.0",
         "@lts/gui": "1.0.0",
         "react": "^17.0.2",
         "react-dom": "^17.0.2"