IG Data Creation Wiki

User Tools

Site Tools

Trace:
ig:gfx:shapecreator:specification

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
ig:gfx:shapecreator:specification [2021/08/31 14:35] – ig_sbig:gfx:shapecreator:specification [2024/04/04 08:04] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ==== IG.GFX.ShapeCreator Format definition and examples ==== ==== IG.GFX.ShapeCreator Format definition and examples ====
  
-ENGLISH VERSION, [[ig:gfx:shapecreator:specification_de|Link]]+Please note that the wiki version of the documentation is not up to date. 
 + 
 +Please download the latest version as PDF from the following sources. 
 + 
 +Bitte beachten sie, das die Wiki Version der Dokumentation nicht aktuell ist. 
 + 
 +Bitte laden sie die aktuelle Version als PDF von den folgenden Quellen. 
 + 
 +{{ :ig:gfx:shapecreator:specification_en-1.1.pdf |Download as PDF}} 
 + 
 +{{ :ig:gfx:shapecreator:specification_de-1.1.pdf |Download german version (Deutsche Version) as PDF}}
  
 Shape files are created in JSON format and are therefore subject to the requirements for this format. Shape files are created in JSON format and are therefore subject to the requirements for this format.
Line 9: Line 19:
 Shape files consist of the following objects on the first level: Shape files consist of the following objects on the first level:
  
-* Scheme (optional), +  * Scheme (optional), 
-* General SVG settings (#svg), +  * General SVG settings (#svg), 
-* General furniture settings (#common) und +  * General furniture settings (#common) and 
-* List of all symbols (Shapes).+  * List of all symbols (Shapes).
  
 For all length values: format is **Number**, the decimal separator is a **.** and **m** is expected as unit. For all length values: format is **Number**, the decimal separator is a **.** and **m** is expected as unit.
Line 33: Line 43:
 | AttachMode   | String  | LR      | Creates, if **AttachPoints** is true, the left (L) and/or right (R) attachment line. | | AttachMode   | String  | LR      | Creates, if **AttachPoints** is true, the left (L) and/or right (R) attachment line. |
  
-Addendum lines should only be created if you are dealing with single elements that can be planned. You should not create any lines for composite elements.+Attachment lines should only be created if you are dealing with single elements that can be planned. You should not create any lines for composite elements.
  
 == Inheritance == == Inheritance ==
Line 41: Line 51:
 **Example** **Example**
  
 +<code>
 +{
     "#svg": {     "#svg": {
         ...         ...
Line 59: Line 71:
     ...     ...
     }     }
 +}
 +</code>
  
 === General furniture settings === === General furniture settings ===
Line 75: Line 89:
 **Notes** **Notes**
  
-* ArmrestWidth should always be specified in the **#common** object. If the value is not known, **0.15** should be used. +  * ArmrestWidth should always be specified in the **#common** object. If the value is not known, **0.15** should be used. 
-* ArmrestWidth is always included in the calculation of the total width, so when determining the width of a couch, the value should be taken into account. +  * ArmrestWidth is always included in the calculation of the total width, so when determining the width of a couch, the value should be taken into account. 
-* ArmrestDepth should always be specified in the **#common** object. If the value is not known, **1.00** should be used. +  * ArmrestDepth should always be specified in the **#common** object. If the value is not known, **1.00** should be used. 
-* BackseatDepth should always be specified in the **#common** object. If the value is not known, **0.15** should be used. +  * BackseatDepth should always be specified in the **#common** object. If the value is not known, **0.15** should be used. 
-* SeatDepth should always be specified in the **#common** object. If the value is not known, **0.85** should be used. +  * SeatDepth should always be specified in the **#common** object. If the value is not known, **0.85** should be used. 
-* SeatDepth plus BackseatDepth gives the total depth of the couch.+  * SeatDepth plus BackseatDepth gives the total depth of the couch.
  
 **Example** **Example**
  
-`"#common": {` +<code> 
-        `"Mode": "cushion",` +"#common": { 
-        `"ArmrestWidth": 0.15,` +       "Mode": "cushion", 
-        `"ArmrestDepth": 0.72,` +       "ArmrestWidth": 0.15, 
-        `"BackseatDepth": 0.15,` +       "ArmrestDepth": 0.72, 
-        `"SeatDepth": 0.57,` +       "BackseatDepth": 0.15, 
-        `"Rounding": 0.05,` +       "SeatDepth": 0.57, 
-        `"Model": "test"` +       "Rounding": 0.05, 
-`    }`+       "Model": "test" 
 +} 
 +</code>    
  
 === Symbols === === Symbols ===
Line 102: Line 118:
 Parts and drawing elements in turn can have defined properties that influence the generation of SVG symbols. Parts and drawing elements in turn can have defined properties that influence the generation of SVG symbols.
  
-BILD+{{ :ig:gfx:shapecreator:npartsandelements.png?nolink&400 |}}
  
 **Figure**: Components (red text) and associated drawing elements (black text). **Figure**: Components (red text) and associated drawing elements (black text).
Line 110: Line 126:
 == Example 1, Stool == == Example 1, Stool ==
  
-`"Hocker_100x100": {` +<code> 
-            `"hocker": {` +"Hocker_100x100": { 
-                `"Width": 1.0,` +            "hocker": { 
-                `"Depth": 1.0,` +               "Width": 1.0, 
-                `"#box": {` +               "Depth": 1.0, 
-                    `"corner": "round"` +               "#box": { 
-                `}` +                    "corner": "round" 
-            `}` +               } 
-`        }`+            } 
 +} 
 +</code>
  
 A stool usually consists of exactly one component, here **"stool "**. The width and depth are specified as 1.0 m. The defined drawing element **#box** is used for the representation, here with round corners. The diameter of the corners is taken from the general furniture settings (#common, Rounding). A stool usually consists of exactly one component, here **"stool "**. The width and depth are specified as 1.0 m. The defined drawing element **#box** is used for the representation, here with round corners. The diameter of the corners is taken from the general furniture settings (#common, Rounding).
  
-BILD+{{ :ig:gfx:shapecreator:ppropsparts.png?nolink&400 |}}
  
-**Image**: Stool with character element #box and the properties+**Figure**: Stool with character element #box and the properties
  
 **Width** and **Depth** are properties of the component **"stool "**, corner is a property of the defined drawing element **#box**. **Width** and **Depth** are properties of the component **"stool "**, corner is a property of the defined drawing element **#box**.
Line 130: Line 148:
 == Example 2, Combination of 2-seater and Recamier == == Example 2, Combination of 2-seater and Recamier ==
  
-`"2SEATER_REC_RECHTS": {` +<code> 
-            `"2": {` +"2SEATER_REC_RECHTS": { 
-                `"Width": 1.4,` +            "2": { 
-                `"#armrest#1": {` +                "Width": 1.4, 
-                    `"corner_3": "round",` +                "#armrest#1": { 
-                    `"diameter_3": 0.075` +                    "corner_3": "round", 
-                `},` +                    "diameter_3": 0.075 
-                `"#seat#1": {},` +                }, 
-                `"#seat#2": {}` +                "#seat#1": {}, 
-            `},` +                "#seat#2": {} 
-            `"rec": {` +            }, 
-                `"Width": 1.1,` +            "rec": { 
-                `"#seat#1": {` +                "Width": 1.1, 
-                    `"SeatDepth": 1.2,` +                "#seat#1": { 
-                    `"corner_2": "round",` +                    "SeatDepth": 1.2, 
-                    `"diameter_2": 0.05,` +                    "corner_2": "round", 
-                    `"corner_3": "round",` +                    "diameter_2": 0.05, 
-                    `"diameter_3": 0.05` +                    "corner_3": "round", 
-                `},` +                    "diameter_3": 0.05 
-                `"#armrest#1": {` +                }, 
-                    `"corner_2": "round",` +                "#armrest#1": { 
-                    `"diameter_2": 0.075` +                    "corner_2": "round", 
-                `}` +                    "diameter_2": 0.075 
-            `}` +                } 
-`        }`+            } 
 +} 
 +</code>
  
 This combination has a total width of 2.8 m and a total depth of 1.35 m (recamiere). The sofa itself is 0.72 m deep with a back section depth of 0.15 m. This combination has a total width of 2.8 m and a total depth of 1.35 m (recamiere). The sofa itself is 0.72 m deep with a back section depth of 0.15 m.
Line 160: Line 180:
 The combination consists of the components "2" (2-seater sofa with armrest left) and "rec" (recamier with armrest right). The sofa has a total width of 1.55 m (incl. armrest) and the recamier has a total width of 1.25 m (incl. armrest). The combination consists of the components "2" (2-seater sofa with armrest left) and "rec" (recamier with armrest right). The sofa has a total width of 1.55 m (incl. armrest) and the recamier has a total width of 1.25 m (incl. armrest).
  
-![](C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nPropsPartsElements.png)+{{ :ig:gfx:shapecreator:npropspartselements.png?direct&400 }}
  
 **Figure**: Combination of several components and elements and the properties (exemplary). **Figure**: Combination of several components and elements and the properties (exemplary).
Line 170: Line 190:
 The following example shows a corner combination. The following example shows a corner combination.
  
-`"2_e_3": {` +<code> 
-            `"2": {` +"2_e_3": { 
-                `"Width": 1.4,` +            "2": { 
-                `"Rotation": -90,` +                "Width": 1.4, 
-                `"#armrest#1": {` +                "Rotation": -90, 
-                    `"corner_3": "round",` +                "#armrest#1": { 
-                    `"diameter_3": 0.075` +                    "corner_3": "round", 
-                `},` +                    "diameter_3": 0.075 
-                `"#seat#1": {},` +                }, 
-                `"#seat#2": {}` +                "#seat#1": {}, 
-            `},` +                "#seat#2": {} 
-            `"e": {` +            }, 
-                `"#corner#1": {` +            "e": { 
-                    `"Width": 0.83,` +                "#corner#1": { 
-                    `"Depth": 0.83,` +                    "Width": 0.83, 
-                    `"Orientation": "left"` +                    "Depth": 0.83, 
-                `}` +                    "Orientation": "left" 
-            `},` +                } 
-            `"3": {` +            }, 
-                `"Width": 2.1,` +            "3": { 
-                `"#seat#1": {},` +                "Width": 2.1, 
-                `"#seat#2": {},` +                "#seat#1": {}, 
-                `"#seat#13": {},` +                "#seat#2": {}, 
-                `"#armrest#1": {` +                "#seat#13": {}, 
-                    `"corner_2": "round",` +                "#armrest#1": { 
-                    `"diameter_2": 0.075` +                    "corner_2": "round", 
-                `}` +                    "diameter_2": 0.075 
-            `}` +                } 
-`        }`+            } 
 +} 
 +</code>
  
 For corners it is important to rotate the corresponding parts before corner using the **Rotation** property. In this case it is left aligned corner with a rotation of -90°, for right aligned corners the rotation must be set to 90°. For corners it is important to rotate the corresponding parts before corner using the **Rotation** property. In this case it is left aligned corner with a rotation of -90°, for right aligned corners the rotation must be set to 90°.
  
-## Component properties+=== Component properties ===
  
-Components support the following features:+Components support the following properties:
  
 | Property      | Type   | Default | Description/Values                                           | | Property      | Type   | Default | Description/Values                                           |
-| ------------- | ------ | ------- | ------------------------------------------------------------ | 
 | Width         | Number | 1.0     | Specifies the total width of the component.                  | | Width         | Number | 1.0     | Specifies the total width of the component.                  |
 | Depth         | Number | 1.0     | Specifies the total depth of the component.                  | | Depth         | Number | 1.0     | Specifies the total depth of the component.                  |
Line 217: Line 238:
 | SeatDepth     | Number | 0.85    | Specifies the seating depth of the sofas (**cushion** mode). | | SeatDepth     | Number | 0.85    | Specifies the seating depth of the sofas (**cushion** mode). |
  
-### Inheritance+== Inheritance ==
  
 All parts and drawing elements use the values defined in the general #common settings. However, these can be overridden per part (or drawing element) if required, as indicated in the table above. All parts and drawing elements use the values defined in the general #common settings. However, these can be overridden per part (or drawing element) if required, as indicated in the table above.
  
-## Properties of drawing elements+=== Properties of drawing elements ===
  
-* The following drawing elements are defined in the "**cushion**" mode and can be used in the parts:+The following drawing elements are defined in the "**cushion**" mode and can be used in the parts: 
 +  * #box: a box with width and height and optional round corners 
 +  * #seat: a seat with backrest, with the property "**RenderMode**" the rendering can be adapted for different purposes, see overview below 
 +  * #armrest: an armrest with optional rounded corners, see overview below 
 +  * #corner: corners are special drawing elements to be able to plan combinations around corners
  
-  * #box +Each drawing element can have the following properties:
-    A box with width and height and optional round corners +
-  * #seat +
-    A seat with backrest +
-    With the property "**RenderMode**" the rendering can be adapted for different purposes, see overview below +
-  * #armrest +
-    An armrest with optional rounded corners, see overview below +
-  * #corner +
-    Corners are special drawing elements to be able to plan combinations around corners +
- +
-  Each drawing element can have the following properties:+
  
 | Property      | Type   | Default  | Description/Values                                           | | Property      | Type   | Default  | Description/Values                                           |
-| ------------- | ------ | -------- | ------------------------------------------------------------ | 
 | Width         | Number | 1.0      | Set width for the drawing element.                           | | Width         | Number | 1.0      | Set width for the drawing element.                           |
 | Depth         | Number | 1.0      | Set depth for the drawing element.                           | | Depth         | Number | 1.0      | Set depth for the drawing element.                           |
Line 254: Line 268:
 | diameter_3    | Number | 0.05     | Specifies the diameter for the rounded corner.               | | diameter_3    | Number | 0.05     | Specifies the diameter for the rounded corner.               |
  
-### RenderMode (Drawing element #seat)+== RenderMode (Drawing element #seat) ==
  
 The element #seat can take the following representations: The element #seat can take the following representations:
  
-* Mode "standard", Normal seat (e.g. n-seater or recamier) +  * Mode "standard", Normal seat (e.g. n-seater or recamier) 
-  <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nRenderModeStandard.png" style="zoom:50%;" /> +{{ :ig:gfx:shapecreator:nrendermodestandard.png?nolink&400 |}} 
-* Mode "ottomane", for ottomans +  * Mode "ottomane", for ottomans 
-  <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nRenderModeOttomane.png" style="zoom:50%;" /> +{{ :ig:gfx:shapecreator:nrendermodeottomane.png?nolink&400 |}} 
-* Mode "single", for armchairs +  * Mode "single", for armchairs 
-  <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nRenderModeSeat.png" style="zoom:50%;" />+{{ :ig:gfx:shapecreator:nrendermodeseat.png?nolink&400 |}}
  
- +== Orientation (Orientation) ==
- +
-### Orientation (Orientation)+
  
 The following drawing elements support different orientations: The following drawing elements support different orientations:
  
-* Ottomans (#seat plus RenderMode "ottomane")+  * Ottomans (#seat plus RenderMode "ottomane"): ottomans with orientation "left" are finishing elements on the left side and vice verca. 
 +{{ :ig:gfx:shapecreator:ot_align.png?nolink&400 |}}
  
-  <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\ot_align.png" style="zoom:33%;" />+  * Corners (#corner) 
 +{{:ig:gfx:shapecreator:ncornerleft.png?nolink&400|}} {{ :ig:gfx:shapecreator:ncornerright.png?nolink&400|}}
  
-  Ottomans with orientation "left" are finishing elements on the left side and vice verca. +== Rounding corners (Drawing element #seat und #armrest) ==
- +
-* Corners (#corner) +
-  <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nCornerLeft.png" style="zoom:33%;" /> <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nCornerRight.png" style="zoom:33%;" /> +
- +
-### Rounding corners (Drawing element #seat und #armrest)+
  
 Seats and armrests support the rounding of the under left (3) and right corner (2). Seats and armrests support the rounding of the under left (3) and right corner (2).
  
-<img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\pCorners.png" style="zoom: 50%;" />+{{ :ig:gfx:shapecreator:pcorners.png?nolink&400 |}}
  
 +=== Extensions ===
  
 +Drawing elements can be given various extensions that can be used to display additional functions. These include, for example, a pull-out function, LED lighting or electronic seat depth adjustments.
  
-### Extensions+== PullOut ==
  
-Drawing elements can be given various extensions that can be used to display additional functions. These include, for example, a pull-out function, LED lighting or electronic seat depth adjustments.+A PullOut element represents an arrow for displaying a pull-out function. With the help of the "Align" property, the arrow can be aligned to the associated drawing element. Thereby
  
-#### PullOut+  * left (Alignment left), 
 +{{ :ig:gfx:shapecreator:npullout_left.png?nolink&400 |}}
  
-A PullOut element represents an arrow for displaying a pull-out function. With the help of the "Align" property, the arrow can be aligned to the associated drawing element. Thereby+  * center (Alignment centered) and 
 +{{ :ig:gfx:shapecreator:npullout_center.png?nolink&400 |}}
  
-* left (Alignment left), +  * right (Alignment right) 
-  <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nPullOut_left.png" style="zoom:50%;" /> +{{ :ig:gfx:shapecreator:npullout_right.png?nolink&400 |}}
-* center (Alignment centered) and +
-  <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nPullOut_center.png" style="zoom:50%;" /> +
-* right (Alignment right) +
-  <img src="C:\Users\StueB\Documents\Arbeit\VisualStudio2\ig.gfx.shapecreator\Specification\nPullOut_right.png" style="zoom:50%;" />+
  
  
ig/gfx/shapecreator/specification.1630413317.txt.gz · Last modified: 2024/04/04 08:04 (external edit)