Skip to content

Commit 6acbce6

Browse files
author
jamie.bull
committedJan 20, 2018
Add OBJ viewer to docs
1 parent fa6f211 commit 6acbce6

File tree

3 files changed

+29
-8
lines changed

3 files changed

+29
-8
lines changed
 

‎README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It primarily adds functions to do with IDF geometry, including zones, surfaces,
1212

1313
## Installation
1414

15-
To install GeomEppy, call `pip install geomeppy`.
15+
`pip install geomeppy`
1616

1717
## API
1818

@@ -72,6 +72,15 @@ azimuth in the `wwr_map`. Any omitted walls' WWR will be set to the value in
7272

7373
`IDF.view_model() # shows a zoomable, rotatable transparent model`
7474

75+
- Exporting a 3D OBJ file model
76+
77+
`IDF.to_obj('mymodel.idf')`
78+
79+
You can view the exported model [here](https://3dviewer.net/). Just drag the .obj file
80+
and .mtl file into the browser window.
81+
82+
![OBJ viewer](img/obj_viewer.png?raw=true "OBJ viewer")
83+
7584
- Get all surfaces in a model
7685

7786
`IDF.getsurfaces()`
@@ -119,13 +128,14 @@ GeomEppy also provides some additional functions such as `surface.setcoords(...)
119128

120129
```
121130
wall = idf.newidfobject(
122-
'BUILDINGSURFACE:DETAILED', 'awall',
123-
Surface_Type = 'wall')
131+
'BUILDINGSURFACE:DETAILED',
132+
Name='awall',
133+
Surface_Type = 'wall',
134+
)
124135
wall.setcoords([(0,0,1),(0,0,0),(1,0,0),(1,0,1)])
125136
```
126137

127138
## Forthcoming
128139

129140
- Geometry validation and correction
130141
- Geometry simplification
131-
- Better geometry visualisation

‎README.rst

+15-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Installation
1616

1717
GeomEppy requires Numpy, Shapely, and optionally Matplotlib.
1818

19-
To install GeomEppy, call `pip install geomeppy`.
19+
`pip install geomeppy`
2020

2121
API
2222
---
@@ -82,6 +82,15 @@ azimuth in the ``wwr_map``. Any omitted walls' WWR will be set to the value in
8282

8383
``IDF.view_model() # shows a zoomable, rotatable transparent model``
8484

85+
- Exporting a 3D OBJ file model
86+
87+
``IDF.to_obj('mymodel.idf')``
88+
89+
You can view the exported model `here <https://3dviewer.net/>`_. Just drag the .obj file
90+
and .mtl file into the browser window.
91+
92+
|OBJ viewer|
93+
8594
- Get all surfaces in a model
8695

8796
``IDF.getsurfaces()``
@@ -136,18 +145,20 @@ GeomEppy also provides some additional functions such as
136145
::
137146

138147
wall = idf.newidfobject(
139-
'BUILDINGSURFACE:DETAILED', 'awall',
140-
Surface_Type = 'wall')
148+
'BUILDINGSURFACE:DETAILED',
149+
Name='awall',
150+
Surface_Type = 'wall',
151+
)
141152
wall.setcoords([(0,0,1),(0,0,0),(1,0,0),(1,0,1)])
142153

143154
Forthcoming
144155
-----------
145156

146157
- Geometry validation and correction
147158
- Geometry simplification
148-
- Better geometry visualisation
149159

150160
.. |Build Status| image:: https://travis-ci.org/jamiebull1/geomeppy.svg?branch=master
151161
:target: https://travis-ci.org/jamiebull1/geomeppy
152162
.. |CodeCov| image:: https://img.shields.io/codecov/c/github/jamiebull1/geomeppy/master.svg
153163
:target: https://codecov.io/github/jamiebull1/geomeppy
164+
.. |OBJ viewer| image:: img/obj_viewer.png

‎img/obj_viewer.png

125 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.