Update scripts to account for removal of the context override to bpy.ops
[blender-addons.git] / mesh_tiny_cad / README.md
blob6c72dc78b411ca96543398d217bec7501ec61748
1 Blender CAD utils (for Blender 2.80+)
2 =====================================
4 A tiny subset of unmissable CAD functions for Blender 3d.  
5 Addon [page on blender.org/wiki](http://wiki.blender.org/index.php/Extensions:2.6/Py/Scripts/Modeling/mesh_tinyCAD) (Which has most of the same info]  
7 ### Installation
9 The add-on is currently included in standard installations on Blender 2.78 onwards. Enable it by doing a search in `User Preferences > Add-ons > and type 'tiny' into the search field`. Enable 'Mesh: tinyCAD Mesh tools'.
11 In Blender 2.80 distributions you might encounter an older version of this add-on, if it fails to load/run/enable, please install it again from this github repository. 
13 __________________
16 ### OK, what's this all about?
18 Dedicated CAD software speeds up drafting significantly with functions like: `Extend`, `Trim`,  `Intersect`, `Fillet /w radius` and `Offset /w distance`. At the moment of this writing many of these functions aren't included by default in regular distributions on Blender.org, so I've coded scripts to perform a few of the main features that I missed most.
19   
20 My scripts have shortnames: `VTX, V2X, XALL, BIX, CCEN` and are described separately in sections below. `Fillet` and `Offset` are written by zmj100 and can be found [here](http://blenderartists.org/forum/showthread.php?179375).
23 Since I started this repository: Vertex Fillet / Bevel was added to master. So no more need for a separate addon.  (Ctrl+Shift+b)
25 ### VTX
27 The VTX script has lived in contrib distributions of Blender since 2010, with relatively minor changes. The feedback from BlenderArtists has been [overwhelmingly positive](http://blenderartists.org/forum/showthread.php?204836-CAD-Addon-Edge-Tools-(blender-2-6x)). I'm not going to claim it's bug free, but finding any showstopping issues has proven difficult. It now performs V, T or X selection automatically.   
28   
29 Expect full freedom of orientation, but stuff must really intersect within error margins (`1.5E-6` = tolerance). These kinds of functions are handy for drawing construction lines and fixing up geometry. 
31   - V : extending two edges towards their _calculated_ intersection point.  
32    ![V](http://i.imgur.com/zBSciFf.png)
34   - T : extending the path of one edge towards another edge.  
35    ![T](http://i.imgur.com/CDH5oHm.png)
37   - X : two edges intersect, their intersection gets a weld vertex. You now have 4 edges and 5 vertices.  
38    ![X](http://i.imgur.com/kqtX9OE.png)
41 - Select two edges  
42 - hit `Spacebar` and type `vtx` ..select `autoVTX`  
43 - Bam. the rest is taken care of.
46 ### X ALL
48 Intersect all, it programmatically goes through all selected edges and slices them all using any found intersections, then welds them.
50   - XALL is fast!  
51   ![Imgur](http://i.imgur.com/1I7totI.gif)
52   - Select as many edges as you want to intersect.
53   - hit `spacebar` and type `xa`  ..select `XALL intersect all edges`
55 ### V2X (Vertex to Intersection)
57 This might be a niche accessory, but sometimes all you want is a vertex positioned on the intersection of two edges. Nothing fancy.
59 ### BIX (generate Bisector)
61 Creates a single edge which is the bisect of two edges.  
62 ![Imgur](http://i.imgur.com/uzyv1Mv.gif)  
64 ### CCEN (Circle Centers)
66 Given either 
68 - two adjacent edges on the circumference of an incomplete circle
69 - or three vertices (not required to be adjacent)
71 this operator will places the 3d cursor at original center of that circle.
73 ![imgur](https://cloud.githubusercontent.com/assets/619340/5595657/2786f984-9279-11e4-9dff-9db5d5a52a52.gif)
75 updated version may become a modal operator to generate a full set of circle vertices, with variable vertex count.
77 ![imgur demo](https://cloud.githubusercontent.com/assets/619340/5602194/ce613c96-933d-11e4-9879-d2cfc686cb69.gif)
78   
79 ### E2F (Extend Edge to Selected Face, Edge 2 Face)
81 Select a single Edge and a single Polygon (ngon, tri, quad) within the same Object. Execute `W > TinyCAD > E2F`
83 ![image](https://cloud.githubusercontent.com/assets/619340/12091278/2884820e-b2f6-11e5-9f1b-37ebfdf10cfc.png)
86 ### Why on github?
88 The issue tracker, use it.  
90 -  Let me know if these things are broken in new releases. Why? I don't update Blender as often as some so am oblivious to the slow evolution. 
91 -  If you can make a valid argument for extra functionality and it seems like something I might use or be able to implement for fun, it's going to happen.
92 -  I'm always open to pull requests (just don't expect instant approval of something massive, we can talk..you can use your gift of persuasion and sharp objectivism)