Browse Source

Updated docs.

Vicente Penades 6 years ago
parent
commit
5117e36259
2 changed files with 30 additions and 14 deletions
  1. 26 13
      src/SharpGLTF.Toolkit/README.md
  2. 4 1
      src/SharpGLTF.Toolkit/Scenes/readme.md

+ 26 - 13
src/SharpGLTF.Toolkit/README.md

@@ -1,22 +1,35 @@
 # SharpGLTF Toolkit
 # SharpGLTF Toolkit
 
 
-#### Features
+#### Overview
 
 
-- Scene Evaluation.
-- Mesh building utilities.
-- Material building utilities
-- Scene building utilities.
-- Animation extension helpers.
-- Skinning helpers.
+SharpGLTF.Toolkit is a collection of classes and utilities aimed to help
+the developer in creating and editing glTF files in the easiest way possible.
+
+Althought the Schema2 namespace API does support some editing capabilities, in
+practice it stands for the word _"The JPEG of 3D"_ , which essentially means
+that its internal structure is not designed to be easily editable.
+
+so, although you can build glTF scenes directly with the Schema2 namespace API,
+doing so is not trivial, and you will need to do a lot of trickery on your own,
+specially for complex scenes and optimizing assets.
+
+So the Toolkit API comes to cover the gap, and make things a bit easier to
+create glTF assets programatically.
+
+A lof ot the classes in the toolkit follow the `StringBuilder` API paradigm, which
+is, you start from scratch and you keep adding elements to it until you finish.
+
+
+#### Toolkit Namespaces
+
+- [MeshBuilder.](Geometry/readme.md)
+  - [Vertex formats.](Geometry/VertexTypes/readme.md)
+- [MaterialBuilder.](Materials/readme.md)
+- [SceneBuilder](Scenes/readme.md)
 
 
 #### Roadmap
 #### Roadmap
 
 
-- Morphing utilities
+- Morphing support.
 - [Mikktspace](https://github.com/tcoppex/ext-mikktspace) Tangent space calculation. *Help Need*
 - [Mikktspace](https://github.com/tcoppex/ext-mikktspace) Tangent space calculation. *Help Need*
 - GPU Evaluation.
 - GPU Evaluation.
 
 
-#### Namespaces
-
-[Geometry](Geometry/readme.md)
-
-[Materials](Materials/readme.md)

+ 4 - 1
src/SharpGLTF.Toolkit/Scenes/readme.md

@@ -40,4 +40,7 @@ and a scene is just a collection of instances to be rendered.
 
 
 When you save the scene, all assets are gathered and matched, including meshes, materials
 When you save the scene, all assets are gathered and matched, including meshes, materials
 and nodes, and the appropiate glTF Schema2 Scenes and Nodes are created under the hood to
 and nodes, and the appropiate glTF Schema2 Scenes and Nodes are created under the hood to
-match the SceneBuilder rendering intent.
+match the SceneBuilder rendering intent.
+
+Additionally, `NodeBuilder` instances support defining animation curves, which are contained
+internally inside every `NodeBuilder` instance.