Backup_Repos/jsketcher
1
0
Fork 0
mirror of https://github.com/xibyte/jsketcher synced 2025-12-06 16:33:15 +01:00
Code Issues Projects Releases Wiki Activity

Minor corrections and changes to dev guide

Browse source
This commit is contained in:
Mike Molinari 2022-02-18 04:51:18 +00:00 committed by Val Erastov
parent 0fc56d1cfc
commit ad183f7293
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
DevGuide/index.md
View file

@ -42,7 +42,7 @@ The export default object requires the following things to be defined.
- **icon**: object - **icon**: object
- **[paramsInfo](#paramsInfo-tool-tip-information)**: Template for history item info popup. Can be used to expose the current values and description info about the operation for tool tips and hover over context cues. - **[paramsInfo](#paramsInfo-tool-tip-information)**: Template for history item info popup. Can be used to expose the current values and description info about the operation for tool tips and hover over context cues.
- **[schema](#Schema-fields-widget-types)**: Model defining the feature dialogs list of input fields, labels and input types. Both the user interface and the feature input properties storage is defined by this unified schema. User interface input widgets are laid out in a vertical stack with in the feature dialog in the order you define here. - **[schema](#Schema-fields-widget-types)**: Model defining the feature dialogs list of input fields, labels and input types. Both the user interface and the feature input properties storage is defined by this unified schema. User interface input widgets are laid out in a vertical stack with in the feature dialog in the order you define here.
- **run**: This is the actual code that will be executed when the preview button or the "OK" button in the feature dialog is pressed. The values defined in the schema are passed in and can be referenced by the simplified OpenCASCADE api provided by the JSKetcher OpenCASCADE wasm interface library. You can find more information about the functions exposed by this here (Add link to library docs here). - **run**: This is the actual code that will be executed when the preview button or the "OK" button in the feature dialog is pressed. The values defined in the schema are passed in and can be referenced by the simplified OpenCASCADE api provided by the JSKetcher OpenCASCADE wasm interface library. You can find more information about the functions exposed by this **[here](../web/app/cad/craft/e0/OCI.d.ts)**.
**Example index.ts file**: **Example index.ts file**:
``` ```
@ -54,7 +54,7 @@ import {EntityKind} from "cad/model/entities";
import Vector from "math/vector"; import Vector from "math/vector";
import {BooleanDefinition} from "cad/craft/schema/common/BooleanDefinition"; import {BooleanDefinition} from "cad/craft/schema/common/BooleanDefinition";
//not required but makes things nice for the IDE to know the types o things and provide nice helpful hints. //not required but makes things nice for the IDE to know the types of things and provide nice helpful hints.
interface ExtrudeParams { interface ExtrudeParams {
length: number; length: number;
face: MFace; face: MFace;