|
1 | 1 | # Development Conventions |
2 | 2 |
|
3 | | -- Use [Microsoft C# Coding Convention](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions). |
| 3 | +Use [Microsoft C# Coding Convention](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions). |
4 | 4 |
|
5 | 5 | ## User Interface |
6 | | -It's a goal to achieve a one to one correspondance betwen what the user can read in Revit UI and in Rhino.Inside Revit UI. |
| 6 | + |
| 7 | +It's a goal to achieve a one to one correspondance betwen what the user can |
| 8 | +read Revit UI and in Rhino.Inside Revit UI. |
7 | 9 |
|
8 | 10 | - **Try to adhere as close as possible to Revit terminology.** |
9 | | -- Try to classify information using same grouping strategies Revit user is already familiar. *For Example use Disciplines, Categories, Families, etc…* |
| 11 | +- Try to classify information using same grouping strategies Revit user is |
| 12 | + already familiar. |
| 13 | + *For Example use Disciplines, Categories, Families, etc…* |
| 14 | + |
| 15 | +## Grasshopper |
| 16 | + |
| 17 | +**Grasshopper operates in Rhino model units**. |
| 18 | +No unit conversion should be necessary on Grasshopper definition by the user, |
| 19 | +so all necesary conversions should be done in the component. |
| 20 | +This means all components should always output values, like length or geometry |
| 21 | +values, in Rhino model units. This way all components can expect Rhino model |
| 22 | +units as input. This includes radians for angles. |
| 23 | + |
| 24 | +Do not create CRUD components for data types that are already handled by |
| 25 | +Rhino and Grasshopper ecosystem. |
| 26 | +*e.g. Do not create a component that extracts wall endpoints. |
| 27 | +Extract the base curve of the wall as a Rhino curve, and then use existing |
| 28 | +Grasshopper components to grab the curve end points*. |
| 29 | + |
| 30 | +Implement type conversions when the conversion is not ambiguous. |
| 31 | +*e.g. 'Wall' to 'Curve', 'Level' to 'Plane', 'Grid' to 'Curve'.* |
10 | 32 |
|
11 | | -### Grasshopper: |
| 33 | +### Versioning |
12 | 34 |
|
13 | | -- Do not create CRUD components for data types that are already handled by Rhino and Grasshopper ecosystem e.g. Do not create a component that extracts wall endpoints. Extract the base curve of the wall as a Rhino curve, and then use existing Grasshopper components to grab the curve end points. |
14 | | -- Implement type conversions when the conversion is not ambiguous. *For Example 'Wall' to 'Curve', 'Level' to 'Plane', 'Grid' to 'Curve'.* |
15 | | -- **Grasshopper operates in Rhino model units**. No unit conversion should be necessary on Grasshopper definition by the user, so all necesary conversions should be done in the component. This means all components should always output values, like length or geometry values, in Rhino model units. This way all components can expect Rhino model units as input. This includes radians for angles. |
16 | | -- **Components should have same set of parameters in all Revit versions**, emulating a default behaviour when the feature is not available on a specific version. *For Example slanted angle on a wall in versions prior to 2021 should return 0° instead of Null*. |
17 | | -- Components that are wrapping features completly missing on a specific Revit version should not be available at all unless correct handling is implemented. *For Example 'Add Topography (Mesh)' component is unavailable before Revit 2020*. |
18 | | - - Component Exposure should be 'Hidden'. |
19 | | - - The component shoud behave as if it was 'Disabled' but showing an error message like *'This component needs Revit 2020 or newer to run'*. |
| 35 | +Components should have same set of parameters in all Revit versions, |
| 36 | +emulating a default behaviour when the feature is not available on a specific |
| 37 | +version. |
| 38 | +*e.g. Slanted angle on a wall in versions prior to 2021 should return |
| 39 | +0° instead of Null*. |
20 | 40 |
|
21 | | -#### Parameters naming: |
22 | | -- **Use singular form for nouns**. *For Example 'Wall' instead of 'Walls'.* |
23 | | -- Use `Type Name` for floating parameters. *For example 'Wall', 'Level', 'Element Type'.* |
| 41 | +Components that are wrapping features completly missing on a specific Revit |
| 42 | +version should not be available at all unless correct handling is implemented. |
| 43 | +For Example 'Add Topography (Mesh)' component is unavailable before Revit 2020. |
| 44 | + |
| 45 | +- Component `Exposure` should be `Hidden`. |
| 46 | +- The component shoud behave as if it was 'Disabled' but showing an error |
| 47 | + message like: *“This component needs Revit 2020 or newer to run”*. |
| 48 | + |
| 49 | +### Parameters naming |
| 50 | + |
| 51 | +- **Use singular form for nouns**. |
| 52 | + *e.g. 'Wall' instead of 'Walls'*. |
| 53 | +- Use `Type Name` for floating parameters. |
| 54 | + *e.g. 'Wall', 'Level', 'Element Type'*. |
24 | 55 |
|
25 | | -#### Components naming: |
26 | | -- **Use singular form for nouns** instead of plural form as your first choice. For example 'Deconstruct Brep' instead of 'Deconstruct Breps'. |
27 | | -- Use `{Action} {Noun}` as the prefered form. *For example 'Divide Curve' instead of 'Curve Divide'.* |
| 56 | +### Components naming |
| 57 | + |
| 58 | +- **Use singular form for nouns** instead of plural form as your first |
| 59 | + choice. |
| 60 | + *For example 'Deconstruct Brep' instead of 'Deconstruct Breps'*. |
| 61 | +- Use `{Action} {Noun}` as the prefered form. |
| 62 | + *e.g. 'Divide Curve' instead of 'Curve Divide'*. |
28 | 63 | - Use Type Name as Noun when there is a clear primary one. |
29 | | - - Use `Construct {Type Name}` to components that construct an object from its constituen parts. |
30 | | - - Use `Deconstruct {Type Name}` to components that deconstruct an object into its constituen parts. |
31 | | -- Use `{Type Name} {Property Name}` when the component partially deconstruct an object like a property accessor. *For example 'Curve Domain' or 'Element Geometry'.* |
32 | | -- Use `Add {Type Name}` for components that add a new Element to a Revit model. For example 'Add Level'. |
| 64 | + - Use `Construct {Type Name}` to components that construct an object from its |
| 65 | + constituen parts. |
| 66 | + - Use `Deconstruct {Type Name}` to components that deconstruct an object into |
| 67 | + its constituen parts. |
| 68 | +- Use `{Type Name} {Property Name}` when the component partially deconstruct an |
| 69 | + object like a property accessor. |
| 70 | + *e.g. 'Curve Domain' or 'Element Geometry'*. |
| 71 | +- Use `Add {Type Name}` for components that add a new Element to a Revit model. |
| 72 | + *For example 'Add Level'*. |
33 | 73 | - Component Parameters |
34 | | - - Use only alphanumeric characters and avoid characters like question or exclamation marks. |
35 | | - - Use singular when the parameter access is `item`, plural when is `list` or `tree`. |
36 | | - - Use the type name as the first choice, *For example 'Color' in 'Add Material'.* |
37 | | - - **If it is reflecting a Revit element parameter use the exact same name Revit uses in English.** |
| 74 | + - Use only alphanumeric characters and avoid characters like question or |
| 75 | + exclamation marks. |
| 76 | + - Use singular when the parameter access is `item`, plural when is `list` or |
| 77 | + `tree`. |
| 78 | + - Use the type name as the first choice. |
| 79 | + *For example 'Color' in 'Add Material'*. |
| 80 | + - **If it is reflecting a Revit element parameter use the exact same name |
| 81 | + Revit uses in English.** |
0 commit comments