Skip to content

Commit

Permalink
added blender naming convention to 3d Styleguide-3D-Engine.md
Browse files Browse the repository at this point in the history
  • Loading branch information
splican committed Nov 28, 2024
1 parent a25dc46 commit 57e2e52
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion AdLerDokumentation/Writerside/topics/Styleguide-3D-Engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,27 @@ Folgende Grundrisse sind vorhanden:
| 10-Elemente | ![](image3DStyleguideLExample.png)|
| 13-Elemente | ![](image3DStyleguideTExample.png)|
| 15-Elemente | ![](image3DStyleguideDExample.png)|
|---|---|
|---|---|
## Naming in Blender
### Benennung von Modellen
- Es wird nur das "ParentModel" benannt. Die einzelnen Meshes, aus denen das Modell möglicherweise aufgebaut ist, müssen nicht benannt werden
- Benennungen sollen deskriptiv sein, bzw. nach dem nachempfundenen Pendant aus der realen Welt benannt werden
- Benennung der Modelle in ``camelCase`` -> ``bookShelf``
- Ausnahme: Icons werden ihrem abstrakten Sinn/Bedeutung/Verwendung nach benannt
- Bsp.: Controller = ``iconInteractiveElement``
- Bsp.: Papyrusrolle = ``iconTextElement``
- Modelle, die nur geringe Variationen eines ursprünglichen Modells sind, sollten ebenfalls deskriptiv benannt werden -> Bsp.: ``bookShelf`` -> ``bookShelfWithBooksOnTop``
- 1:1 Kopien von Modellen, erhalten das Blender Standard Suffix ``.001`` (als fortlaufende Nummerierung bei Mehreren Variationen). Dies kann sinnvoll sein, wenn ein und das selbe Element in mehreren Themes Anwendung findet
- Arrangements verschiedener Objekte zu einem gemeinsamen Objekt bekommen den Namen des titelgebenden Objekts (zentrales Objekt) mit dem Suffix ``Setup`` und den Namen bzw. Überbegriffen der sonstigen verwendeten Modelle -> Bsp.: ``tvLowboardSetupPlantsLamp``
- Sehr ähnliche (aber nicht gleiche) Elemente werden mit einer fortlaufenden Nummerierung versehen, sofern sie keine sichtbaren und dadurch benennbaren, signifikanten Unterschiede aufweisen -> Bsp.: ``palmTree``, ``plamTree1``, ``palmTree2``. Die Nummerierung erfolgt Nullindiziert, wobei die Null um initialen Modell nicht angehängt wird
### Sorting Tiles (Modelle zur optischen Gruppierung in der 3D Ansicht)
- Benennung der semantischen Kategorie (dargestellt durch farbige Plane) -> ``00_themenameKategorienameSortingTile`` (``00_`` um das Modell in der Collection oben anzuzeigen)
- Beschriftung der semantischen Kategorie -> ``00_themenameKategoriename`` (``00_`` um das Modell in der Collection oben anzuzeigen)
- Objekte innerhalb einer semantischen Kategorie (auf einer farbigen Plane) werden in eine Collection gruppiert
- Innerhalb dieser Collections kann es weitere Collections geben, die weitere Objekte in Sinneinheiten gliedern
### Benennung von Collections
- Benennung der Collections in ``PascalCase`` -> Bsp.: ``GeneralModels``
- Modelle, die nur geringe Variationen eines ursprünglichen Modells sind, sollten ebenfalls deskriptiv benannt werden -> Bsp.: ``bookShelf`` -> ``bookShelfWithBooksOnTop``
- 1:1 Kopien von Modellen, erhalten das Blender Standard Suffix ``.001`` (als fortlaufende Nummerierung bei Mehreren Variationen). Dies kann sinnvoll sein, wenn ein und das selbe Element in mehreren Themes Anwendung findet
- Arrangements verschiedener Objekte zu einem gemeinsamen Objekt bekommen den Namen des titelgebenden Objekts (zentrales Objekt) mit dem Suffix ``Setup`` und den Namen bzw. Überbegriffen der sonstigen verwendeten Modelle -> Bsp.: ``tvLowboardSetupPlantsLamp``
- Sehr ähnliche (aber nicht gleiche) Elemente werden mit einer fortlaufenden Nummerierung versehen, sofern sie keine sichtbaren und dadurch benennbaren, signifikanten Unterschiede aufweisen -> Bsp.: ``palmTree``, ``plamTree1``, ``palmTree2``. Die Nummerierung erfolgt Nullindiziert, wobei die Null um initialen Modell nicht angehängt wird.

0 comments on commit 57e2e52

Please sign in to comment.