Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcneel/ThreeLib
.net Class Library for creating Three.js compatible objects
https://github.com/mcneel/ThreeLib
csharp threejs
Last synced: 18 days ago
JSON representation
.net Class Library for creating Three.js compatible objects
- Host: GitHub
- URL: https://github.com/mcneel/ThreeLib
- Owner: mcneel
- License: mit
- Created: 2017-10-09T08:30:02.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T20:31:37.000Z (almost 2 years ago)
- Last Synced: 2023-03-24T11:11:34.815Z (over 1 year ago)
- Topics: csharp, threejs
- Language: C#
- Size: 6.69 MB
- Stars: 33
- Watchers: 14
- Forks: 11
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ThreeLib
.net Class Library written in c# for creating [Three.js](https://github.com/mrdoob/three.js) compatible objects.
[](https://ci.appveyor.com/project/fraguada/ThreeLib)
The scope of this project is focused on serialization (and later perhaps deserialization). Therefore the objects to be targeted should be those that can be read through one of the Three.js [Loaders](https://github.com/mrdoob/three.js/tree/master/src/loaders).
This library could be used to develop exporter plugins from 3d modelling software that support mono / .net.
This project started as project [Iris](http://mcneel.github.io/Iris/), a Three.js exporter for [Rhino3d](http://www.rhino3d.com/). ThreeLib is essentially the serialization library from that project recreated as an open source project and rewritten to be more like working with Three.js. ThreeLib is what allows Iris to write Rhino Objects to json.
## Docs
- [LICENSE](https://github.com/mcneel/ThreeLib/blob/master/LICENSE)
- [CODE OF CONDUCT](https://github.com/mcneel/ThreeLib/blob/master/CODE_OF_CONDUCT.md)
- [CONTRIBUTING](https://github.com/mcneel/ThreeLib/blob/master/CONTRIBUTING.md)
## Dependencies
- [Json.Net](https://github.com/JamesNK/Newtonsoft.Json)
## Usage
You can either clone this repo and build the ThreeLib.csproj or use the published [NuGet package](https://www.nuget.org/packages/ThreeLib/).
Check out the [Sample project](https://github.com/mcneel/ThreeLib/tree/master/Sample) to see how some of the API is coming along.
For example:
```csharp
var scene = new Scene
{
Background = new Color(255,0,255).ToInt(),
Name = "My Scene"
};
var verts = new List
{
new float[] { 0, 0, 0 },
new float[] { 0, 0, 10.1234f },
new float[] { 10, 0, 10 },
new float[] { 10, 0, 0 }
};
var norms = new List
{
new float[] { 0, 1, 0 },
new float[] { 0, 1, 0 },
new float[] { 0, 1, 0 },
new float[] { 0, 1, 0 }
};
var vertices = Geometry.ProcessVertexArray(verts); //flattens a List
var normals = Geometry.ProcessNormalArray(norms);
var face = new int[] { 0, 1, 2, 3 };
var faces = Geometry.ProcessFaceArray(new List { { face } }, false, false);
var geometry = new Geometry(vertices, faces, normals);
var mesh = new Mesh
{
Geometry = geometry,
Material = material,
Name = "My Mesh"
};
scene.Add(mesh);
scene.ToJSON(false);
```
Rsults in:
```json
{
"metadata" : {
"version" : 4.5,
"type" : "Object",
"generator" : "ThreeLib-Object3D.toJSON"
},
"geometries" : [{
"data" : {
"vertices" : [0, 0, 0, 0, 0, 10.1234, 10, 0, 10, 10, 0, 0],
"colors" : [],
"faces" : [33, 0, 1, 2, 3, 0, 1, 2, 3],
"uvs" : [],
"normals" : [0, 1, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0]
},
"matrix" : [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1],
"uuid" : "7989f47c-5e74-4d1b-830d-880ba402d78d",
"type" : "Geometry"
}
],
"materials" : [{
"color" : 16777215,
"roughness" : 1.0,
"metalness" : 0.25,
"opacity" : 1.0,
"uuid" : "683ae9a3-608a-4982-b301-448bd8a41105",
"type" : "MeshStandardMaterial"
}
],
"object" : {
"background" : 16711935,
"children" : [{
"geometry" : "7989f47c-5e74-4d1b-830d-880ba402d78d",
"material" : "683ae9a3-608a-4982-b301-448bd8a41105",
"matrix" : [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1],
"uuid" : "d48d6259-0eb6-466e-b484-65be547b1934",
"name" : "My Mesh",
"type" : "Mesh"
}
],
"matrix" : [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1],
"uuid" : "da0f589a-50d3-4a65-91ed-061b28d961b5",
"name" : "My Scene",
"type" : "Scene"
}
}
```
## Current Status
Three.js Objects
| Category | Object | Status |
|:------------------ |:---------------------------|:-------|
|Animation | - | - |
|Animation / Tracks | - | - |
|Audio | - | - |
|[Cameras](https://github.com/mcneel/ThreeLib/tree/master/THREE/Cameras) | Camera | WIP |
| | CubeCamera | - |
| | OrthographicCamera | WIP |
| | PerspectiveCamera | WIP |
| | StereoCamera | - |
|Constants | - | - |
|[Core](https://github.com/mcneel/ThreeLib/tree/master/THREE/Core) | BufferAttribute | WIP |
| | BufferGeometry | WIP |
| | Clock | - |
| | DirectGeometry | - |
| | EventDispatcher | - |
| | Face3 | - |
| | Geometry | WIP |
| | InstancedBufferAttribute | - |
| | InstancedBufferGeometry | - |
| | InstancedInterleavedBuffer | - |
| | InterleavedBuffer | - |
| | InterleavedBufferAttribute | - |
| | Layers | - |
| | Object3D | WIP |
| | Raycaster | - |
| | Uniform | - |
|Core/BufferAttributes | - | - |
|Geometries | - | - |
|[Lights](https://github.com/mcneel/ThreeLib/tree/master/THREE/Lights) | AmbientLight | WIP |
| | DirectionalLight | WIP |
| | HemisphereLight | WIP |
| | Light | WIP |
| | PointLight | WIP |
| | RectAreaLight | WIP |
| | SpotLight | WIP |
|[Lights/Shadows](https://github.com/mcneel/ThreeLib/tree/master/THREE/Lights) | DirectionalLightShadow | WIP |
| | LightShadow | WIP |
| | SpotLightShadow | WIP |
|[Materials](https://github.com/mcneel/ThreeLib/tree/master/THREE/Materials) | LineBasicMaterial | WIP |
| | LineDashedMaterial | - |
| | Material | WIP |
| | MeshBasicMaterial | WIP |
| | MeshDepthMaterial | WIP |
| | MeshLambertMaterial | WIP |
| | MeshNormalMaterial | WIP |
| | MeshPhongMaterial | WIP |
| | MeshPhysicalMaterial | WIP |
| | MeshStandardMaterial | WIP |
| | MeshToonMaterial | - |
| | PointsMaterial | WIP |
| | RawShaderMaterial | - |
| | ShaderMaterial | - |
| | ShadowMaterial | - |
| | SpriteMaterial | - |
|[Math](https://github.com/mcneel/ThreeLib/tree/master/THREE/Math) | Box2 | - |
| | Box3 | - |
| | Color | WIP |
| | Cylindrical | - |
| | Euler | WIP |
| | Frustum | - |
| | Interpolant | - |
| | Line3 | - |
| | Math | - |
| | Matrix3 | - |
| | Matrix4 | WIP |
| | Plane | - |
| | Quaternion | WIP |
| | Ray | - |
| | Sphere | - |
| | Spherical | - |
| | Triangle | - |
| | Vector2 | - |
| | Vector3 | WIP |
| | Vector4 | - |
|[Objects](https://github.com/mcneel/ThreeLib/tree/master/THREE/Objects) | Bone | - |
| | Group | WIP |
| | LensFlare | - |
| | Line | WIP |
| | LineLoop | - |
| | LineSegments | - |
| | LOD | - |
| | Mesh | WIP |
| | Points | WIP |
| | Skeleton | - |
| | SkinnedMesh | - |
| | Sprite | - |
|[Scenes](https://github.com/mcneel/ThreeLib/tree/master/THREE/Scenes) | Fog | - |
| | FogExp2 | - |
| | Scene | WIP |
|[Textures](https://github.com/mcneel/ThreeLib/tree/master/THREE/Textures) | CompressedTexture | - |
| | CubeTexture | - |
| | DataTexture | - |
| | DepthTexture | - |
| | Texture | WIP |
| | VideoTexture | - |
|Other | Image | WIP |