LDraw.org Wiki - User contributions [en]

Primitives Reference

2023-12-19T17:19:11Z

OrionP:

'''LDraw Primitives Reference'''

This page is a source of reference for the LDraw primitives in the \LDraw\p directory. Primitives are defined as highly re-usable components of LEGO parts modelled for LDraw.
They serve several purposes :

* To speed up parts authoring by providing a library of components which can be incorporated into several parts
* To allow rendering software to make substitutions of curved components

Within this reference material the available primitives are categorised into:

<div class="noautonum">__TOC__</div>

Each section contains an overview of the characteristics common to all primitives within that category. Primitives are grouped into classes within each category - one class of primitive serving a similar purpose at different sizes or resolutions. For each class of primitive, a brief description of the purpose of the primitive is provided, with notes on its co-ordinate origin, default size and rules for scaling. A list of the available primitives is shown. 

[[File:XYZaxes.png|200px|middle|alt=Axes]]An understanding of the orientation of the co-ordinate axes is essential for authoring a part for LDraw. For reference within this page the axes and their direction is shown in this diagram. 

==Rectilinear primitives==

'''Nomenclature'''

Boxes are named boxF, with F representing the number of faces a box has. The suffix E represents the number of edges removed.

F and E are may followed by an additional letter. The hyphen is removed if F is accompanied by a modifier.

Face modifiers:

* o - faces are opposite to each other
* t - faces are all touching each other (usually, it's implied, but box4t.dat is a thing)
* u - missing faces form a U-shape

Edge letters:

* p - groups of edges are parallel to each other
* a - some missing faces have no adjacent edges

'''Scaling and orientation'''

These rectilinear elements may be scaled in the {x}, {y} and {z} dimensions to make elements of any size. For example

''1 16    0 0 0    40 0 0    0 1 0    0 0 20    rect.dat''

would generate a 80LDu x 40LDu rectangle in the {x,z} plane.

Although the default orientation of the rect.dat primitive is in the {x,z} plane the LDraw language allows for this to be transformed

''1 16    0 0 0    0 1 0    40 0 0    0 0 20    rect.dat''

would generate a 80LDu x 40LDu rectangle in the {y,z} plane.

''1 16    0 0 0    40 0 0    0 0 20    0 1 0    rect.dat''

would generate a 80LDu x 40LDu rectangle in the {x,y} plane. 

{| class="wikitable" style="width: 100%;"
|+
=== Two dimensional ===
|-
| '''triangle.dat''' || '''Triangle with all edges'''
|-
| [[File:triangle.png|200px|thumb|alt=Triangle]]
|| This primitive represents a isosceles right triangle in the {x,z} plane and the three edges that bound it. Its origin is at the tip of the right angle and by default has a size of 1LDu in each of the {x} and {z} dimensions. To avoid matrix arithmetic problems in some renderers, the third dimension ({y} in the default orientation) must be given a non-zero scaling factor.

1 16    0 0 0    5 0 0    0 1 0    0 0 20    triangle.dat
|-

|-
| '''rect.dat''' || '''Rectangle with all edges'''
|-
| [[File:rect.png|200px|thumb|alt=Rect]]
|| This primitive represents a rectangle in the {x,z} plane and the four edges that bound it. Its origin is at its centre and by default has a size of 2LDu in each of the {x} and {z} dimensions.
|-

| '''rect3.dat''' || '''Rectangle with 3 edges'''
|-
| [[File:rect3.png|200px|thumb|alt=Rect3]]
|| This primitive represents a rectangle in the {x,z} plane but excludes one edge {-z}. Its origin is at its centre and by default has a size of 2LDu in each of the {x} and {z} dimensions.
|-

| '''rect2p.dat''' || '''Rectangle with 2 parallel edges'''
|-
| [[File:rect2p.png|200px|thumb|alt=Rect2p]]
|| This primitive represents a rectangle in the {x,z} plane but excludes two parallel edges ({+x} and {-x}). Its origin is at its centre and by default has a size of 2LDu in each of the {x} and {z} dimensions.
|-

| '''rect2a.dat''' || '''Rectangle with 2 adjacent edges'''
|-
| [[File:rect2a.png|200px|thumb|alt=Rect2a]]
|| This primitive represents a rectangle in the {x,z} plane but excludes two adjacent edges ({-x} and {-z}). Its origin is at its centre and by default has a size of 2LDu in each of the {x} and {z} dimensions.
|-

| '''rect1.dat''' || '''Rectangle with 1 edge'''
|-
| [[File:rect1.png|200px|thumb|alt=Rect1]]
|| This primitive represents a rectangle in the {x,z} plane but include only the one {+x} edge. Its origin is at its centre and by default has a size of 2LDu in each of the {x} and {z} dimensions.
|-

| '''recte3.dat''' || '''Empty rectangle with three edges'''
|-
| [[File:recte3.png|200px|thumb|alt=Recte3]]
|| This primitive represents three edges of a rectangle in the {x,z} plane. Its origin is at its centre and by default has a size of 2LDu in each of the {x} and {z} dimensions.
|-

| '''recte4.dat''' || '''Empty rectangle with all edges'''
|-
| [[File:recte4.png|200px|thumb|alt=Recte4]]
|| This primitive represents the four edges of a rectangle in the {x,z} plane. Its origin is at its centre and by default has a size of 2LDu in each of the {x} and {z} dimensions.
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable" style="width: 100%;"
|+
=== Three dimensional ===
|-
| '''box.dat''' || '''Cuboid with all faces and edges'''
|-
| [[File:box.png|200px|thumb|alt=Box]]
|| This primitive is used to define a cuboid. Its origin is the centre of the cuboid and by default has a size of 2LDu in each of the three dimensions.
|-

| '''box0.dat''' || '''Cuboid with no faces and edges'''
|-
| [[File:box0.png|200px|thumb|alt=Box0]]
|| This primitive is used to define the frame a cuboid. Its origin is the centre of the cuboid and by default has a size of 2LDu in each of the three dimensions.
|-

| '''box5.dat''' || '''Cuboid with 5 faces and all edges'''
|-
| [[File:box5.png|200px|thumb|alt=Box5]]
|| This primitive represents a cuboid missing the top {-y} face. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box5-1.dat''' || '''Cuboid with 5 faces without 1 edge'''
|-
| [[File:box5-1.png|200px|thumb|alt=Box5-1]]
|| This primitive represents a cuboid missing the top {-y} face and one edge {-z} of that. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box5-2p.dat''' || '''Cuboid with 5 faces without 2 parallel edges'''
|-
| [[File:box5-2p.png|200px|thumb|alt=Box5-2p]]
|| This primitive represents a cuboid missing the top {-y} face and two of the four edges surrounding that. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box5-4a.dat''' || '''Cuboid with 5 faces without top edges'''
|-
| [[File:box5-4a.png|200px|thumb|alt=Box5-4a]]
|| This primitive represents a cuboid missing the top {-y} face and the four edges surrounding that. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box5-12.dat''' || '''Cuboid with 5 faces missing all edges'''
|-
| [[File:box5-12.png|200px|thumb|alt=Box5-12]]
|| This primitive represents a cuboid missing the top {-y} face and all edges. Its primary use is for sticker parts. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

! colspan="2" | Box4 overview
|-
| colspan="2" | [[File:Box4_Overview.PNG|thumb|600px|left|alt=Box4 Overview]]
|-

| '''box4.dat''' || '''Cuboid with 4 parallel faces and all edges'''
|-
| [[File:box4.png|200px|thumb|alt=Box4]]
|| This primitive represents a cuboid missing the top {-y} and bottom {+y} faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4o4a.dat''' || '''Cuboid with 4 parallel faces without bottom edges'''
|-
| [[File:box4o4a.png|200px|thumb|alt=Box4o4a]]
||This primitive represents a cuboid missing the top {-y} and bottom {+y} faces, and missing the edges of the bottom face. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4o8a.dat''' || '''Cuboid with 4 parallel faces without top and bottom edges'''
|-
| [[File:box4o8a.png|200px|thumb|alt=Box4o8a]]
|| This primitive represents a cuboid missing the top {-y} and bottom {+y} faces, and missing the edges of the top and bottom face. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4t.dat''' || '''Cuboid with 4 adjacent and all edges'''
|-
| [[File:box4t.png|200px|thumb|alt=Box4t]]
|| This primitive represents a cuboid missing the top {-y} and front {-z} faces, but with all its edges. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4-1.dat''' || '''Cuboid with 4 adjacent faces missing 1 edge'''
|-
| [[File:box4-1.png|200px|thumb|alt=Box4-1]]
||This primitive represents a cuboid missing the top {-y} and front {-z} faces and the edge between those faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4-2p.dat''' || '''Cuboid with 4 faces without two opposite top edges'''
|-
| [[File:box4-2p.png|200px|thumb|alt=Box4-2p]]
|| This primitive represents a cuboid missing the top {-y} and bottom {+y} faces, and missing two edges of the top face - the intersection of the two missing faces and the opposite edge. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4-3p.dat''' || '''Cuboid with 4 faces without three parallel edges'''
|-
| [[File:box4-3p.png|200px|thumb|alt=Box4-3p]]
|| This primitive represents a cuboid missing the top {-y} and bottom {+y} faces and missing three edges of the missing faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4-4a.dat''' || '''Cuboid with 4 adjacent faces missing 4 edges'''
|-
| [[File:box4-4a.png|200px|thumb|alt=Box4-4a]]
||This primitive represents a cuboid missing the top {-y} and front {-z} faces and all the edges of the missing front face. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4-5a.dat''' || '''Cuboid with 4 adjacent faces missing 5 edges'''
|-
| [[File:box4-5a.png|200px|thumb|alt=Box4-5a]]
||This primitive represents a cuboid missing the top {-y} and front {-z} faces and all the edges at the top and the bottom of the missing front face. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4-7a.dat''' || '''Cuboid with 4 adjacent faces missing 7 edges'''
|-
| [[File:box4-7a.png|200px|thumb|alt=Box4-7a]]
||This primitive represents a cuboid missing the top {-y} and front {-z} faces and all the edges of both missing faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box4-12.dat''' || '''Cuboid with 4 adjacent faces missing all edges'''
|-
| [[File:box4-12.png|200px|thumb|alt=Box4-12]]
||This primitive represents a cuboid missing the top {-y} and front {-z} faces and excludes all the edges. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3-3.dat''' || '''Cuboid with 3 adjacent faces missing 3 edges'''
|-
| [[File:box3-3.png|200px|thumb|alt=Box3-3]]
|| This primitive represents a cuboid missing the top {-y} and bottom {+y} faces, and missing three edges of the missing faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3-5a.dat''' || '''Cuboid with 4 adjacent faces missing 4 edges'''
|-
| [[File:box3-5a.png|200px|thumb|alt=Box3-5a]]
|| This primitive represents a cuboid missing the top {-y}, front {-z} and left {-x} faces and includes the three internal edges and the outer edges except those on the left {-z}. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

| '''box3-7a.dat''' || '''Cuboid with 3 adjacent faces missing 7 adjacent edges'''
|-
| [[File:box3-7a.png|200px|thumb|alt=Box3-7a]]
|| This primitive represents a cuboid missing the top {-y}, front {-z} and left {-x} faces and includes the three internal edges but only the outer edges at the top (-y). Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

| '''box3-9a.dat''' || '''Cuboid with 3 adjacent faces missing 9 adjacent edges'''
|-
| [[File:box3-9a.png|200px|thumb|alt=Box3-9a]]
|| This primitive represents a cuboid missing the top {-y}, front {-z} and left {-x} faces and includes only the three internal edges. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

| '''box3-12.dat''' || '''Cuboid with 3 adjacent faces missing all edges'''
|-
| [[File:box3-12.png|200px|thumb|alt=Box3-12]]
|| This primitive represents a cuboid missing the top {-y}, front {-z} and left {-x} faces but excludes all edges. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

! colspan="2" | Box3u overview
|-
| colspan="2" | [[File:Box3u_Overview.PNG|thumb|600px|left|alt=Box3u Overview]]
|-

| '''box3u2p.dat''' || '''Cuboid with 3 faces missing 2 edges'''
|-
| [[File:box3u2p.png|200px|thumb|alt=Box3u2p]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes the top edges of the left {-x} and right {+x} faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u4p.dat''' || '''Cuboid with 3 faces missing 4 parallel edges'''
|-
| [[File:box3u4p.png|200px|thumb|alt=Box3u4p]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes the topand bottom edges of the left {-x} and right {+x} faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u4a.dat''' || '''Cuboid with 3 adjacent faces missing all edges'''
|-
| [[File:box3u4a.png|200px|thumb|alt=Box3u4a]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes the edges of the missing top face. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u5p.dat''' || '''Cuboid with 3 faces missing 5 edges'''
|-
| [[File:box3u5p.png|200px|thumb|alt=Box3u5p]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes the top edge of the left {-x} face and all edges of the right {+x} face. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u6.dat''' || '''Cuboid with 3 faces missing 6 edges'''
|-
| [[File:box3u6.png|200px|thumb|alt=Box3u6]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes the top and bottom edges of the right {+x} face and all edges of the left {-x} face. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u6a.dat''' || '''Cuboid with 3 faces missing 4 adjacent and 2 parallel edges'''
|-
| [[File:box3u6a.png|200px|thumb|alt=Box3u6a]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes all the top edges and the bottom edges of the missing faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u7a.dat''' || '''Cuboid with 3 faces missing 7 adjacent edges'''
|-
| [[File:box3u7a.png|200px|thumb|alt=Box3u7a]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes the edges of the missing top (-y) and right (+x) faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u8p.dat''' || '''Cuboid with 3 faces missing 8 edges (in two parallel groups)'''
|-
| [[File:box3u8p.png|200px|thumb|alt=Box3u8p]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes all the edges of the left {-x} and right {+x} faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u10p.dat''' || '''Cuboid with 3 faces in a 'U' shape, missing 10 edges (all except those between the faces)'''
|-
| [[File:box3u10p.png|200px|thumb|alt=Box3u10p]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes all the edges except the two betweenthe faces. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''box3u12.dat''' || '''Cuboid with 3 parallel faces missing all edges'''
|-
| [[File:box3u12.png|200px|thumb|alt=Box3u12]]
|| This primitive represents a cuboid missing the top {-y} and left {-x} and right {+x} faces and excludes all the edges. Its origin is the centre of the (missing) top face and by default has a size of 2LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''boxjcyl4.dat''' || '''Box truncated by cylinder'''
|-
| [[File:boxjcyl4.png|200px|thumb|alt=Boxjcyl4]]
|| This suite of primitives are used to model the intersection between a box and cylinders of different radii. The box has a fixed width of 2LDu and the cylinder radius is denoted by the r in the filename.

Currently available primitives :
Regular resolution (boxjcylr) : 4
|-

| '''box2-5.dat''' || '''Cuboid with 2 adjacent faces missing 5 edges'''
|-
| [[File:box2-5.png|200px|thumb|alt=Box2-5]]
|| This primitive represents a cuboid missing the top {-y}, front {-z}, left {-x} and right {+x} faces and excludes all the edges which do not bound the included faces. Its origin is the centre of the cuboid and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

| '''box2-7.dat''' || '''Cuboid with 2 adjacent faces missing 7 edges'''
|-
| [[File:box2-7.png|200px|thumb|alt=Box2-7]]
|| This primitive represents a cuboid missing the top {-y}, front {-z}, left {-x} and right {+x} faces and excludes all the edges except that at the join between the two faces and those along the left {-x} and right {+x} sides. Its origin is the centre of the cuboid and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

| '''box2-9.dat''' || '''Cuboid with 2 adjacent faces missing 9 edges (all except those connected to the {+x}, {+y}, {+z} vertex)'''
|-
| [[File:box2-9.png|200px|thumb|alt=Box2-9]]
|| This primitive represents a cuboid missing the top {-y}, front {-z}, left {-x} and right {+x} faces and excludes all the edges except that at the join between the two faces and those along the right {+x} sides. Its origin is the centre of the cuboid and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

| '''box2-9p.dat''' || '''Cuboid with 2 adjacent faces missing 9 edges (all except three parallel edges)'''
|-
| [[File:box2-9p.png|200px|thumb|alt=Box2-9p]]
|| This primitive represents a cuboid missing the top {-y}, front {-z}, left {-x} and right {+x} faces and excludes all the edges except that at the join between the two faces and those parallel to that. Its origin is the centre of the cuboid and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

| '''box2-11.dat''' || '''Cuboid with 2 adjacent faces missing 11 edges'''
|-
| [[File:box2-11.png|200px|thumb|alt=Box2-11]]
|| This primitive represents a cuboid missing the top {-y}, front {-z}, left {-x} and right {+x} faces and excludes all the edges except that at the join between the two faces. Its origin is the centre of the cuboid and by default has a size of 2LDu in each of the {x}, {y} and {z} dimensions.
|-

| '''tri3.dat''' || '''Right-angled triangular prism with 3 faces'''
|-
| [[File:tri3.png|200px|thumb|alt=Tri3]]
|| This primitive represents a triangular prism missing the top {-y} and bottom {+y} faces but including all edges. The left {-x} and front {-z} faces are perpendicular. Its origin is the right-angle corner of the (missing) top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''tri3-1.dat''' || '''Right-angled triangular prism with 3 faces'''
|-
| [[File:tri3-1.png|200px|thumb|alt=Tri3-1]]
|| This primitive represents a triangular prism missing the top {-y} and bottom {+y} faces and excludes the top edge of the hypotenuse. Its origin is the right-angle corner of the (missing) top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''tri3-3.dat''' || '''Right-angled triangular prism missing 3 faces'''
|-
| [[File:tri3-3.png|200px|thumb|alt=Tri3-3]]
|| This primitive represents a triangular prism missing the top {-y} and bottom {+y} faces and excludes all top edges. Its origin is the right-angle corner of the (missing) top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''tri3a1.dat''' || '''Right-angled triangular prism with 3 adjacent faces missing 1 edge'''
|-
| [[File:tri3a1.png|200px|thumb|alt=Tri3a1]]
|| This primitive represents a triangular prism missing the top {-y} face, the face at the hypotenuse as well as the top edge at the hypotenuse. Its origin is the right-angle corner of the (missing) top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''tri3a3.dat''' || '''Right-angled triangular prism with 3 adjacent faces missing 3 edge'''
|-
| [[File:tri3a3.png|200px|thumb|alt=Tri3a3]]
|| This primitive represents a triangular prism missing the top {-y} face, the face at the hypotenuse and excludes all top edges. Its origin is the right-angle corner of the (missing) top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''tri3a4''' || '''Right-angled triangular prism with 3 adjacent faces missing 4 adjacent edges'''
|-
| [[File:tri3a4.png|200px|thumb|alt=Tri3a4]]
|| This primitive represents a triangular prism missing the top {-y} face, the face at the hypotenuse and excludes all edges at the hypotenuse. Its origin is the right-angle corner of the (missing) top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''tri3u1.dat''' || '''Right-angled triangular prism with 3 faces missing 1 edge'''
|-
| [[File:tri3u1.png|200px|thumb|alt=Tri3u1]]
|| This primitive represents a triangular prism missing the left {-x} and front {-z} faces. Its origin is the right-angle corner of the top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''tri3u3.dat''' || '''Right-angled triangular prism with 3 faces missing 3 edges'''
|-
| [[File:tri3u3.png|200px|thumb|alt=Tri3u3]]
|| This primitive represents a triangular prism missing the left {-x} and front {-z} faces, the edge where they would join and one edge of each of the triangles. Its origin is the right-angle corner of the top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|-

| '''tri4.dat''' || '''Right-angled triangular prism with 2 square faces and 2 triangular faces'''
|-
| [[File:tri4.png|200px|thumb|alt=Tri4]]
|| This primitive represents a triangular prism missing the face at the hypotenuse. Its origin is the right-angle corner of the top face and by default has a size of 1LDu in each of the {x} and {z} dimensions and 1LDu in the {y} dimension.
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

==Curved primitives==

LDraw represents curved surfaces as polygons. For circular components two series of primitives are provided.

All the circular primitives are orientated in the {x,z} plane with their origin at the centre of the circle and a default radius of 1 LDu. Primitives are provided for complete circles and for commonly used fractions of a complete circle. Where the naming convention includes a prefix of the form n-f this indicates the fraction (n/f) of the circle drawn by the primitive. Where this fraction is less than an entire circle, the primitive starts at {+x,0} and progresses in a conterclockwise direction when viewed from above {-y}.

To avoid rounding errors, it is preferable to use existing fractional circular primitives, or create a new primitive, rather than rotate an existing primitive by anything other than 90 or 180 degrees. For example, use 3-16XXXX.dat rather than combining 1-8XXXX.dat with 1-16XXXX.dat rotated by 22.5 degreees.

<gallery widths=200px mode="nolines">
XZaxes.png
1-8disc.png
1-4disc.png
2-4disc.png
3-4disc.png
4-4disc.png
</gallery>

To avoid matrix arithmetic problems in some renderers, the third dimension ({y} in the default orientation) of two-dimensional primitives must be given a non-zero scaling factor.
LDraw circles are normally formed of 16-sided polygons (hexdecagons) - the regular resolution. For larger elements, where scaling-up of hexadecagons would give too angular an appearance, a series of high resolution primitives based on a 48-sided polygon are available. These may also be used for parts not well suited to a 16-fold symmetry.

These circular elements may be scaled by the same factor in both the {x} and {z} dimensions to make circular elements of greater or less than 1LDu radius. For example

1 16    0 0 0    3 0 0    0 1 0    0 0 3    4-4edge.dat

would generate a circle in the {x,z} plane with a radius of 3LDu.

They may also be scaled asymmetrically in the x and z dimension to make ellipses.

Although the default orientation is in the {x,z} plane the LDraw language allows for these to be transformed

1 16    0 0 0    0 1 0    3 0 0    0 0 3    4-4edge.dat    would generate a circle in the {y,z} plane

1 16    0 0 0    3 0 0    0 0 3    0 1 0    4-4edge.dat    would generate a circle in the {x,y} plane

{| class="wikitable"
|+
===Two dimensional===
|-

! colspan="2" | Circular 2D Overview
|-
| colspan="2" | [[File:Circular_2D_Overview.PNG|thumb|600px|left|alt=Circular 2D Overview]]
|-

| '''n-fedge.dat''' || '''Circular line segment'''
|-
| [[File:4-4edge.png|200px|thumb|alt=4-4Edge]]
|| This suite of primitives are used for edges which comprise an entire or part circle.

''Currently available primitives:'' 
Regular resolution (n-f): 1-16, 1-8, 3-16, 1-4, 5-16, 3-8, 7-16, 2-4, 9-16, 5-8, 11-16, 3-4, 13-16, 7-8, 4-4 
High resolution (n-f): 1-48, 1-24, 1-16, 1-12, 5-48, 1-8, 7-48, 1-6, 3-16, 5-24, 11-48, 1-4, 7-24, 5-16, 1-3, 3-8, 19-48, 5-12, 7-16, 11-24, 2-4, 5-8, 2-3, 3-4, 4-4 
Low resolution (n-f): 1-4, 2-4, 3-8, 4-4
|-

| '''n-fdisc.dat''' || '''Circular disc sector'''
|-
| [[File:4-4disc.png|200px|thumb|alt=4-4disc]]
|| This suite of primitives are used for surfaces which comprise an entire or part circle.

''Currently available primitives:'' 
Regular resolution (n-f): 1-16, 1-8, 3-16, 1-4, 5-16, 3-8, 7-16, 2-4, 5-8, 11-16, 3-4, 7-8, 4-4 
High resolution (n-f): 1-24, 1-12, 5-48, 1-8, 7-48, 1-6, 3-16, 5-24, 1-4, 1-3, 2-4, 4-4 
Low resolution (n-f): 1-4, 2-4, 3-4, 4-4
|-

| '''n-fchrd.dat''' || '''Circular disc segment'''
|-
| [[File:1-4chrd.png|200px|thumb|alt=1-4chrd]]
|| This suite of primitives are used for surfaces which comprise part of a circle enclosed by the arc of its circumference and its chord. Note that the bounding circle in the image is for context only - only the grey segment is generated by the 1-4chrd primitive.

''Currently available primitives:'' 
Regular resolution (n-f): 1-16 (see note), 1-8, 3-16, 1-4, 5-16, 3-8, 7-16, 2-4, 5-8, 3-4, 13-16, 7-8 
High resolution (n-f): 1-48 (see note) 1-24, 1-16, 1-12, 5-48, 1-8, 7-48, 1-6, 3-16, 5-24, 11-48, 1-4, 7-24, 5-16, 1-3, 3-8, 19-48, 5-12, 7-16, 11-24, 2-4 
Low resolution (n-f): 1-4, 3-8, 2-4

Note: The regular resolution 1-16chrd.dat and high resolution 1-48chrd are special cases, see Primitive Substitution Adapters below for more information
|-

| '''n-fndis.dat''' || '''Inverse of circular disc sector'''
|-
| [[File:4-4ndis.png|200px|thumb|alt=4-4ndisc]]
|| This suite of primitives pad their matching n-fdisc.dat primitives out to the bounding square. They are used to integrate circular elements into rectilinear elements.

''Currently available primitives:'' 
Regular resolution (n-f): 1-16, 1-8, 3-16, 1-4, 5-16, 3-8, 7-16, 2-4, 3-4, 7-8, 4-4 
High resolution (n-f): 1-24, 1-16, 1-12, 5-48, 1-8, 7-48, 1-6, 3-16, 5-24, 11-48, 1-4, 1-3, 7-16, 2-4, 4-4 
Low resolution (n-f): 1-4, 3-4, 2-4, 3-4, 4-4
|-

| '''n-ftang.dat''' || '''Tangential ring segment'''
|-
| [[File:1-4tang.png|200px|thumb|alt=1-4tang]]
|| This suite of primitives are used to pad a 16-sided polygon to a circumscribing 16-sided polygon whose edges are tangential to the inner polygon. Note that the bounding circle in the image is for context only - only the black segment is generated by the 1-4tang primitive.

''Currently available primitives:'' 
Regular resolution (n-f): 1-16, 1-8, 3-16, 1-4
|-

| '''n-ftndis.dat''' || '''Disc negative truncated'''
|-
| [[File:1-8tndis.png|200px|thumb|alt=1-8tndis]]
|| [[File:Tndis-example.png|200px|right|alt=Tndis-example]]
This suite of primitives are used to used to integrate circular elements into rectilinear elements. These pad their matching n-fdisc.dat primitives out to the bounding rectangle, spanning from x = 1 to the minimal x value of the matching primitive. Note that the bounding circle in the image is for context only - only the black segment is generated by the 1-8tndis primitive. The image on the right showes the difference between tang, tndis and ndis.

''Currently available primitives:'' 
Regular resolution (n-f): 1-16, 1-8, 3-16 
High resolution (n-f): 5-48, 1-24, 1-16, 1-8
|-

| '''n-faring.dat''' || '''Circular adaptor ring segment'''
|-
| [[File:2-4aring.png|200px|thumb|alt=2-4aring]]
||This suite of primitives are used to interface between high resolution (48-segment) circular primitives and normal resolution (16-segment) circluar primitives. Note that the bounding circle in the image is for context only - only the black segment is generated by the 2-4aring primitive.

''Currently available primitives:'' 
Regular resolution (n-f): 4-4 
High resolution (n-f): 1-4
|-

| '''1-16chrd.dat''' '''1-48chrd.dat''' '''n-fering.dat''' || '''Primitive Substitution Adapters'''
|-
| [[File:4-4edge.png|200px|thumb|alt=4-4edge]]
|| This suite of primitives are used correct for gaps that form between curved primitives and normal geometry in editors that utilize primitive substitution. This is a special case used on the inside of a curved primitive where it joins geometry that cannot make use of a curved primitive. The chrd files themselves are simply a reference to empty.dat, which under normal circumstances does not draw anything. However, in tools that support primitive substitution, the curved primitive it is attached to would normally in this case create a gap when rendered using more than 16 points to form a circle. In that case, the substituted version of these normally empty primitives would fill in the gap between the curve and the other geometry.

To "see" these primitives, the editor in use must utilize primitive substitution. Then one of the following can be done:

* set the curve quality to a level high enough to see the gaps reappear
* For LDView 4.4 or later, in the Model Tree dialog, you can search for them (for example, "ering"), and if you have it set to highlight, then when you select one, it will be highlighted in the 3D view.
* Manually recolor the primitive in question to a color that contrasts with the colors that surround it

Note that the bounding circle in the image is for context only - there are no actual geometry producing lines contained in these files.

''Currently available primitives:'' 
Regular resolution (n-f): 1-16chrd, 1-4ering, 1-8ering, 3-16ering, 2-4ering, 4-4ering 
High resolution (n-f): 1-48chrd
|-

| '''n-fringr.dat''' '''n-frinrr.dat''' '''n-ffrinr.dat''' '''n-ffrirr.dat''' '''nn-ffrir.dat''' ringr.dat (deprecated name) ringrr.dat (deprecated name) || '''Circular ring segment'''
|-
| [[File:4-4ring1.png|200px|thumb|alt=1-4ring1]]
|| This suite of primitives are used to generate circular rings or part rings. The numeric suffix r in the filename indicates the inner radius of the ring - the outer radius is 1LDu greater. For example a n-f4-4ring4 primitive would create a ring with an inner radius of 4LDu and an outer radius of 5LDu.

Note: The correct nomenclature is to use the full word "ring". All newly created ring primitives must use "ring". Due to the fact that too many files would be affected, it was decided to keep the current official "rin" primitives in the library. All files using "ri" have been moved, to use "ring".

''Currently available primitives:'' 
Regular resolution: 
r=1: 1-16rin1, 1-8ring1, 3-16rin1, 1-4ring1, 5-16ring1, 3-8ring1, 7-16rin1, 2-4ring1, 9-16ring1, 5-8ring1, 3-4ring1, 7-8ring1, 4-4ring1 
r=2: 1-16rin2, 1-8ring2, 3-16rin2, 1-4ring2, 5-16rin2, 3-8ring2, 7-16ring2, 2-4ring2, 5-8ring2, 3-4ring2, 7-8ring2, 4-4ring2 
r=3: 1-16rin3, 1-8ring3, 3-16rin3, 1-4ring3, 5-16rin3, 3-8ring3, 7-16rin3, 2-4ring3, 5-8ring3, 3-4ring3, 7-8ring3, 4-4ring3 
r=4: 1-16rin4, 1-8ring4, 3-16rin4, 1-4ring4, 5-16ring4, 3-8ring4, 7-16rin4, 2-4ring4, 5-8ring4, 3-4ring4, 4-4ring4 
r=5: 1-8ring5, 3-16rin5, 1-4ring5, 5-16rin5, 3-8ring5, 2-4ring5, 3-4ring5, 4-4ring5 
r=6: 1-16ring6, 1-8ring6, 3-16rin6, 1-4ring6, 3-8ring6, 7-16ring6, 2-4ring6, 5-8ring6, 3-4ring6, 4-4ring6 
r=7: 1-8ring7, 3-16rin7, 1-4ring7, 5-16ring7, 3-8ring7, 7-16ring7, 2-4ring7, 3-4ring7, 4-4ring7 
r=8: 1-16ring8, 1-8ring8, 3-16rin8, 1-4ring8, 5-16ring8, 3-8ring8, 7-16ring8, 2-4ring8, 3-4ring8, 7-8ring8, 4-4ring8 
r=9: 1-16ring9, 1-8ring9, 3-16rin9, 1-4ring9, 5-16ring9, 3-8ring9, 7-16ring9, 2-4ring9, 3-4ring9, 7-8ring9, 4-4ring9 
r=10: 1-8rin10, 3-16ring10, 1-4rin10, 3-8rin10, 2-4rin10, 5-8ring10, 3-4rin10, 4-4rin10 
r=11: 1-16ring11, 1-8ring11, 3-16ring11, 1-4rin11, 7-16ring11, 2-4rin11, 4-4rin11 
r=12: 1-8ring12, 3-16ring12, 1-4rin12, 5-16ring12, 3-8rin12, 2-4rin12, 7-8rin12, 4-4rin12 
r=13: 1-8ring13, 3-16ring13, 1-4rin13, 5-16ring13, 3-8rin13, 2-4rin13, 4-4rin13 
r=14: 3-16ring14, 1-4rin14, 2-4rin14, 3-4rin14, 4-4rin14 
r=15: 1-8rin15, 3-16ring15, 1-4rin15, 3-8rin15, 2-4rin15, 7-8rin15, 4-4rin15 
r=16: 1-8ring16, 1-4rin16, 3-8rin16, 2-4rin16, 3-4ring16, 7-8rin16, 4-4rin16 
r=17: 1-8rin17, 1-4rin17, 5-16ring17, 3-8ring17, 7-16ring17, 2-4rin17, 4-4rin17 
r=18: 1-16ring18, 1-8rin18, 1-4rin18, 3-8rin18, 2-4rin18, 4-4rin18 
r=19: 1-16ring19, 1-8rin19, 3-16ring19, 1-4rin19, 3-8ring19, 2-4ring19, 3-4ring19, 4-4rin19 
r=20: 1-4rin20, 2-4rin20, 4-4rin20 
r=21: 1-4ring21, 3-8ring21, 4-4rin21 
r=22: 1-16ring22, 3-16ring22, 2-4rin22, 3-4rin22, 4-4rin22 
r=23: 1-16ring23, 1-8rin23, 1-4rin23, 2-4rin23, 4-4rin23 
r=24: 1-16ring24, 3-16ring24, 1-4rin24, 3-8rin24, 2-4rin24, 4-4rin24 
r=25: 1-4ring25, 2-4rin25, 4-4rin25 
r=26: 1-4ring26, 2-4ring26, 4-4rin26 
r=27: 1-8ring27, 4-4ring27 
r=28: 1-8ring28, 1-4rin28, 2-4ring28, 4-4ring28 
r=29: 1-4ring29, 3-8ring29, 2-4ring29, 3-4ring29, 4-4rin29 
r=30: 2-4rin30, 4-4rin30 
r=31: 2-4ring31, 4-4rin31 
r=32: 1-8ring32, 2-4ring32, 4-4rin32 
r=33: 1-8ring33, 1-4ring33, 4-4rin33 
r=34: 1-8ring34, 1-4rin34, 4-4rin34 
r=35: 1-8ring35, 4-4ring35 
r=36: 1-4ring36, 4-4rin36 
r=37: 3-8ring37, 2-4ring37, 4-4rin37 
r=38: 1-4rin38, 4-4rin38 
r=39: 1-16ring39, 1-8rin39, 3-16ring39, 1-4rin39, 7-8rin39, 4-4rin39 
r=40: 1-4ring40, 7-8rin40, 4-4rin40 
r=41: 4-4ring41 
r=42: 2-4ring42 
r=43: 2-4ring43, 4-4rin43 
r=44: 2-4ring44, 4-4rin44 
r=45: 2-4ring45, 4-4rin45 
r=46: 2-4ring46, 4-4rin46 
r=47: 4-4rin47 
r=48: 1-4rin48, 4-4rin48 
r=49: 1-4rin49, 4-4ring49 
r=50: 1-4rin50, 4-4rin50 
r=51: 4-4rin51 
r=52: 2-4rin52, 4-4rin52 
r=53: 3-16ring53 
r=55: 2-4ring55 
r=57: 1-16ring57, 1-4ring57, 4-4rin57 
r=61: 4-4ring61 
r=66: 1-4ring66, 4-4ring66 
r=67: 1-4ring67 
r=68: 4-4ring68 
r=70: 1-16ring70, 1-8ring70, 3-16ring70, 2-4ring70, 4-4ring70 
r=71: 4-4ring71 
r=77: 4-4rin77 
r=78: 4-4rin78 
r=79: 1-4ring79, 4-4rin79 
r=80: 3-16ring80 
r=81: 4-4ring81 
r=85: 4-4rin85 
r=88: 4-4ring88 
r=95: 4-4ring95 
r=97: 4-4ring97 
r=101: 4-4ring101 
 
High resolution: 
r=1: 1-24ring1, 1-12rin1, 1-8ring1, 1-6ring1, 3-16ring1, 11-48ring1, 1-4ring1, 5-16ring1, 7-16ring1, 2-4ring1, 4-4ring1.dat 
r=2: 1-24ring2, 1-16ring2, 1-12rin2, 5-48ring2, 1-8ring2, 1-6ring2, 3-16ring2, 5-24ring2, 1-4ring2, 1-3ring2, 3-8ring2, 7-16ring2, 2-4ring2, 19-24ring2, 7-8ring2, 4-4ring2 
r=3: 1-24rin3, 1-16rin3, 1-12ring3, 1-8ring3, 7-48ring3, 1-6ring3, 5-24ring3, 1-4ring3, 1-3ring3, 7-16rin3, 2-4ring3, 4-4ring3 
r=4: 1-24rin4, 1-12ring4, 5-48rin4, 1-8ring4, 7-48ring4, 5-24ring4, 1-4ring4, 7-24rin4, 2-4ring4, 4-4ring4 
r=5: 1-24rin5, 1-12rin5, 5-48ring5, 1-8ring5, 7-48rin5, 1-6ring5, 5-24ring5, 1-4ring5, 2-4ring5, 4-4ring5 
r=6: 1-48rin6, 1-24rin6, 1-16ring6, 1-12rin6, 1-8ring6, 1-6ring6, 5-24ring6, 1-4ring6, 2-4ring6, 5-6ring6, 4-4ring6 
r=7: 1-24rin7, 1-16ring7, 1-8ring7, 7-48ring7, 1-6ring7, 3-16rin7, 5-24rin7, 1-4ring7, 2-3ring7, 3-4ring7, 4-4ring7 
r=8: 1-16rin8, 1-12rin8, 1-8ring8, 7-48ring8, 1-6ring8, 3-16rin8, 5-24ring8, 1-4ring8, 11-24ring8, 4-4ring8 
r=9: 1-48rin9, 1-24rin9, 1-12rin9, 5-48rin9, 1-8ring9, 5-24rin9, 11-48ring9, 1-6ring9, 1-4ring9, 1-3ring9, 2-4ring9, 4-4ring9 
r=10: 1-24ring10, 1-16ring10, 1-12ring10, 5-48ring10, 1-8ring10, 7-48ring10, 1-6ring10, 5-24ring10, 1-4rin10, 2-4ring10, 4-4rin10 
r=11: 1-24ring11, 1-16ring11, 1-8ring11, 7-48ring11, 3-16ring11, 1-4rin11, 7-16ring11, 2-4rin11, 4-4rin11 
r=12: 1-12ring12, 1-8ring12, 1-4ring12, 1-6rin12, 2-4rin12, 4-4rin12 
r=13: 1-16ring13, 1-12ring13, 1-8ring13, 1-6rin13, 5-24ring13, 1-4rin13, 5-12ring13, 11-24ring13, 3-4rin13, 4-4rin13 
r=14: 1-24ring14, 1-16ring14, 1-12ring14, 1-8rin14, 1-6rin14, 3-16ring14, 1-4rin14, 3-8ring14, 5-12ring14, 3-4rin14, 4-4rin14 
r=15: 1-48ring15, 1-24ring15, 1-16ring15, 1-12ring15, 1-8ring15, 1-6ring15, 3-16ring15, 5-24ring15, 1-4rin15, 2-4ring15, 4-4rin15 
r=16: 1-16ring16, 1-8rin16, 7-48ring16, 1-6rin16, 1-4rin16, 7-16ring16, 2-4rin16, 3-4rin16, 5-6rin16, 4-4rin16 
r=17: 1-16ring17, 1-12ring17, 1-6rin17, 5-24ring17, 1-4rin17, 1-3rin17, 2-4rin17, 4-4rin17 
r=18: 1-16ring18, 7-48ring18, 1-6rin18, 5-24ring18, 1-4rin18, 4-4rin18 
r=19: 1-24ring19, 1-16ring19, 1-12ring19, 5-48ring19, 1-8ring19, 1-6rin19, 11-48ring19, 1-4rin19, 2-4rin19, 4-4rin19 
r=20: 1-12ring20, 1-8rin20, 5-24ring20, 11-48ring20, 1-4rin20, 4-4rin20 
r=21: 1-16ring21, 11-48ring21, 1-4rin21, 4-4rin21 
r=22: 1-12ring22, 11-48ring22, 1-4rin22, 4-4rin22 
r=23: 1-4rin23 
r=24: 1-24ring24, 1-12ring24, 5-24ring24, 1-4rin24, 4-4rin24 
r=25: 3-16ring25, 1-4rin25, 4-4rin25 
r=26: 1-4rin26, 4-4rin26 
r=27: 1-4rin27, 4-4rin27 
r=28: 1-8rin28, 5-24ring28, 11-48ring28, 1-4ring28, 4-4rin28 
r=29: 1-24ring29, 1-16ring29, 1-12ring29, 5-48ring29, 7-48ring29, 1-6ring29, 3-16ring29, 11-48ring29, 1-4rin29, 5-24ring29, 4-4rin29 
r=30: 1-24ring30, 1-16ring30, 1-4rin30, 3-8ring30, 4-4rin30 
r=31: 1-4rin31, 2-4rin31 
r=32: 5-48ring32, 1-4rin32, 2-4ring32 
r=33: 5-24ring33, 1-4rin33, 4-4rin33 
r=34: 7-48ring34, 5-24ring34, 11-48ring34, 1-4rin34, 2-4ring34, 4-4rin34 
r=35: 1-24ring35, 1-16ring35, 1-8rin35, 5-24ring35, 1-4rin35, 4-4ring35 
r=36: 1-8ring36, 1-4rin36, 1-3ring36, 4-4ring36 
r=37: 1-8ring37, 1-4rin37, 2-4ring37, 4-4rin37 
r=38: 1-12ring38, 1-6ring38, 1-4rin38, 4-4ring38 
r=39: 1-24ring39, 1-16ring39, 1-12ring39, 5-48ring39, 1-8rin39, 7-48ring39, 1-6ring39, 3-16ring39, 1-4rin39, 2-4ring39, 4-4ring39 
r=40: 1-4rin40, 11-48ring40, 2-4ring40 
r=41: 1-8ring41, 1-4rin41, 4-4rin41 
r=42: 1-12ring42, 1-6ring42, 4-4rin42 
r=43: 1-48ring43, 1-16ring43, 1-12ring43, 1-6ring43, 4-4ring43 
r=44: 4-4ring44 
r=45: 1-4rin45, 4-4ring45 
r=46: 1-4ring46 
r=47: 1-6rin47, 1-4ring47, 4-4rin47 
r=48: 7-48ring48, 1-4rin48, 2-4ring48 
r=49: 1-24ring49, 1-16ring49, 1-4ring49, 4-4rin49 
r=50: 1-6rin50, 3-16ring50, 4-4rin50 
r=51: 1-4rin51 
r=52: 11-24ring52, 4-4rin52 
r=53: 1-8ring53, 3-16ring53, 4-4rin53 
r=54: 4-4rin54 
r=55: 2-4ring55 
r=56: 1-12ring56, 1-8rin56 
r=57: 1-4ring57, 4-4ring57 
r=59: 1-24ring59, 1-16ring59, 1-12ring59 
r=60: 1-24ring60, 1-16ring60 
r=63: 1-4rin63 
r=64: 1-4rin64 
r=65: 1-4rin65 
r=69: 5-24ring69 
r=70: 1-4rin70 
r=71: 1-4rin71, 4-4ring71 
r=77: 4-4ring77 
r=78: 1-12ring78 
r=79: 1-4ring79 
r=80: 7-48ring80, 1-6ring80 
r=81: 4-4ring81 
r=82: 1-4rin82 
r=83: 1-4rin83 
r=84: 1-8ring84 
r=85: 4-4ring85 
r=88: 4-4ring88 
r=90: 11-48ring90 
r=95: 2-4ring95 
r=96: 1-4ring96 
r=97: 4-4rin97 
r=99: 1-6ring99, 4-4ring99 
r=100: 1-24ring100, 4-4ring100 
r=130: 4-4ring130 
r=160: 2-4ring160 
r=179: 1-4ring179 
r=240: 2-4ring240 
 
Low resolution: 
r=2 : 2-4ring2, 4-4ring2 
r=3 : 1-4ring3, 4-4ring3 
r=6 : 4-4ring6 
r=7 : 4-4ring7 
r=11 : 4-4ring11 
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable"
|+
=== Three dimensional ===
|-

| '''n-fcyli.dat''' '''n-fcyli2.dat''' || '''Circular cylinder'''
|-
| [[File:4-4cyli.png |200px|thumb|alt=4-4cyli]]
||This suite of primitives are used to generate cylinders or part cylinders. These are provided in two forms - with conditional lines (n-fcyli) or without conditional lines (n-fcyli2). In almost all circumstances the "cyli" version should be used. The "cyli2" versions are for very special cases and their use for the rounded corners of stickers is no longer appropriate.

''Currently available primitives - with conditional lines (n-fcyli):'' 
Regular resolution (n-f): 1-16, 1-8, 3-16, 1-4, 5-16, 3-8, 7-16, 2-4, 9-16, 5-8, 11-16, 3-4, 13-16, 7-8, 4-4 
High resolution (n-f): 1-48, 1-24, 1-16, 1-12, 5-48, 1-8, 7-48, 1-6, 3-16, 5-24, 11-48, 1-4, 7-24, 5-16, 1-3, 3-8, 5-12, 7-16, 11-24, 2-4, 5-8, 2-3, 3-4, 7-8, 4-4 
Low resolution (n-f): 1-4, 3-8, 2-4, 4-4

''Currently available primitives - without conditional lines (n-fcyli2):'' 
Regular resolution (n-f): 1-8, 3-16, 1-4, 5-16, 2-4, 3-8, 4-4 
High resolution (n-f): 1-8, 3-16, 1-4, 3-8, 2-4, 4-4 
Low resolution (n-f): None
|-

| '''n-fcylo.dat''' || '''Circular cylinder with Open End'''
|-
| [[File:4-4cylo.png |200px|thumb|alt=4-4cylo]]
||This suite of primitives are used to generate cylinders or part cylinders with edges around the lower and upper surfaces.

''Currently available primitives:'' 
Regular resolution (n-f): 1-16, 1-8, 3-16, 1-4, 5-16, 3-8, 7-16, 2-4, 9-16, 5-8, 3-4, 7-8, 4-4 
High resolution (n-f): 1-48, 1-24, 1-16, 1-12, 5-48, 1-8, 7-48, 1-6, 3-16, 5-24, 11-48, 1-4, 1-3, 3-8, 2-4, 4-4 
Low resolution (n-f): 1-4, 3-8, 2-4, 4-4
|-

| '''n-fcylc.dat''' '''n-fcylc2.dat''' '''n-fcylc3.dat''' || '''Circular cylinder with Closed End'''
|-
| [[File:4-4cylc.png |200px|thumb|alt=4-4cylc]]
||This suite of primitives are used to generate cylinders or part cylinders with the upper surface closed.

''Currently available primitives - with conditional lines and top edge line (n-fcylc):'' 
Regular resolution (n-f): 1-16, 1-4, 3-8, 2-4, 3-4, 4-4 
High resolution (n-f): 2-4, 4-4 
Low resolution (n-f): None 

''Currently available primitives - without conditional lines or top or bottom edge line (n-fcylc2):'' 
Regular resolution (n-f): 1-4, 4-4 
High resolution (n-f): 4-4 
Low resolution (n-f): None 

''Currently available primitives - with conditional lines, but without top and bottom edge lines (n-fcylc3):'' 
Regular resolution (n-f): 1-4, 4-4 
High resolution (n-f): 4-4 
Low resolution (n-f): None
|-

| '''n-fcyls.dat''' '''n-fcyls2.dat''' || '''Circular cylinder truncated by an angled plane'''
|-
| [[File:2-4cyls.png |200px|thumb|alt=2-4cyls]]
[[File:3-8cyls.png |200px|thumb|alt=3-8cyls]]

||These primitives are used to generate cylinders or part cylinders which are truncated by a plane which is not perpendicular to the axis of the cylinder. The default angle of the plane is 45 degress.

These primitives are notoriously difficult to describe and the user is encouraged to experiment in order to gain a full understanding of their geometry. One technique is to open the primitive in LDPE and choose random colours. Selecting Show Axes also helps.

The 2-4cyls.dat primitive is orientated with the perpendicular bounding plane at the top {-y} and the angled bounding plane at the bottom {+y}. In common with the other 2-4xxxx.dat primitives, the {+z} semicircle is represented. By default the truncation plane is y=x-1. The 1-4cyls.dat and 3-8cyls.dat primitives are sub-sections of 2-4cyls.dat

The 1-4cyls2.dat primitive is orientated with the perpendicular bounding plane at the top {-y} and the angled bounding plane at the bottom {+y}. Unlike the other 1-4xxxx.dat primitives, the {-x,+z} quadrant is represented. The truncation plane is y=x.

The following observations may help :

1-4cyls and 1-4cyls2 are complements. If you put them together correctly they make a 1-4cyli.

1 16    0 0 0    1 0 0    0 1 0    0 0 1    1-4cyls.dat

1 16    0 1 0    -1 0 0    0 -1 0    0 0 1    1-4cyls2.dat

1-4cyls2 is actually hidden in 2-4cyls, which could be constructed like

1 16    0 0 0    1 0 0    0 1 0    0 0 1    1-4cyls.dat

1 16    0 0 0    0 0 -1    0 1 0    1 0 0    1-4cyli.dat

1 16    0 1 0    1 0 0    0 1 0    0 0 1    1-4cyls2.dat

''Currently available primitives:'' 
Regular resolution (n-f): 1-8cyls, 3-16cyls, 1-4cyls, 3-8cyls, 2-4cyls, 4-4cyls, 1-8cyls2, 3-16cys2, 1-4cyls2 
High resolution (n-f): 1-4cyls, 1-4cyls2
|-

| '''n-fcylse.dat''' || '''Circular cylinder truncated by an angled plane with angled edge included'''
|-
| [[File:4-4cylse.png |200px|thumb|alt=4-4cylse]]
||This suite of primitives are similar to the n-fcyls primitive, but with the edge along the angled plane included.

''Currently available primitives:'' 
Regular resolution (n-f): 4-4
|-

| '''cyljrxs.dat''' || '''Circular cylinder truncated by another cylinder'''
|-
| [[File:Cylj4x8.png |200px|thumb|alt=cylj4x8]]
||This suite of primitives are used to model the intersection between two cylinders of different radii.

'''Currently available primitives:''' 
Regular resolution (rxs): 4x6, 4x7, 4x8, 4x9, 4x10, 5x9
|-

| '''n-fcylrsphs.dat''' || '''Circular cylinder truncated by a sphere'''
|-
| [[File:4-4cyl1sph2.png |200px|thumb|alt=4-4cyl1sph2]]
||This suite of primitives are used to model the intersection between a cylinder and a sphere of a different radius.

'''Currently available primitives:''' 
Regular resolution 1:2 (n-f): 4-4cyl1sph2
|-

| '''n-fconr.dat''' '''n-fconrr.dat''' || '''Circular cone'''
|-
| [[File:4-4con1.png |200px|thumb|alt=4-4con1]]
||This suite of primitives are used to generate circular cones or part cones. The numeric suffix r in the filename indicates the inner radius of the cone - the outer radius is 1LDu greater. By default the cone is 1LDu high in the {+y} dimension with the origin at the centre of the outer diameter. For example a n-fcone4 primitive would create a cone with an inner radius of 4LDu and an outer radius of 5LDu.

''Currently available primitives:'' 
Regular resolution (n-f)(r): 
r=0: 1-4con0, 2-4con0, 4-4con0 
r=1: 1-16con1, 1-8con1, 3-16con1, 1-4con1, 2-4con1, 4-4con1 
r=2: 1-8con2, 3-16con2, 1-4con2, 2-4con2, 4-4con2 
r=3: 1-8con3, 1-4con3, 2-4con3, 7-8con3, 4-4con3 
r=4: 1-4con4, 3-8con4, 2-4con4, 4-4con4 
r=5: 1-4con5, 4-4con5 
r=6: 1-4con6, 3-8con6, 4-4con6 
r=7: 1-4con7, 3-8con7, 2-4con7, 4-4con7 
r=8: 1-4con8, 2-4con8, 4-4con8 
r=9: 3-16con9, 1-4con9, 3-8con9, 4-4con9 
r=10: 1-8con10, 1-4con10, 2-4con10, 4-4con10 
r=11: 1-4con11, 2-4con11, 4-4con11 
r=12: 1-4con12, 3-8con12, 2-4con12, 4-4con12 
r=13: 1-4con13, 2-4con13, 4-4con13 
r=14: 1-4con14, 4-4con14 
r=15: 1-4con15, 2-4con15, 4-4con15 
r=16: 4-4con16 
r=17: 4-4con17 
r=18: 1-4con18, 4-4con18 
r=19: 1-8con19, 1-4con19, 2-4con19, 4-4con19 
r=20: 1-8con20, 3-8con20, 4-4con20 
r=21: 4-4con21 
r=22: 4-4con22 
r=23: 1-4con23 
r=24: 1-4con24, 4-4con24 
r=25: 4-4con25 
r=27: 1-4con27 
r=28: 1-8con28, 1-4con28, 4-4con28 
r=29: 4-4con29 
r=30: 4-4con30 
r=31: 1-4con31 
r=32: 4-4con32 
r=33: 4-4con33 
r=34: 3-8con34 
r=35: 4-4con35 
r=36: 4-4con36 
r=41: 4-4con41 
r=42: 4-4con42 
r=43: 4-4con43 
r=46: 4-4con46 
r=47: 4-4con47 
r=48: 4-4con48 
r=61: 4-4con61 
r=80: 4-4con80 
r=81: 4-4con81 

High resolution (n-f)(r): 
r=0: 4-4con0 
r=1: 1-4con1, 4-4con1 
r=2: 1-4con2, 5-12con2, 4-4con2 
r=3: 1-4con3, 5-24con3, 4-4con3 
r=4: 1-12con4, 1-6con4, 1-4con4, 4-4con4 
r=5: 1-12con5, 1-8con5, 1-6con5, 1-4con5, 4-4con5 
r=6: 5-48con6, 1-8con6, 1-4con6 
r=7: 1-24con7, 1-12con7, 1-6con7, 4-4con7 
r=8: 1-6con8, 1-4con8, 4-4con8 
r=9: 1-16col9, 5-48con9, 1-8con9, 5-24con9, 1-4con9, 4-4con9 
r=10: 1-24con10, 5-24con10, 4-4con10 
r=11: 1-16con11, 1-8con11, 1-4con11, 4-4con11 
r=12: 1-24con12, 5-48con12, 1-8con12, 5-24con12, 1-4con12, 4-4con12 
r=13: 1-6con13, 1-4con13, 4-4con13 
r=14: 1-24con14, 5-24con14, 1-4con14, 3-8con14 
r=15: 1-8con15, 1-4con15, 4-4con15 
r=16: 1-24con16, 1-6con16, 5-24con16, 1-4con16, 3-8con16, 4-4con16 
r=17: 1-6con17, 4-4con17 
r=18: 4-4con18 
r=19: 1-16con19, 3-16con19, 1-4con19, 4-4con19 
r=20: 1-16con20, 4-4con20 
r=21: 1-4con21, 4-4con21 
r=22: 4-4con22 
r=23: 1-4con23, 4-4con23 
r=24: 1-24con24, 1-16con24, 1-12con24, 1-4con24, 4-4con24 
r=25: 1-4con25, 4-4con25 
r=27: 4-4con27 
r=28: 1-4con28 
r=29: 5-48con29 
r=32: 1-4con32 
r=31: 1-6con31, 4-4con31 
r=32: 1-4con32 
r=35: 4-4con35 
r=36: 1-4con36, 4-4con36 
r=38: 1-4con38 
r=39: 1-4con39, 4-4con39 
r=40: 1-4con40 
r=41: 1-4con41, 4-4con41 
r=45: 1-6con45 
r=46: 1-6con46 
r=52: 1-4con52 
r=54: 4-4con54 
r=64: 4-4con64 
r=70: 4-4con70 
|-

| '''tffirrrr.dat''' '''tfforrrr.dat''' '''tffqrrrr.dat''' '''rfforrrr.dat''' '''rfforrrrr.dat''' || '''Circular torus'''
|-
| [[File:T02i2000.png |200px|thumb|alt=T02i2000.png]]
[[File:T02o2000.png |200px|thumb|alt=T02o2000.png]]
[[File:T02q1765.png |200px|thumb|alt=T02q1765.png]]

||This suite of primitives are used to generate circular torus sections. By default all these primitives produce a torus with a major radius of 1LDu, so typically need to be scaled up in the {x} and {z} dimensions. The first character denotes whether the minor radius is smaller than (tff primitives) or larger than the major radius (rff primitives). The latter are termed reverse ratio tori. The second and third characters of the filename ff denotes the sweep of torus, as an inverse fraction (01=1/1, 02=1/2, 04=1/4, 08=1/8, 16=1/16, 32=1/32, 48=1/48). The fourth character denotes the section of a torus (i=inner, o=outer, q=tube - the combination of 2 inner and 2 outer sections). Inner sections are not possible for reverse ratio tori.

For regular tori, the last four characters of the file name rrrr denote the torus minor radius in LDu (1333=0.1333, 3333=0.3333), with the special designation 'unit' unsed to indicate a radius of 1.0000.
For reverse ratio tori named like rfforrrr.dat, the last four characters of the file name rrrr represent torus minor radius with an implied decimal point after the first digit (1500=1.5, 4600=4.6). For reverse ratio tori named like rfforrrrr.dat, the last five characters of the file name rrrrr represent torus minor radius with an implied decimal point after the first two digits (11000=11.0).

These diagrams (based on an idea of Paul Easter's) illustrate the relationship of the torus primitives to the major and minor radii.

<gallery mode=nolines widths="200px">
torusi.png|Regular inner torus
toruso.png|Regular outer torus
torusro.png| Reverse ratio outer torus
</gallery>

''Currently available regular torus primitives:'' 
Regular resolution (ff)(rrrr): 
Inner: 
::t01i0702, t01i0714, t01i0769, t01i1579, t01i1667, t01i2000, t01i3261, t01i3333, t01i3600, t01i5556, t01i6000 
::t02i1111, t02i2000, t02i2258, t02i4000 
::t04i0462, t04i0625, t04i0857, t04i1111, t04i1304, t04i1333, t04i1429, t04i1765, t04i2000, t04i2258, t04i2500, t04i2667, t04i3333, t04i4167, t04i5000, t04i6381 
::t08i0909, t08i2000 
::t16i0909, t16i2000 
 
Outer: 
::t01o0556, t01o0625, t01o0667, t01o0714, t01o1154, t01o1250, t01o1429, t01o1579, t01o2222, t01o2500, t01o3333, t01o3571, t01o3750, t01o3810, t01o3889, t01o4000 
::t02o0526, t02o1111, t02o1176, t02o2000, t02o3333 
::t04o0462, t04o0625, t04o0833, t04o0857, t04o1111, t04o1250, t04o1304, t04o1333, t04o1429, t04o1538, t04o1667, t04o1765, t04o1905, t04o2000, t04o2500, t04o2667, t04o3077, t04o3333, t04o3750, t04o4167, t04o5000, t04o6250, t04o6667, ::t04o7000, t04o7500, t04o8750, t04o8889 
::t08o0727, t08o0909, t08o2000, t08o6250 
::t16o0909, t16o1429, t16o2000, t16o6250 
 
Tube: 
::t01q0702, t01q1429 
::t02q3333, t02q5455 
::t04q0625, t04q1000, t04q1316, t04q1538, t04q2500, t04q2857, t04q3030, t04q3333, t04q3529, t04q3750, t04q4000, t04q5000, t04q5455, t04q7143, t04q7500, t04q9231 
::t08q4000, t08q5000, t08q7500 
::t16q4000, t16q5000, t16q7500 
 
High resolution (ff)(rrrr): 
Inner: 
::t04i0455 
::t12i8333 
 
Outer: 
::t01o2000 
::t04o0455, t04o2000 
::t08o0625, t08o2500 
::t12o0349, t12o0625 
 
Tube: 
::t06q5000 
 
''Currently available reverse ratio torus primitives:'' 
Regular resolution: 
::r04o1000, r04o1333, r04o1375, r04o1500, r04o2000, r04o3000, r04o4600 
 
High resolution: 
::r04o11000 
::r08o2000, r08o11000 
|-

| '''<s>1-4ccyli.dat</s>''' || '''<s>Circular torus</s> (obsolete)'''
|-
| [[File:T04q4000.png |200px|thumb|alt=T04q4000]]
||This single primitive pre-dates the creation of the tffirrrr and tfforrrr suite of primitives and will not be augmented. It produces a quarter torus with a major radius of 2.5Ldu and a tube radius of 1LDu.

It is superceded by t04q4000.dat.
|-

| '''n-fsphe.dat''' || '''Sphere section'''
|-
| [[File:8-8sphe.png |200px|thumb|alt=8-8sphe]]
|| This primitive represents a sphere, centered at the origin {0,0,0} of radius 1 LDu.

''Currently available primitives:'' 
Regular resolution (n-f): 1-8, 2-8, 4-8, 8-8 
High resolution (n-f): 2-8, 4-8, 8-8
|-

| '''1-8sphc.dat''' || '''Spherical corner'''
|-
| [[File:1-8sphc.png |200px|thumb|alt=1-8sphc]]
||This primitive represents one octant (eighth) of a sphere, centered at the origin {0,0,0} of radius 1.414, truncated by the sides of a cube with a vertex at {1,1,1}. The boundaries of the resulting surface are circular and fit with 1-4edge.dat.
|-

| '''n-fedgh.dat''' || '''Cylinder Helical Edge'''
|-
| [[File:Placeholder.png |200px|thumb|alt=Placeholder]]
||This primitive represents ...

''Currently available primitives:'' 
Regular resolution (n-f): 3-16, 1-8, 1-4 

|-

| '''n-fcylh.dat''' || '''Cylinder Helical'''
|-
| [[File:Placeholder.png |200px|thumb|alt=Placeholder]]
||This primitive represents ...

''Currently available primitives:'' 
Regular resolution (n-f): 3-16, 1-8, 1-4 
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

==Technic primitives==

{| class="wikitable" style="width: 100%;"
|+
===Technic axle primitives===
|-

|colspan="2"|
These primitives represent various components of the technic axle and its matching hole. They are orientated in the {x,z} plane. Except where noted below, and in the {y} dimension only, these primitives must not be scaled.
|-

| '''axle.dat''' || '''Technic axle section'''
|-
|style="width: 200px;"| [[File:Axle.png|200px|thumb|alt=Axle]]
||This primitive comprises a 1LDu long section of technic axle, including its ends. It may be scaled in the {y} dimension to produce an axle of any length.
|-

| '''axleend.dat''' || '''Technic axle end'''
|-
| [[File:axleend.png|200px|thumb|alt=Axleend]]
||This primitive is used to produce the "plus-shaped" cross section of a technic axle.
|-

| '''axlehole.dat''' || '''Technic axle hole - closed'''
|-
| [[File:Axlehole.png|200px|thumb|alt=Axlehole]]
||This primitive produces a technic axle hole with the disc ends and all sides. It may be scaled in the {y} dimension as necessary.
|-

| '''axlehol2.dat''' || '''Technic axle hole - side edges'''
|-
| [[File:Axlehol2.png|200px|thumb|alt=Axlehol2]]
||This primitive produces the edges at the ends of the "plus-shaped" technic axle.
|-

| '''axlehol3.dat''' || '''Technic axle hole - tooth outer edges'''
|-
| [[File:Axlehol3.png|200px|thumb|alt=Axlehol3]]
||This primitive produces the outer edges of the teeth of a technic axle hole.
|-

| '''axlehol4.dat''' || '''Technic axle hole - open one side'''
|-
| [[File:Axlehol4.png|200px|thumb|alt=Axlehol4]]
||This primitive produces a technic axle hole with one side omitted. It may be scaled in the {y} dimension as necessary.
|-

| '''axlehol5.dat''' || '''Technic axle hole - open two opposite sides'''
|-
| [[File:Axlehol5.png|200px|thumb|alt=Axlehol5]]
||This primitive produces a technic axle hole with two opposite sides omitted. It may be scaled in the {y} dimension as necessary.
|-

| '''axlehol6.dat''' || '''Technic axle hole tooth'''
|-
| [[File:Axlehol6.png|200px|thumb|alt=Axlehol6]]
||This primitive represents one tooth of a technic axle hole. It may be scaled in the {y} dimension as necessary.
|-

| '''axlehol7.dat''' || '''Technic axle hole - sides'''
|-
| [[File:Axlehol7.png|200px|thumb|alt=Axlehol7]]
||This primitive comprises a 1LDu long section of outer sides of a technic axle. It may be scaled in the {y} dimension.
|-

| '''axlehol8.dat''' || '''Technic axle hole perimeter'''
|-
| [[File:Axlehol8.png|200px|thumb|alt=Axlehol8]]
||This primitive comprises a 1LDu long section of technic axle, without any ends. It may be scaled in the {y} dimension as necessary.
|-

| '''axlehol9.dat''' || '''Technic axle hole - tooth inner edges'''
|-
| [[File:Axlehol9.png|200px|thumb|alt=Axlehol9]]
||This primitive produces the inner edges of the "plus-shaped" technic axle.
|-

| '''axleho10.dat''' || '''Technic axle hole - tooth surface'''
|-
| [[File:Axleho10.png|200px|thumb|alt=Axleho10]]
||This primitive is used to produce the fill the "plus-shaped" cross section of a technic axle to the bounding circle.
|-

| '''Axlehol0.dat''' || '''Technic Axle Hole Hint'''
|-
| [[File:Axlehol0.png|200px|thumb|alt=Axlehol0]]
||This file is an invisible "axlehole" that can be used to hint irregular axleholes that cannot be modeled with conventional axlehole primitives. To use: add an axle.dat in your part, apply position and scaling so that it fills the axlehole, and substitute it with this primitive. 

Note that the bounding axle sction in the image is for context only - there are no actual geometry producing lines contained in these files.
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable" style="width: 100%;"
|+
===Technic axle hole reduced===
|-

| '''axl2hole.dat''' || '''Technic axle hole reduced'''
|-
|style="width: 200px;"| [[File:Axl2hole.png|200px|thumb|alt=Axl2hole]]
||This primitive produces a technic axle hole with reduced teeth including the disc ends and all edges. It may be scaled in the {y} dimension as necessary.
|-

| '''axl2hol2.dat''' || '''Technic axle hole reduced - side edges'''
|-
| [[File:Axl2hol2.png|200px|thumb|alt=Axl2hol2]]
||This primitive produces the edges at the ends of the "plus-shaped" reduced technic axle.
|-

| '''axl2hol3.dat''' || '''Technic axle hole reduced - tooth outer edges'''
|-
| [[File:Axl2hol3.png|200px|thumb|alt=Axl2hol3]]
||This primitive produces the outer edges of the teeth of a reduced technic axle hole.
|-

| '''axl2hol8.dat''' || '''Technic axle hole reduced - perimeter'''
|-
| [[File:Axl2hol8.png|200px|thumb|alt=Axl2hol8]]
||This primitive comprises a 1LDu long section of reduced technic axle, without any ends. It may be scaled in the {y} dimension as necessary.
|-

| '''axl2hol9.dat''' || '''Technic axle hole reduced - tooth inner edges'''
|-
| [[File:Axl2hol9.png|200px|thumb|alt=Axl2hol9]]
||This primitive produces the inner edges of the reduced "plus-shaped" technic axle.
|-

| '''axl2ho10.dat''' || '''Technic axle hole reduced - tooth surface'''
|-
| [[File:Axl2ho10.png|200px|thumb|alt=Axl2ho10]]
||This primitive used to produce the fill the "plus-shaped" cross section of a reduced technic axle to the bounding circle.
|-

| '''axl2end.dat''' || '''Technic axle hole reduced - end surface'''
|-
| [[File:Axl2end.png|200px|thumb|alt=Axl2end]]
||This primitive is used to produce the "plus-shaped" cross section of a technic axle hole reduced.
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable" style="width: 100%;"
|+
===Technic axle hole semi-reduced===
|-

| '''axl3hole.dat''' || '''Technic axle hole semi-reduced'''
|-
|style="width: 200px;"|[[File:Axl3hole.png|200px|thumb|alt=Axl3hole]]
||This primitive produces a technic axle hole with semi-reduced teeth including the disc ends and all edges. It may be scaled in the {y} dimension as necessary.
|-

| '''axl3hol2.dat''' || ''' Technic axle hole semi-reduced - side edges'''
|-
| [[File:Axl3hol2.png|200px|thumb|alt=Axl3hol2]]
||This primitive produces the edges at the ends of the "plus-shaped" semi-reduced technic axle.
|-

| '''axl3hol3.dat''' || '''Technic axle hole semi-reduced - tooth outer edges'''
|-
| [[File:Axl3hol3.png|200px|thumb|alt=Axl3hol3]]
||This primitive produces the outer edges of the teeth of a semi-reduced technic axle hole.
|-

| '''axl3hol6.dat''' || '''Technic axle hole semi-reduced tooth'''
|-
| [[File:Axl3hol6.png|200px|thumb|alt=Axl3hol6]]
||This primitive represents the teeth of a semi-reduced technic axle hole. It may be scaled in the {y} dimension as necessary.
|-

| '''axl3hol8.dat''' || '''Technic axle hole semi-reduced - perimeter'''
|-
| [[File:Axl3hol8.png|200px|thumb|alt=Axl3hol8]]
||This primitive comprises a 1LDu long section of semi-reduced technic axle, without any ends. It may be scaled in the {y} dimension as necessary.
|-

| '''axl3hol9.dat''' || '''Technic axle hole semi-reduced - tooth inner edges'''
|-
| [[File:Axl3hol9.png|200px|thumb|alt=Axl3hol9]]
||This primitive produces the inner edges of the semi-reduced "plus-shaped" technic axle.
|-

| '''axl3ho10.dat''' || ''' Technic axle hole semi-reduced - tooth surface'''
|-
| [[File:Axl3ho10.png|200px|thumb|alt=Axl3ho10]]
|| This primitive used to produce the fill the "plus-shaped" cross section of a semi-reduced technic axle to the bounding circle.
|-

| '''axl3end.dat''' || '''Technic axle hole semi-reduced - end surface'''
|-
| [[File:Axl3end.png|200px|thumb|alt=Axl3end]]
||This primitive is used to produce the "plus-shaped" cross section of a technic axle hole semi-reduced.
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable" style="width: 100%;"
|+
===Special Technic axle primitive===
|-

| '''axlebeam.dat''' || '''Technic Axle Truncated to fit Technic Beam End Surface'''
|-
|style="width: 200px;"|[[File:Axlebeam.png|200px|thumb|alt=Axlebeam]]
||This primitive produces the tip of an axle to be used between a cylinder of 9 LDu radius and an axle primitive.

Usage example: 
1 16 0 0 -10 9 0 0 0 0 -9 0 20 0 2-4cyli.dat 
1 16 0 0 0 1 0 0 0 1 0 0 0 1 axlebeam.dat 
1 16 0 -20 0 1 0 0 0 10 0 0 0 1 axlehol8.dat
|-

| '''axlesphe.dat''' || '''Technic axle - truncated to fit ball joint'''
|-
| [[File:Axlesphe.png|200px|thumb|alt=Axlesphe]]
||This primitive produces the tip of an axle, truncated to fit a 12.81 LDu radius sphere.

Usage example: 
1 16 0 0 0 12.81 0 0 0 0 12.81 0 -12.81 0 8-8sphe.dat 
1 16 0 0 0 1 0 0 0 1 0 0 0 1 axlesphe.dat 
1 16 0 -20 0 1 0 0 0 7.19 0 0 0 1 axlehol8.dat
|-

| '''axles.dat''' || '''Axle Sloped'''
|-
| [[File:Axles.png|200px|thumb|alt=Axles]]
||This primitive produces the tip of an axle, truncated by a slope with the height of 1 LDu. It may be scaled in the {y} dimension as necessary.
|-

| '''axlecap.dat''' || '''Axle Endcap'''
|-
| [[File:Axlecap.png|200px|thumb|alt=Axlecap]]
||This primitive produces the beveled tip of an axle.
|-

| '''axlecaph.dat''' || '''Axle Endcap with Hole 4D'''
|-
| [[File:Axlecaph.png|200px|thumb|alt=Axlecaph]]
||This primitive produces the beveled tip of an axle with a center hole of 2 LDu radius.
|-

| '''axlecaph2.dat''' || '''Axle Endcap with Hole 5D'''
|-
| [[File:Axlecaph2.png|200px|thumb|alt=Axlecaph2]]
||This primitive produces the beveled tip of an axle with a center hole of 2.5 LDu radius.
|-

| '''axleconnect.dat''' || '''Technic Axle to Connector Hole Perpendicular Joint 0.5'''
|-
| [[File:Axleconnect.png|200px|thumb|alt=Axleconnect]]
||This primitive produces a right angle connection between an axle and a Technic connector hole.

Usage example: 
1 16 0 0 0 1 0 0 0 1 0 0 0 1 axleconnect.dat 
1 16 0 0 0 -1 0 0 0 1 0 0 0 1 axleconnect.dat 
1 16 0 0 0 1 0 0 0 1 0 0 0 1 connhole.dat 
1 16 0 0 -30 0 0 -1 -1 0 0 0 20 0 axle.dat
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable" style="width: 100%;"
|+
===Technic castellated bush primitives===
|-

|colspan="2"|
These primitives are various representations of the castellated technic bush. They are orientated with the technic axle hole along the {y} axis and must not be scaled.
|-

| '''bushlock.dat''' || '''Technic 16-tooth castellation - long teeth'''
|-
|style="width: 200px;"|[[File:Bushlock.png|200px|thumb|alt=Bushlock]]
||
|-

| '''bushloc2.dat''' || '''Technic 16-tooth castellation - regular teeth'''
|-
| [[File:Bushloc2.png|200px|thumb|alt=Bushloc2]]
||
|-

| '''bushloc3.dat''' || '''Technic 16-tooth castellation - regular teeth indented'''
|-
| [[File:Bushloc3.png|200px|thumb|alt=Bushloc3]]
||This primitive differs from bushloc2.dat in that the teeth are indented in four places to allow it to fit between four adjacent studs.
|-

| '''bushloc4.dat''' || '''Technic 16-tooth castellation - short teeth'''
|-
| [[File:Bushloc4.png|200px|thumb|alt=Bushloc4]]
||
|-

| '''steerend.dat''' || '''Curved end to technic 1xn plate with 16-tooth castellation on underside'''
|-
| [[File:Steerend.png|200px|thumb|alt=Steerend]]
||
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable" style="width: 100%;"
|+
===Technic bush primtives===
|-

|colspan="2"|
These primitives are usd to construct technic bush parts.
|-

| '''bush.dat''' || '''Technic bush with collar at one end'''
|-
|style="width: 200px;" |[[File:Bush.png|200px|thumb|alt=Bush]]
|| 
|-

| '''bush0.dat''' || '''Technic bush without end collars'''
|-
| [[File:Bush0.png|200px|thumb|alt=Bush0]]
||
|-

| '''bush1.dat''' || '''Technic bush collar quarter'''
|-
| [[File:Bush1.png|200px|thumb|alt=Bush1]]
||
|-

| '''bush2.dat''' || '''Technic Bush End 0.25'''
|-
| [[File:Bush2.png|200px|thumb|alt=Bush2]]
||
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable" style="width: 100%;"
|+
===Technic connector primitives===
|-

|colspan="2"|
These primitives are used to contruct technic connector pegs. They are orientated with the technic axle hole along the {y} axis and must not be scaled.
|-

| '''connect.dat''' || '''Technic connector - long with collar'''
|-
|style="width: 200px;" |[[File:Connect.png|200px|thumb|alt=Connect]]
|| 
|-

| '''connect2.dat''' || '''Technic connector - long without collar'''
|-
| [[File:Connect2.png|200px|thumb|alt=Connect2]]
||
|-

| '''connect3.dat''' || '''Technic connector - short with collar'''
|-
| [[File:Connect3.png|200px|thumb|alt=Connect3]]
||
|-

| '''connect4.dat''' || '''Technic connector - short without collar'''
|-
| [[File:Connect4.png|200px|thumb|alt=Connect4]]
||
|-

| '''connect5.dat''' || '''Technic connector - long with collar and slot'''
|-
| [[File:Connect5.png|200px|thumb|alt=Connect5]]
||
|-

| '''connect6.dat''' || '''Technic connector - long with collar and notches'''
|-
| [[File:Connect6.png|200px|thumb|alt=Connect6]]
||
|-

| '''connect7.dat''' || '''Technic connector - long with rectangular centre hole and thin (frictionless) ribs'''
|-
| [[File:Connect7.png|200px|thumb|alt=Connect7]]
||
|-

| '''connect8.dat''' || '''Technic connector - long with collar and blind hole'''
|-
| [[File:Connect8.png|200px|thumb|alt=Connect8]]
||
|-

| '''connect10.dat''' || '''Technic Pin 1.0 without Base Collar and Rectangular Centre Hole'''
|-
| [[File:Connect10.png|200px|thumb|alt=Connect10]]
||
|-

| '''connectcollar1.dat''' || '''Technic Pin Collar Half with Rectangular Hole and Short Slit'''
|-
| [[File:Connectcollar1.png|200px|thumb|alt=Connectcollar1]]
||
|-

| '''connectcollar2.dat''' || '''Technic Pin Collar Half with Small Rectangular Hole and Short Slit'''
|-
| [[File:Connectcollar2.png|200px|thumb|alt=Connectcollar2]]
||
|-

| '''connectcollar3.dat''' || '''Technic Pin Collar Half with Rectangular Hole and Long Slit'''
|-
| [[File:Connectcollar3.png|200px|thumb|alt=Connectcollar3]]
||
|-

| '''connectcollar4.dat''' || '''Technic Pin Collar Half with Small Rectangular Hole and Long Slit'''
|-
| [[File:Connectcollar4.png|200px|thumb|alt=Connectcollar4]]
||
|-

| '''connectcollar5.dat''' || '''Technic Pin Collar Half with Round Hole and Short Slit'''
|-
| [[File:Connectcollar5.png|200px|thumb|alt=Connectcollar5]]
||
|-

| '''connectslit1.dat''' || '''Technic Pin Long Middle Slit Half with Rectangular Hole'''
|-
| [[File:Connectslit1.png|200px|thumb|alt=Connectslit1]]
||
|-

| '''connectslit2.dat''' || '''Technic Pin Long Middle Slit Half with Small Rectangular Hole'''
|-
| [[File:Connectslit2.png|200px|thumb|alt=Connectslit2]]
||
|-

| '''confric.dat''' || '''Technic connector with friction - long with collar'''
|-
| [[File:Confric.png|200px|thumb|alt=Confric]]
||
|-

| '''confric2.dat''' || '''Technic connector with friction - long without collar'''
|-
| [[File:Confric2.png|200px|thumb|alt=Confric2]]
||
|-

| '''confric3.dat''' || '''Technic connector with friction - long with rectangular centre hole and collar'''
|-
| [[File:Confric3.png|200px|thumb|alt=Confric3]]
||
|-

| '''confric4.dat''' || '''Technic connector with friction - long with collar and blind hole'''
|-
| [[File:Confric4.png|200px|thumb|alt=Confric4]]
||
|-

| '''confric5.dat''' || '''Technic connector with friction - long with collar and slot'''
|-
| [[File:Confric5.png|200px|thumb|alt=Confric5]]
||
|-

| '''confric6.dat''' || '''Technic connector with friction - long without collar with slot'''
|-
| [[File:Confric6.png|200px|thumb|alt=Confric6]]
||
|-

| '''confric8.dat''' || '''Technic connector with friction - middle section with collar and slot'''
|-
| [[File:Confric8.png|200px|thumb|alt=Confric8]]
||
|-

| '''confric9.dat''' || '''Technic connector with friction - middle section slotted with unsplit base collar'''
|-
| [[File:Confric9.png|200px|thumb|alt=Confric9]]
||
|}

{| style="text-align:right; width: 100%;"
|[[#top|Return to top]]
|}

{| class="wikitable" style="width: 100%;"
|+
===Technic connector hole primitives===
|-

|colspan="2"|
These primitives are used to contruct technic connector peg holes. They are orientated with the technic axle hole along the {y} axis. They must not be scaled in the {x} or {z} dimensions, but the peghole and npeghol families of primitives may be scaled in the {y} dimension.
|-

| '''connhole.dat''' || '''Technic beam hole long'''
|-
|style="width: 200px;"|[[File:Connhole.png|200px|thumb|alt=Connhole]]
||This primitive is used for Technic connector peg holes in 20LDu wide Technic beams.
|-

| '''connhol2.dat''' || '''Technic beam hole long with extended end'''
|-
| [[File:Connhol2.png|200px|thumb|alt=Connhol2]]
||This primitive is used for Technic connector peg holes in 20LDu wide Technic parts with an extended indentation.
|-

| '''connhol3.dat''' || '''Technic beam hole long with only one end'''
|-
| [[File:Connhol3.png|200px|thumb|alt=Connhol3]]
||This primitive is used for Technic connector peg holes for use in Technic parts with a narrow beam section.
|-

| '''beamhole.dat''' || '''Technic beam hole long with extension to adjacent hole'''
|-
|[[File:Beamhole.png|200px|thumb|alt=Beamhole]]
||This primitive is used for Technic connector peg holes at the end of 20LDu wide Technic beams.
|-

| '''beamhol2.dat''' || '''Technic beam hole short with extension to adjacent hole'''
|-
| [[File:Beamhol2.png|200px|thumb|alt=Beamhol2]]
||This primitive is used for Technic connector peg holes at the end of 10LDu wide Technic beams.
|-

| '''peghole.dat''' || '''Technic connector hole'''
|-
|[[File:Peghole.png|200px|thumb|alt=Peghole]]
||
|-

| '''peghole2.dat''' || '''Technic connector hole - 180 degrees - long'''
|-
|[[File:Peghole2.png|200px|thumb|alt=Peghole2]]
||
|-

| '''peghole3.dat''' || '''Technic connector hole - 90 degrees'''
|-
|[[File:Peghole3.png|200px|thumb|alt=Peghole3]]
||
|-

| '''peghole4.dat''' || '''Technic connector hole - 180 degrees - short'''
|-
|[[File:Peghole4.png|200px|thumb|alt=Peghole4]]
||
|-

| '''peghole5.dat''' || '''Technic connector hole - 180 degrees - medium'''
|-
|[[File:Peghole5.png|200px|thumb|alt=Peghole5]]
||
|-

| '''peghole6.dat''' || '''Technic connector hole - end extended'''
|-
|[[File:Peghole6.png|200px|thumb|alt=Peghole6]]
||
|-

| '''npeghole.dat''' || '''Technic connector hole negative without top surface extensions'''
|-
|[[File:Npeghole.png|200px|thumb|alt=Npeghole]]
||
|-

| '''npeghol2.dat''' || '''Technic connector hole negative with top surface extensions'''
|-
|[[File:Npeghol2.png|200px|thumb|alt=Npeghol2]]
||
|-

| '''npeghol3.dat''' || '''Technic peg hole to connector hole negative without top surface extensions'''
|-
|[[File:Npeghol3.png|200px|thumb|alt=Npeghol3]]
||This primitive is designed to fill the gap between an axlehol4 or axlehol5 primitive and a Technic peg hole.
|-

| '''npeghol3.dat''' || '''Technic peg hole to connector hole negative without top surface extensions'''
|-
|[[File:Npeghol3.png|200px|thumb|alt=Npeghol3]]
||This primitive is designed to fill the gap between an axlehol4 or axlehol5 primitive and a Technic peg hole.
|-

| '''npeghol3a.dat''' || '''Technic Peg Hole / Axle Hole Negative without Top Surface Extensions without One Edge'''
|-
|[[File:Npeghol3a.png|200px|thumb|alt=Npeghol3a]]
||
|-

| '''npeghol4.dat''' || '''Technic peg hole to connector hole negative with top surface extensions'''
|-
|[[File:Npeghol4.png|200px|thumb|alt=Npeghol4]]
||
|-

| '''npeghol5.dat''' || '''Technic peg hole to axle hole negative with top surface extensions'''
|-
|[[File:Npeghol5.png|200px|thumb|alt=Npeghol5]]
||
|-

| '''npeghol6.dat''' || '''Technic peg hole to axle hole negative quarter for beams'''
|-
|[[File:Npeghol6.png|200px|thumb|alt=Npeghol6]]
||
|-

| '''npeghol6a.dat''' || '''Technic Peg Hole Negative 0.25'''
|-
|[[File:Npeghol6a.png|200px|thumb|alt=Npeghol6a]]
||
|-

| '''npeghol6b.dat''' || '''Technic Peg Hole Negative 0.25 with Middle Tab'''
|-
|[[File:Npeghol6b.png|200px|thumb|alt=Npeghol6b]]
||
|-

| '''npeghol6c.dat''' || '''Technic Peg Hole Negative 0.25 without One Edge'''
|-
|[[File:Npeghol6c.png|200px|thumb|alt=Npeghol6c]]
||
|-

| '''npeghol6d.dat''' || '''Technic Peg Hole Negative 0.25 without Extension'''
|-
|[[File:Npeghol6d.png|200px|thumb|alt=Npeghol6d]]
||
|-

| '''npeghol7.dat''' || '''Technic Peg Hole Negative 0.5 without Top Surface Extensions'''
|-
|[[File:Npeghol7.png|200px|thumb|alt=Npeghol7]]
||
|-

| '''npeghol7a.dat''' || '''Technic Peg Hole Negative 0.5 with Top Surface Extensions'''
|-
|[[File:Npeghol7a.png|200px|thumb|alt=Npeghol7a]]
||
|-

| '''npeghol8.dat''' || '''Technic Peg Hole Negative for Alternate Beam Type 1 Half without Extensions'''
|-
|[[File:Npeghol8.png|200px|thumb|alt=Npeghol8]]
||
|-

| '''npeghol9.dat''' || '''Technic Peg Hole Negative for Alternate Beam Type 2 with Extensions'''
|-
|[[File:Npeghol9.png|200px|thumb|alt=Npeghol9]]
||
|-

| '''npeghol10.dat''' || '''Technic Peg Hole Negative for Alternate Beam Type 2 without Extensions'''
|-
|[[File:Npeghol10.png|200px|thumb|alt=Npeghol10]]
||
|-

| '''npeghol11.dat''' || '''Technic Peg Hole Negative for Alternate Beam Type 3'''
|-
|[[File:Npeghol11.png|200px|thumb|alt=Npeghol11]]
||
|-

| '''npeghol12.dat''' || '''Technic Peg Hole with Extended Perimeter (One Side) and Surface'''
|-
|[[File:Npeghol12.png|200px|thumb|alt=Npeghol12]]
||
|-

| '''npeghol13.dat''' || '''Technic Peg Hole with Extended Perimeter (Two Sides) and Surface'''
|-
|[[File:Npeghol13.png|200px|thumb|alt=Npeghol13]]
||
|-

| <s>'''npeghol15.dat'''</s> || <s>'''~Technic Peg Hole Corner 0.25 (Obsolete)'''</s>
|-
|[[File:Npeghol15.png|200px|thumb|alt=Npeghol15]]
||
|-

| '''npeghol15b.dat''' || '''Technic Peg Hole Corner with Wide Tabs on 1 Side 0.125'''
|-
|[[File:Npeghol15b.png|200px|thumb|alt=Npeghol15b]]
||
|-

| <s>'''npeghol16.dat'''</s> || <s>'''~Technic Peg Hole Corner 0.125 (Obsolete)'''</s>
|-
|[[File:Npeghol16.png|200px|thumb|alt=Npeghol16]]
||
|-

| <s>'''npeghol17.dat'''</s> || <s>'''~Technic Peg Hole Negative with Cut Corners (Obsolete)'''</s>
|-
|[[File:Npeghol17.png|200px|thumb|alt=Npeghol17]]
||
|-

| '''npeghol18.dat''' || '''Technic Peg Hole Corner 0.125 Without Lower Faces'''
|-
|[[File:Npeghol18.png|200px|thumb|alt=Npeghol18]]
||
|-

| '''npeghol18a.dat''' || '''Technic Peg Hole Corner 0.125 without Faces'''
|-
|[[File:Npeghol18a.png|200px|thumb|alt=Npeghol18a]]
||
|-

| '''npeghol19.dat''' || '''Technic Peg Hole Negative for Alternate Beam Type 3 Top Half without Extensions'''
|-
|[[File:Npeghol19.png|200px|thumb|alt=Npeghol19]]
||
|-

| '''npeghol20.dat''' || '''Technic Peg Hole Negative for Alternate Beam Type 4 without Extensions'''
|-
|[[File:Npeghol20.png|200px|thumb|alt=Npeghol20]]
||
|}

Primitives Reference

2023-12-19T17:13:59Z

OrionP:

How To Add Unofficial Parts to BrickLink Studio

2023-07-06T19:39:00Z

OrionP:

* Navigate to the Parts Tracker home page (https://library.ldraw.org/tracker/)

[[File:unoff-1.png]]
* Click on the "Download All Unofficial Files" link and save the zip file

[[File:unoff-2.png]]
* Press Windows Key + E

[[File:Unofficial1.png]]
* Type %appdata% in the address bar

[[File:Unofficial2.png]]
* Click on the AppData folder in the address bar

[[File:Unofficial3.png]]
* Open the Local Folder in AppData
* Find the Stud.io folder and open it

[[File:Unofficial4.png]]
* Press Ctrl + Shift + N to create a new folder in Stud.io. Name it CustomParts
* If you are using the complete unofficial parts zip file from the Part Tracker, unzip ldrawunf.zip into the CustomParts folder
* Otherwise press Ctrl + Shift + N to create a new folder in CustomParts. Name it parts. Place the unofficial part in the parts folder

How To Add Unofficial Parts to BrickLink Studio

2022-01-11T22:07:22Z

OrionP: Created page with "* Press Windows Key + E File:Unofficial1.png * Type %appdata% in the address bar File:Unofficial2.png * Click on the AppData folder in the address bar File:Unoffi..."

* Press Windows Key + E

[[File:Unofficial1.png]]
* Type %appdata% in the address bar

[[File:Unofficial2.png]]
* Click on the AppData folder in the address bar

[[File:Unofficial3.png]]
* Open the Local Folder in AppData
* Find the Stud.io folder and open it

[[File:Unofficial4.png]]
* Press Ctrl + Shift + N to create a new folder in Stud.io. Name it CustomParts
* If you are using the complete unofficial parts zip file from the Part Tracker, unzip ldrawunf.zip into the CustomParts folder
* Otherwise press Ctrl + Shift + N to create a new folder in CustomParts. Name it parts. Place the unofficial part in the parts folder

File:Unofficial4.png

2022-01-11T22:00:32Z

OrionP:

File:Unofficial2.png

2022-01-11T22:00:12Z

OrionP:

File:Unofficial3.png

2022-01-11T22:00:03Z

OrionP:

File:Unofficial1.png

2022-01-11T21:59:51Z

OrionP:

How to Add Unofficial Parts in LDCad

2021-12-29T20:34:23Z

OrionP:

A short tutorial on how to add unofficial parts to LDCad

Step 1: Navigate to the Parts Tracker home page (https://www.ldraw.org/library/tracker/)

[[File:unoff-1.png]]

Step 2: Click on the "Download All Unofficial Files" link and save the zip file in your LDraw folder

[[File:unoff-2.png]]

Step 3: Open LDCad and navigate to Prefs -> LDraw -> Search (library) Paths

[[File:unoff-3.png]] [[File:unoff-4.png]]

[[File:unoff-5.png]]

Step 4: Click on the entry labelled "Official" in the "Search Order" box

Step 5: Click the New button

Step 6: Click on the new entry that was just created

Step 7: Click the "Unofficial library" radio button

Step 8: Click "Browse Archive" button, navigate to where you save the ldrawunf.zip file and double click it. The path should appear in the text box next to "Location"

Step 9: Click "Accept"

You will have to restart LDCad for it to reload the library files. Unofficial files will have "UnOff" overlayed on the image in the part picker.

As always: these are unofficial parts. They may be incomplete, or inaccurate, and it is possible that when they are officially released they may be changed in ways that could mess up any model you use them in. This is far more likely for Held parts than Certified parts.

[[Category:Tutorials]]

How to Add Unofficial Parts in LDCad

2021-12-29T18:49:52Z

OrionP:

A short tutorial on how to add unofficial parts to LDCad

Step 1: Navigate to the Parts Tracker home page (https://www.ldraw.org/library/tracker/)

[[File:unoff-1.png]]

Step 2: Click on the "Download All Unofficial Files" link and save the zip file in your LDraw folder

[[File:unoff-2.png]]

Step 3: Open LDCad and navigate to Prefs -> LDraw -> Search (library) Paths

[[File:unoff-3.png]] [[File:unoff-4.png]]

[[File:unoff-5.png]]

Step 4: Click the New button

Step 5: Click on the new entry that was just created

Step 6: Click the "Unofficial library" radio button

Step 7: Click "Browse Archive" button, navigate to where you save the ldrawunf.zip file and double click it. The path should appear in the text box next to "Location"

Step 8: Click "Accept"

You will have to restart LDCad for it to reload the library files. Unofficial files will have "UnOff" overlayed on the image in the part picker.

As always: these are unofficial parts. They may be incomplete, or inaccurate, and it is possible that when they are officially released they may be changed in ways that could mess up any model you use them in. This is far more likely for Held parts than Certified parts.

[[Category:Tutorials]]

File:Unoff-5.png

2021-12-29T18:45:51Z

OrionP: How to Add Unofficial Parts in LDCad‎‎ Step 5

== Summary ==
How to Add Unofficial Parts in LDCad‎‎ Step 5

File:Unoff-4.png

2021-12-29T18:45:31Z

OrionP: How to Add Unofficial Parts in LDCad‎‎ Step 4

== Summary ==
How to Add Unofficial Parts in LDCad‎‎ Step 4

File:Unoff-3.png

2021-12-29T18:45:04Z

OrionP: How to Add Unofficial Parts in LDCad‎‎ Step 3

== Summary ==
How to Add Unofficial Parts in LDCad‎‎ Step 3

How to Add Unofficial Parts in LDCad

2021-12-29T18:44:10Z

OrionP:

A short tutorial on how to add unofficial parts to LDCad

Step 1: Navigate to the Parts Tracker home page (https://www.ldraw.org/library/tracker/)
[[File:unoff-1.png|thumb]]

Step 2: Click on the "Download All Unofficial Files" link and save the zip file in your LDraw folder
[[File:unoff-2.png|thumb]]

Step 3: Open LDCad and navigate to Prefs -> LDraw -> Search (library) Paths
[[File:unoff-3.png|thumb]] [[File:unoff-4.png|thumb]]

[[File:unoff-5.png|thumb]]
Step 4: Click the New button

Step 5: Click on the new entry that was just created

Step 6: Click the "Unofficial library" radio button

Step 7: Click "Browse Archive" button, navigate to where you save the ldrawunf.zip file and double click it. The path should appear in the text box next to "Location"

Step 8: Click "Accept"

You will have to restart LDCad for it to reload the library files. Unofficial files will have "UnOff" overlayed on the image in the part picker.

As always: these are unofficial parts. They may be incomplete, or inaccurate, and it is possible that when they are officially released they may be changed in ways that could mess up any model you use them in. This is far more likely for Held parts than Certified parts.

[[Category:Tutorials]]

How to Add Unofficial Parts in LDCad

2021-12-29T18:42:41Z

OrionP:

File:Unoff-2.png

2021-12-29T18:38:23Z

OrionP:

How to Add Unofficial Parts in LDCad Step 2

File:Unoff-1.png

2021-12-29T18:36:26Z

OrionP:

How to Add Unofficial Files in LDCad Step 1

How to Add Unofficial Parts in LDCad

2021-12-29T18:32:02Z

OrionP: Created page with "A short tutorial on how to add unofficial parts to LDCad Step 1: Navigate to the Parts Tracker home page Step 2: Click on the "Download All Unofficial Files" link and save t..."

A short tutorial on how to add unofficial parts to LDCad

Step 1: Navigate to the Parts Tracker home page

Step 2: Click on the "Download All Unofficial Files" link and save the zip file in your LDraw folder

Step 3: Open LDCad and navigate to Prefs -> LDraw -> Search (library) Paths

Step 4: Click the New button

Step 5: Click on the new entry that was just created

Step 6: Click the "Unofficial library" radio button

Step 7: Click "Browse Archive" button, navigate to where you save the ldrawunf.zip file and double click it. The path should appear in the text box next to "Location"

Step 8: Click "Accept"

You will have to restart LDCad for it to reload the library files. Unofficial files will have "UnOff" overlayed on the image in the part picker.

As always: these are unofficial parts. They may be incomplete, or inaccurate, and it is possible that when they are officially released they may be changed in ways that could mess up any model you use them in. This is far more likely for Held parts than Certified parts.

LDraw.org Wiki

2020-09-08T03:45:40Z

OrionP:

[[File:Main-home.png]]

'''Welcome to the LDraw.org Wiki!'''

This wiki exists to provide a user-editable resource for tutorials, articles etc.
related to the [[LDraw]] System of Tools.

It is not intended to replace the [https://www.ldraw.org Documentation section on ldraw.org], but to supplement it in a more interactive manner.

If you want to discuss LDraw topics, please use the [[LDraw Forum]] instead.

== Where to Start Reading? ==

Different options exist to browse through this Wiki:
* The articles in this Wiki are organized in [[categories]]. You can browse them top-down by starting at the "mother of all categories", the [[Main Index]].
* Use the full-text search in the top right search box.
* Look at the [[Special:Allpages|list of all articles]].
* Start at one of the most interesting categories:

::::{|
|-
|style="font-size: 1.5em; padding: 20px;"| [[LDraw.org]]
|style="font-size: 1.5em; padding: 20px;"| [[Software]]
|-
|style="font-size: 1.5em; padding: 20px;"| [[LDraw Files Syntax]]
|style="font-size: 1.5em; padding: 20px;"| [[Terms]]
|-
|style="font-size: 1.5em; padding: 20px;"| [[Help]]
|style="font-size: 1.5em; padding: 20px;"| [[Tutorials]]
|-
|style="font-size: 1.5em; padding: 20px;"| [[Books]]
|style="font-size: 1.5em; padding: 20px;"| [[Part Collections]]
|-
|}

LDraw.org Wiki

2020-09-08T03:43:13Z

OrionP:

[[File:Main-home.png]]

'''Welcome to the LDraw.org Wiki!'''

This wiki exists to provide a user-editable resource for tutorials, articles etc.
related to the [[LDraw]] System of Tools.

It is not intended to replace the [https://www.ldraw.org Documentation section on ldraw.org], but to supplement it in a more interactive manner.

If you want to discuss LDraw topics, please use the [[LDraw Forum]] instead.

== Where to Start Reading? ==

Different options exist to browse through this Wiki:
* The articles in this Wiki are organized in [[categories]]. You can browse them top-down by starting at the "mother of all categories", the [[Main Index]].
* Use the full-text search in the top right search box.
* Look at the [[Special:Allpages|list of all articles]].
* Start at one of the most interesting categories:

::::{|
|-
|style="font-size: 2em; padding: 20px;"| [[LDraw.org]]
|style="font-size: 2em; padding: 20px;"| [[Software]]
|-
|style="font-size: 2em; padding: 20px;"| [[LDraw Files Syntax]]
|style="font-size: 2em; padding: 20px;"| [[Terms]]
|-
|style="font-size: 2em; padding: 20px;"| [[Help]]
|style="font-size: 2em; padding: 20px;"| [[Tutorials]]
|-
|style="font-size: 2em; padding: 20px;"| [[Books]]
|style="font-size: 2em; padding: 20px;"| [[Part Collections]]
|-
|}

File:Main-home.png

2020-09-08T03:39:49Z

OrionP:

Tutorials on Other Servers

2019-05-24T10:31:54Z

OrionP: Moved from LDraw main site

Welcome to the LDraw.org tutorials section. Here you can learn techniques to enhance your proficiency with various programs of the LDraw System Of Tools. Easy to follow step by step instructions teach you everything from using software programs to creating stunning renderings.
The tutorial section is constructed in a unique way to allow for easy expansion and addition of topics. We always have someone working on a new tutorial for LDraw.org. Courses are divided up into the following categories:
<ul>
<li>{anchor anchor="modeling" text="Modeling"}</li>
<li>{anchor anchor="rendering" text="Rendering"}</li>
<li>{anchor anchor="building_instuctions" text="Building Instuctions"}</li>
<li>{anchor anchor="parts_authoring" text="Parts Authoring"}</li>
</ul>
Within those categories there are levels - beginner, intermediate, and advanced. For more information on contributing to the tutorials section at LDraw.org, see the {anchor anchor="help out_write_tutorials_for_ldraw_org" text="bottom of the page"}.
<h3 class="ui block header" id="modeling">Modeling</h3>
Learn the essentials of putting your LEGO models into the LDraw format using a variety of LDraw-based editing programs.
<h4>Beginner Modeling</h4>
<h5 id="ldraw_aioi"><a class="external" href="http://www.holly-wood.it/ldraw/aioi1-en.html" target="_blank">LDraw All-In-One-Installer tutorial</a></h5>
Use the LDraw All-In-One-Installer, in short AIOI, if you want a quick and easy way to install the LDraw Parts Library and many of the popular 3rd party tools as well. In this tutorial written by Willy Tschager you'll get an overview on the differnent screens shown by the AIOI as well as some background information.
<h5 id="omrize"><a href="omr_compliance">Preparing a MPD file for Official Model Repository compliance</a></h5>
Preparing a model to follow the Official Model Repository specifications can be a daunting task, as there are many little details to take care of. Philippe "Philo"Hurbain guides you through the process.
<h5 id="manuall_installation_advice"><a class="external" href="http://www.holly-wood.it/mlcad/install1-en.html" target="_blank">Manual installation advice for the LDraw Parts Library and MLCad</a></h5>
This tutorial by Willy Tschager will teach you how to set up manually a simple LDraw system with the MLCad editor and the LDraw Parts Library.
<h5 id="digital_building_with_mlcad"><a class="external" href="http://www.holly-wood.it/mlcad/basic1-en.html" target="_blank">Digital building with MLCad</a></h5>
This tutorial will teach you the basics to build digital models in MLCad. Furthermore it will show you tips and tricks and help with troubleshooting problems you might encounter.
<h5 id="changing_MLCads_language_interface"><a class="external" href="http://www.holly-wood.it/mlcad/language-en.html" target="_blank">Changing MLCad's language interface</a></h5>
Tutorial on how to change the default language MLCad displays by Willy Tschager.
<h5 id="mlcad_ini_file_for_the_minifig_generator"><a class="external" href="http://www.holly-wood.it/mlcad/mlcad_ini-en.html" target="_blank">MLCad.ini file for the Minifig Generator</a></h5>
The MLCad.ini file tells the program - among other things - which parts are available in MLCad's and Bricksmith's minifigure generator.
<h4>Intermediate Modeling</h4>
<h5 id="how_to_easily_rotate_a_group_of_parts_in_mlcad"><a class="external" href="http://www.holly-wood.it/mlcad/easyrotation-en.html" target="_blank">How to easily rotate a group of parts in MLCad</a></h5>
Willy Tschager shows you an alternative, more visual approach to rotate a group of parts around a common self-defined rotation point using a helper part created for the purpose.
<h5 id="using_lsynth_via_mlcad"><a class="external" href="http://www.holly-wood.it/lsynth/tutorial-en.html" target="_blank">Using LSynth via MLCad</a></h5>
Tutorial on how setup and run LSynth through MLCad's interface by Willy Tschager.
<h4>Advanced Modeling</h4>
<h5 id="advanced_digital_building"><a class="external" href="http://www.holly-wood.it/mlcad/advanced1-en.html" target="_blank">Advanced digital building with MLCad</a></h5>
Everything you always wanted to know about Buffer-Exchange and MPD - Multipart Documents (but were afraid to ask). In this tutorial Willy Tschager teachs you advanced techniques to build digital models in MLCad. Furthermore he will show you tips and tricks and help with troubleshooting problems you might encounter. The tutorial is based on MLCad 3.4.
<h5 id="unofficial_parts"><a class="external" href="http://www.holly-wood.it/mlcad/unofficial1-en.html" target="_blank">Adding unofficial LDraw parts to MLCad</a></h5>
This tutorial will teach you how to add not yet certified LDraw parts to MLCad's parts library. It also covers other programs of the LDraw System of Tools and how they deal with unofficial parts. The tutorial is based on MLCad 3.4.
<h5 id="how_to_build_a_formula_1_race_car_with_virtual_bricks"><a href="http://wiki.ldraw.org/index.php?title=Scaling_Down">How to build a Formula 1 race car with virtual bricks</a></h5>
Luca Rusconi teaches you how to scale down a Formula 1 race car using official information about the chassis dimensions, the shape and geometry of the suspensions, the engine configuration, etc.
<h3 class="ui block header" id="rendering">Rendering</h3>
Orient yourself with the many complexities of creating high quality rendered models and scenes of your LDraw creations.
<h4>Intermediate Rendering</h4>
<h5 id="quick_rendering_a_model_with_ldview_using_a_batch_file"><a class="external" href="http://www.holly-wood.it/ldview-en.html" target="_blank">Quick rendering a model with LDView using a batch file</a></h5>
A tutorial on how to make a batch file to quick render a model in LDview by Willy Tschager.
<h4>Advanced Rendering</h4>
<h5 id="building_an_army"><a href="article/440.html">Building an army</a></h5>
Philip Heinrich teaches you how to create a winner for LDraw's Scene of the Month contest.
<h3 class="ui block header" id="building_instuctions">Building Instructions</h3>
Learning how to make building instructions so others can have fun with your models.
<h4>Beginner Building Instuctions</h4>
<h5 id="helper_files_for_building_instruction_images"><a class="external" href="http://www.holly-wood.it/ldraw/helper-en.html" target="_blank">Helper files for building instruction images</a></h5>
Ever wonder how to add "arrows", "dotted lines" and numbers to your building instructions? Obtain the tools from Willy Tschager's web site to build like the pros.
<h5 id="working_with_lpub"><a class="external" href="https://sites.google.com/site/workingwithlpub/" target="_blank">Working with LPub</a></h5>
A tutorial by Jaco van der Molen explaining how to work with LPub to make instructions
<h5 id="creating_building_instructions_using_LPub"><a class="external" href="http://www.eurobricks.com/forum/index.php?showtopic=83642" target="_blank">Creating Building Instructions using LPub</a></h5>
A step-by-step guide to creating your own instructions using LPub. It includes a short guide which walks through the basics of producing a set of instructions, as well as a full guide with more details on the main steps and features of LPub.
<h3 class="ui block header" id="parts_authoring">Parts Authoring</h3>
Learn how to create your own LDraw parts and how to submit them to the Parts Tracker for inclusion in our official updates.
<h4>Beginner Parts Authoring</h4>
<h5 id="bits_and_pieces"><a class="external" href="http://www.holly-wood.it/ldraw/authoring-en.html" target="_blank">Bits and Pieces</a></h5>
Here's a crash course by Willy Tschager in LDraw part authoring. Learn that you don't have to be a math guru or hack your way through a jungle of ones or zeros.
<h5 id="reviewing_parts_for_ldraw"><a class="external" href="http://www.l3go.bugge.com/articles/Reviewing-parts-tutorial.shtml" target="_blank">Reviewing parts for LDraw</a></h5>
Niels Bugge dives into the nuts'n'bolts of part reviewing and gives clues to ease the work of the reviewers.
<h5 id="avoiding_tjunctions_in_ldraw_parts"><a href="http://wiki.ldraw.org/index.php?title=Avoiding_T-Junctions">Avoiding T-junctions in LDraw parts</a></h5>
Travis Cobbs explains what T-Junctions in LDraw parts are and how you can avoid them.
<h4>Intermediate Parts Authoring</h4>
<h5 id="edger_tutorial"><a class="external" href="http://philohome.com/isecalc/edger.htm" target="_blank">Edger tutorial</a></h5>
Tutorial describing the use of Lee Gaiteri's Edger, an optional lines calculator (tutorial written by J.C. Tchang)
<h3 class="ui block header" id="help out_write_tutorials_for_ldraw_org">Help Out! Write tutorials for LDraw.org</h3>
We're looking for more good tutorials for the site to help out our new users and users who want to learn more. If you enjoy using the LDraw System Of Tools, this would be a great way to give back to the community! Tutorials only take an evening or two to write, so you're not killing yourself with a time commitment. The other cool thing is, no web skills are needed to write. Write your tutorial in plain text format, spacing out paragraphs, and zip up any images you create when you send it in. If this sounds like something you would like to do, drop the webmasters a line and let them know. Thanks!

Part Snapping Language Extension

2018-11-30T22:13:08Z

OrionP: /* The snap generic meta */

Part Snapping Language Extension

2018-11-30T22:12:17Z

OrionP: /* The snap fingers meta */

Part Snapping Language Extension

2018-11-30T22:11:50Z

OrionP: /* The snap clip meta */

Part Snapping Language Extension

2018-11-30T22:11:27Z

OrionP: /* The snap cylinder meta */

Part Snapping Language Extension

2018-11-30T22:10:23Z

OrionP: /* The snap generic meta */

Part Snapping Language Extension

2018-11-30T22:09:03Z

OrionP: /* The snap cylinder meta */

Part Snapping Language Extension

2018-11-30T22:08:27Z

OrionP: /* The snap cylinder meta */

Part Snapping Language Extension

2018-11-30T22:05:23Z

OrionP:

Part Snapping Language Extension

2018-11-30T22:03:10Z

OrionP: /* The snap generic meta */

Part Snapping Language Extension

2018-11-30T22:02:36Z

OrionP: /* The snap fingers meta */

Part Snapping Language Extension

2018-11-30T22:01:57Z

OrionP: /* The snap clip meta */

Part Snapping Language Extension

2018-11-30T22:01:07Z

OrionP: /* The snap fingers meta */

Part Snapping Language Extension

2018-11-30T22:00:51Z

OrionP: /* The snap clip meta */

Part Snapping Language Extension

2018-11-30T21:54:03Z

OrionP: /* The snap cylinder meta */ Formatting

Part Snapping Language Extension

2018-11-30T21:52:55Z

OrionP: /* The SNAP_INCL meta */ Formatting

Part Snapping Language Extension

2018-11-30T21:52:16Z

OrionP: Formatting

Flexible Part Language Extension

2018-11-30T19:03:28Z

OrionP: /* Spring Content METAs */ Formatting

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

Author's Note: This is a unofficial specification, not yet ratified by the LSC

=== Path Content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !PATH_ lines the LDraw editor will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software that do not support these METAs, plain LDraw fallback code is encouraged to be added to the generated subfile.

==== The PATH_POINT META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).

Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The PATH_CAP META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The PATH_ANCHOR META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

Properties

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this anchor to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
It is not allowed to set group to something another anchor is already set to.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the anchor.
|}

==== The PATH_SKIN META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| donCol
| ldrawColNr
| 16
| Color to use with the given donor part.
|-
| donOri
| 3x3 matrix
|
| Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
|-
| donPart
| ldrawRef
|
| Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
|-
| donYSize
| unit
| 100%
| This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
|-
| donCen
| enum
| absCen
| Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:
* partCen: Use the part origin.
* absCen: Use the absolute center of the part.
* absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.
* absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.
|-
| donCenYOfs
| float
| 0.0
| Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
|-
| donFinScale
| enum
| fitDon2Seg
| Controls how the donor is scaled before placement in a segment. It must be set to one of the following:
* none: No additional scaling.
* fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.
|-
| donPlace
| enum
| refsDyn
| Selects the placement / generation method. Must be one of the following:
* refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.
* refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.
* deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.
|-
| donYAlign
| integer
| 0
| Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
|-
| donInline
| boolean
| false
| Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
|-
| segSize
| unit
| 100%
| Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
|-
| segSizeTol
| unit
| 5%
| Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
|-
| segsCnt
| integer
| 0
| Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
|-
| segsGrp
| integer
| 0
| Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
|-
| segsMaxMerge
| integer
| 1
| In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only useful when the donor uses final scaling other wise you will end up with (large) gaps in your path.
|-
| segsMrgAng
| float
| 0.0
| optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
|-
| segsEdgeDelKind
| enum
| keepFirstLeft
| Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:
* keepFirstLeft: Remove the left ones except for the first segment.
* keepLastRight: Remove the right ones except for the last segment.
* keepAll: Remove nothing, keep them all.
|}

==== The PATH_LENGTH META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| lenTarget
| unit
| 0
| The maximum allowed path length this meta can be used for.
|-
| lenMargin
| unit
| 0
| The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
|-
| partName
| ldrawRef
|
| LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
|-
| partDescr
| string
|
| Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)
|}

=== Spring Content METAs ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !SPRING_ lines a LDraw compliant editor will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The SPRING_POINT META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this point to one of the automatic groups available for spring parts. It must be set to one of the following:
* start: This point represents the start or bottom of the spring.
* end: This point represents the end or top of the spring.
It is not allowed to set group to something another point is already set to.
|-
| posOri
| LDraw matrix
|
| Position and location of this spring point.
|}

==== The SPRING_CAP META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

'''Example'''

<code><nowiki>0 !SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the automatic groups available for spring parts. It must be set to one of the following:
* start: This cap connects to the start or bottom of the spring.
* end: This cap connects to the end or top of the spring.
|-
| color
| ldrawColNr
| 16
| Color to use for this cap part.
|-
| posOri
| LDraw matrix
|
| Position and location of this cap part.
|-
| part
| ldrawRef
|
| LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.
|}
==== The SPRING_ANCHOR META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the automatic groups available for spring parts. It must be set to one of the following:
* start: This cap connects to the start or bottom of the spring.
* end: This cap connects to the end or top of the spring.
|-
| posOri
| LDraw matrix
|
| Position and location of this anhor.
|}

==== The SPRING_SECTION META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !SPRING_SECTION [windingCnt=5] [proportion=1]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| windingCnt
| float
| 5.0
| Number of windings around the springs' Y-direction this meta should make within the available length.
|-
| proportion
| integer
| 1
| Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.
|}

Flexible Part Language Extension

2018-11-30T18:17:18Z

OrionP: /* Spring content META */

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

Author's Note: This is a unofficial specification, not yet ratified by the LSC

=== Path Content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !PATH_ lines the LDraw editor will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software that do not support these METAs, plain LDraw fallback code is encouraged to be added to the generated subfile.

==== The PATH_POINT META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).

Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The PATH_CAP META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The PATH_ANCHOR META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

Properties

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this anchor to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
It is not allowed to set group to something another anchor is already set to.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the anchor.
|}

==== The PATH_SKIN META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| donCol
| ldrawColNr
| 16
| Color to use with the given donor part.
|-
| donOri
| 3x3 matrix
|
| Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
|-
| donPart
| ldrawRef
|
| Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
|-
| donYSize
| unit
| 100%
| This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
|-
| donCen
| enum
| absCen
| Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:
* partCen: Use the part origin.
* absCen: Use the absolute center of the part.
* absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.
* absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.
|-
| donCenYOfs
| float
| 0.0
| Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
|-
| donFinScale
| enum
| fitDon2Seg
| Controls how the donor is scaled before placement in a segment. It must be set to one of the following:
* none: No additional scaling.
* fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.
|-
| donPlace
| enum
| refsDyn
| Selects the placement / generation method. Must be one of the following:
* refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.
* refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.
* deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.
|-
| donYAlign
| integer
| 0
| Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
|-
| donInline
| boolean
| false
| Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
|-
| segSize
| unit
| 100%
| Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
|-
| segSizeTol
| unit
| 5%
| Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
|-
| segsCnt
| integer
| 0
| Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
|-
| segsGrp
| integer
| 0
| Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
|-
| segsMaxMerge
| integer
| 1
| In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only useful when the donor uses final scaling other wise you will end up with (large) gaps in your path.
|-
| segsMrgAng
| float
| 0.0
| optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
|-
| segsEdgeDelKind
| enum
| keepFirstLeft
| Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:
* keepFirstLeft: Remove the left ones except for the first segment.
* keepLastRight: Remove the right ones except for the last segment.
* keepAll: Remove nothing, keep them all.
|}

==== The PATH_LENGTH META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| lenTarget
| unit
| 0
| The maximum allowed path length this meta can be used for.
|-
| lenMargin
| unit
| 0
| The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
|-
| partName
| ldrawRef
|
| LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
|-
| partDescr
| string
|
| Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)
|}

=== Spring Content METAs ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !SPRING_ lines a LDraw compliant editor will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The SPRING_POINT META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

<code><nowiki>0 !SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-30T18:10:32Z

OrionP: /* Path content METAs */ Formatting

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

Author's Note: This is a unofficial specification, not yet ratified by the LSC

=== Path Content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !PATH_ lines the LDraw editor will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software that do not support these METAs, plain LDraw fallback code is encouraged to be added to the generated subfile.

==== The PATH_POINT META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).

Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The PATH_CAP META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The PATH_ANCHOR META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

Properties

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this anchor to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
It is not allowed to set group to something another anchor is already set to.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the anchor.
|}

==== The PATH_SKIN META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| donCol
| ldrawColNr
| 16
| Color to use with the given donor part.
|-
| donOri
| 3x3 matrix
|
| Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
|-
| donPart
| ldrawRef
|
| Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
|-
| donYSize
| unit
| 100%
| This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
|-
| donCen
| enum
| absCen
| Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:
* partCen: Use the part origin.
* absCen: Use the absolute center of the part.
* absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.
* absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.
|-
| donCenYOfs
| float
| 0.0
| Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
|-
| donFinScale
| enum
| fitDon2Seg
| Controls how the donor is scaled before placement in a segment. It must be set to one of the following:
* none: No additional scaling.
* fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.
|-
| donPlace
| enum
| refsDyn
| Selects the placement / generation method. Must be one of the following:
* refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.
* refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.
* deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.
|-
| donYAlign
| integer
| 0
| Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
|-
| donInline
| boolean
| false
| Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
|-
| segSize
| unit
| 100%
| Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
|-
| segSizeTol
| unit
| 5%
| Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
|-
| segsCnt
| integer
| 0
| Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
|-
| segsGrp
| integer
| 0
| Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
|-
| segsMaxMerge
| integer
| 1
| In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only useful when the donor uses final scaling other wise you will end up with (large) gaps in your path.
|-
| segsMrgAng
| float
| 0.0
| optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
|-
| segsEdgeDelKind
| enum
| keepFirstLeft
| Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:
* keepFirstLeft: Remove the left ones except for the first segment.
* keepLastRight: Remove the right ones except for the last segment.
* keepAll: Remove nothing, keep them all.
|}

==== The PATH_LENGTH META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| lenTarget
| unit
| 0
| The maximum allowed path length this meta can be used for.
|-
| lenMargin
| unit
| 0
| The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
|-
| partName
| ldrawRef
|
| LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
|-
| partDescr
| string
|
| Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)
|}

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-30T17:45:29Z

OrionP: /* The path anchor META */

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

Author's Note: This is a unofficial specification, not yet ratified by the LSC

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !PATH_ lines the LDraw editor will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software that do not support these METAs, plain LDraw fallback code is encouraged to be added to the generated subfile.

==== The PATH_POINT META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).

Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The PATH_CAP META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The PATH_ANCHOR META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

Properties

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this anchor to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
It is not allowed to set group to something another anchor is already set to.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the anchor.
|}

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-30T17:45:09Z

OrionP: /* The path cap META */

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

Author's Note: This is a unofficial specification, not yet ratified by the LSC

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !PATH_ lines the LDraw editor will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software that do not support these METAs, plain LDraw fallback code is encouraged to be added to the generated subfile.

==== The PATH_POINT META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).

Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The PATH_CAP META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The path anchor META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

Properties

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this anchor to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
It is not allowed to set group to something another anchor is already set to.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the anchor.
|}

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-30T17:44:38Z

OrionP: /* The PATH_POINT META */

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

Author's Note: This is a unofficial specification, not yet ratified by the LSC

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !PATH_ lines the LDraw editor will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software that do not support these METAs, plain LDraw fallback code is encouraged to be added to the generated subfile.

==== The PATH_POINT META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).

Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The path cap META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The path anchor META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

Properties

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this anchor to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
It is not allowed to set group to something another anchor is already set to.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the anchor.
|}

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-29T23:15:46Z

OrionP: /* Path content METAs */ Formatting

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

Author's Note: This is a unofficial specification, not yet ratified by the LSC

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !PATH_ lines the LDraw editor will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software that do not support these METAs, plain LDraw fallback code is encouraged to be added to the generated subfile.

==== The PATH_POINT META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).
Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The path cap META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The path anchor META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]</nowiki></code>

Properties

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this anchor to one of the groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
It is not allowed to set group to something another anchor is already set to.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the anchor.
|}

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-29T23:03:30Z

OrionP: /* Specification */ Added note that this spec is unofficial

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

Author's Note: This is a unofficial specification, not yet ratified by the LSC

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !LDCAD PATH_ lines LDCad will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The Path Point META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !LDCAD PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).
Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The path cap META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !LDCAD PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The path anchor META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:

start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.

end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.

It is not allowed to set group to something another anchor is already set to.

posOri ldraw matrix Position and orientation of the anchor.

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-29T22:59:05Z

OrionP: /* The path cap META */ Formatting

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !LDCAD PATH_ lines LDCad will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The Path Point META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !LDCAD PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).
Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The path cap META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !LDCAD PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| group
| enum
|
| Group is used to assign this cap to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:
* start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.
* end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.
|-
| color
| ldrawColNr
| 16
| Color to use given LDraw part with.
|-
| posOri
| ldraw matrix
|
| Position and orientation of the cap's part.
|-
| part
| ldrawRef
|
| LDraw part to use as a cap.
|-
| extraLen
| unit
| 0mm
| Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.
|}

==== The path anchor META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:

start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.

end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.

It is not allowed to set group to something another anchor is already set to.

posOri ldraw matrix Position and orientation of the anchor.

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-29T21:51:35Z

OrionP: /* The path cap META */ Formatting

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !LDCAD PATH_ lines LDCad will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The Path Point META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !LDCAD PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).
Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The path cap META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !LDCAD PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]</nowiki></code>

'''Properties'''
{| class="wikitable"
Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:

start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.

end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.

color ldrawColNr 16 Color to use given LDraw part with.
posOri ldraw matrix Position and orientation of the cap's part.
part ldrawRef LDraw part to use as a cap.
extraLen unit 0mm Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.

==== The path anchor META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:

start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.

end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.

It is not allowed to set group to something another anchor is already set to.

posOri ldraw matrix Position and orientation of the anchor.

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-29T21:45:26Z

OrionP: /* The Path Point META */ Formatting

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !LDCAD PATH_ lines LDCad will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The Path Point META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

'''Example'''

<code><nowiki>0 !LDCAD PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

'''Properties'''

{| class="wikitable"
|-
! Property
! Type
! Default
! Description
|-
| type
| enum
| bezier
| Sets the point type, must be ether bezier or circle.
Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).
Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.
|-
| posOri
| LDraw matrix
|
| Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
|-
| prevCPDist
| float
| 25.0
| Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
|-
| nextCPDist
| float
| 25.0
| Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
|-
| cirR
| float
| 25.0
| Sets the radius of the path guidance circle. Only used if the point type is circle.
|-
| cirDir
| enum
| xyCW
| Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:
* xyCW: Clockwise around the local xy plane.
* xyCCW: Counter clockwise around the local xy plane.
* zyCW: Clockwise around the local zy plane.
* zyCCW: Counter clockwise around the local zy plane.
Only used if the point type is circle.
|-
| prevYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
|-
| nextYRoll
| float
| 0.0
| Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.
|}

==== The path cap META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:

start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.

end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.

color ldrawColNr 16 Color to use given LDraw part with.
posOri ldraw matrix Position and orientation of the cap's part.
part ldrawRef LDraw part to use as a cap.
extraLen unit 0mm Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.

==== The path anchor META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:

start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.

end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.

It is not allowed to set group to something another anchor is already set to.

posOri ldraw matrix Position and orientation of the anchor.

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.

Flexible Part Language Extension

2018-11-29T21:26:21Z

OrionP: /* The path point META */ Formatting

== Specification ==
'''Maintained by''': The LDraw.org Standards Committee

'''Writer''': Roland Melkert, Orion Pobursky

'''Revision''': 1, XX-XXX-XXXX

=== Path content METAs ===

Path content metas are used to define bendable parts inside a dedicated subfile. Based upon a collection of 0 !LDCAD PATH_ lines LDCad will be able to generate many kinds of flexible parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The Path Point META ====

The path point meta is used to define a point the generated path must pass through in a certain way. If multiple point metas are present the path will follow the order of line placement.

Point metas must only be used in the header and optionally kept grouped together.

Example

<code><nowiki>0 !LDCAD PATH_POINT [type=bezier] [posOri=-110 0 0 1 0 0 0 1 0 0 0 1] [prevCPDist=25] [nextCPDist=25] [cirR=25] [cirDir=xyCW] [prevYRoll=0] [nextYRoll=0]</nowiki></code>

Properties

Property Type Default Description
type enum bezier
Sets the point type, must be ether bezier or circle.

Bezier points are used to guide the path through the center of this point using two control points, one in front and one behind it using the y axis of the points coordinate system (given by posOri).

Circle points are used to guide the path around the center of this point on a 2D plane using a custom radius.

posOri LDraw matrix Position and orientation of this point. The orientation part is very important as it guides the path's direction using its local Y-axis.
prevCPDist float 25.0 Defines the control point 'in front of' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's previous control point will be used by the previous path point next control point in order to do the bezier calculations for the line segment between them.
nextCPDist float 25.0 Defines the control point 'next to' this point by setting the distance (over the local Y-axis) to it in relation to the point's center. This point's next control point will be used together width the previous control point of the next path point to do the bezier calculations for the line segment between them.
cirR float 25.0 Sets the radius of the path guidance circle. Only used if the point type is circle.
cirDir enum xyCW
Used to select the 2D plane and winding direction this circle path point must use to guide the path around its center. Must be one of the following:

xyCW: Clockwise around the local xy plane.

xyCCW: Counter clockwise around the local xy plane.

zyCW: Clockwise around the local zy plane.

zyCCW: Counter clockwise around the local zy plane.

Only used if the point type is circle.

prevYRoll float 0.0 Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before following the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a bush onto a beveled wheel. Only used if the point type is circle.
nextYRoll float 0.0 Sets the roll (in degrees) around the paths Y-axis the path donor is required to have before leaving the local circle arc. Needed when e.g. working with a square shaped rubber band to guide it from e.g. a beveled wheel onto a bush. Only used if the point type is circle.

==== The path cap META ====

The path cap meta is used to add static (sub)parts to a flexible part. This is usually reserved for the outer endings of the generate part e.g. the studs at both endings of a wire.

Cap metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_CAP [group=start] [color=16] [posOri=-170 8 0 1 0 0 0 1 0 0 0 1] [part=165.dat] [extraLen=0mm]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:

start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.

end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.

color ldrawColNr 16 Color to use given LDraw part with.
posOri ldraw matrix Position and orientation of the cap's part.
part ldrawRef LDraw part to use as a cap.
extraLen unit 0mm Can be used to state the captions length, can be used to corrected the total path length when the caption parts include e.g. part of the flexible donor structure themselves.

==== The path anchor META ====

The anchor meta is (optionally) used to force a custom center using the automatic path content groups. This might be needed for start and or end groups if the containing cap or path point isn't suitable or logically. There can only be one anchor meta per group type inside any path content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_ANCHOR [group=start] [posOri=-110 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for this flexible part. It must be set to one of the following:

start: All things that make up the starting point of a flexible part. This is usually a cap and the first path point.

end: All things that make up the end point of a flexible part. This is usually a cap and the last path point.

It is not allowed to set group to something another anchor is already set to.

posOri ldraw matrix Position and orientation of the anchor.

==== The path skin META ====

The path skin meta is used to define how to fill/flesh out (part of) the path taken through the given point(s). There should be at least one skin meta in every path content subfile. It is allowed to use multiple skin metas. The total available path length will be divided amount multiple skin metas depending on their segments (seg*) related properties.

Skin metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_SKIN [donCol=16] [donOri=1 0 0 0 1 0 0 0 1] [donPart=3001.dat] [donYSize=100%] [donCen=absCen] [donCenYOfs=0] [donFinScale=fitDon2Seg] [donPlace=refsDyn] [donYAlign=0] [donInline=false] [segSize=100%] [segSizeTol=5%] [segsCnt=0] [segsGrp=0] [segsMaxMerge=1] [segsMrgAng=0] [segsEdgeDelKind=keepFirstLeft]

Properties

Property Type Default Description
donCol ldrawColNr 16 Color to use with the given donor part.
donOri 3x3 matrix Rotation of the donor part. donOri act as a correction of the donor's own orientation in order to make the part Y-axis oriented. This because the donor part will be 'smeared' along the path in its local (after this correction) Y direction.
donPart ldrawRef Set the LDraw file to use for filling out the path. Any LDraw file is allowed here but in practice you want to limit usage to simple parts.
donYSize unit 100% This is used to set the base donor size in its Y direction. If for example the donor part is a tube section with a height of 2ldu could stretch (y-axis only) that using this option to e.g. 10ldu en large it times e..g 4 by using 400%.
donCen enum absCen
Used to choose the working center of the donor part. This option uses the donor as it is after the orientation corrections. It must be one of the following:

partCen: Use the part origin.

absCen: Use the absolute center of the part.

absYCen: Use the part origin for the X and Z axis, but use the absolute center of its Y-axis.

absXZCen: Use the absolute center of the X and Z axis, but use the part origin for the Y-axis.

donCenYOfs float 0.0 Define an additional offset to the Y part of the donor (after donOri, donYSize and donCen corrections) to be used.
donFinScale enum fitDon2Seg
Controls how the donor is scaled before placement in a segment. It must be set to one of the followeling:

none: No additional scaling.

fitDon2Seg: Stretch/shrink the donor result to exactly fit the destination segment. Do note this might (partly) override some of the other don* scaling related parameters which could result in an unexpected end result.

donPlace enum refsDyn
Selects the placement / generation method. Must be one of the following:

refsStat: Donors are placed using the calculated center (after donYAling correction) at the starting point of segments using that locations local path orientation.

refsDyn: Donors are placed using the calculated center (after donYAling correction) at the center segements using that locations (interpolated) local path orientation.

deform: The donor mesh is deformed in such a way it follows the path's curve as a result any fallback code will have the full recursive (transformed) source of the donor part for each segment it is used on. The deform method results in extremely smooth flexible parts but it might also result in very large LDraw files.

donYAlign integer 0 Sets an alignment correction to use on the calculated donor center before placing a donor at a path segment. A negative number will shift the donor to the left by multiples of its Y length. So -1 will move it a full length to the left. A positive number will do the same to the right. 0 means no change will be made.
donInline boolean false Determines if the generator will try to inline the donor file instead of referring to it directly while creating the segment fallback code. In-lining the donor file removes dependency on it and might increase portability of the fallback code. The donor will only be in-lined if it is entirely made out of type 1 lines.
segSize unit 100% Controls the length of individual segments along the resulting path. Each segment on the path will be filled out with a single donor part instance. Setting the segment size therefore controls how many times the donor might be used to fill out the path. Be care full when setting the segment size while using the deform method as it will greatly influence the resulting fallback file size. You can supply the segment size in ldu, mm or as a percentage of donYSize.
segSizeTol unit 5% Controls the amount of scaling allowed upon segments in order to fill rest space. If for example the segments size is 10 and the whole path has a length of 111, resulting in 11 segments, the remaining length of 1 will be spread over the 11 segments by scaling them slightly. Use this option to limit the amount of scaling to prevent e.g. noticeable distortions in the donor part. tolerance can be given in a static ldu, mm or a percentage of the calculated segment size it self.
segsCnt integer 0 Used to set optionally set a fixed number of segments. 0 means unlimited segments can be used in order to construct the path. If a non zero value is given only a portion of the path will be filled out using this skin meta's options. This option can be used to limit the visible length of a flexible part and make room for other skin metas on the path.
segsGrp integer 0 Used to group segments resulting from different skin metas. If set to 0 no grouping will be done and each skin meta will fill out its assigned space in order of the skin meta lines. If set to non zero skin metas using the same group number will alternate (zip together) their segments making possible e.g. color patterns.
segsMaxMerge integer 1 In order to try and reduce the fallback code segments which are in a straight line of each other could optionally be joined into a single segment resulting in less donor placements. this option is only usefull when the donor uses final scaling other wise you will end up with (large) gaps in your path.
segsMrgAng float 0.0 optionally lets you define the maximum angle (in degrees) between two segments in order to deem them to be inline of each other. 0.0 indicates the internal (version depended) hard coded default should be used. Use this option with case as a large angle might cause alignment problems.
segsEdgeDelKind enum keepFirstLeft
Controls what to do with overlapping conditional lines while using the deform placement method. Must be one of the following:

keepFirstLeft: Remove the left ones except for the first segment.

keepLastRight: Remove the right ones except for the last segment.

keepAll: Remove nothing, keep them all.

==== The path length META ====

The path length meta is used to constrain the length of the path and or to define a real life (official library) counter part for the maximum length. When multiple length metas are present the constraint closest to the true length of the path will be applied in order to e.g. map path content to static LDraw files.

Length metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD PATH_LENGTH [lenTarget=50mm] [lenMargin=2%] [partName=some.dat] [partDescr=50 mm pneuhose]

Properties

Property Type Default Description
lenTarget unit 0 The maximum allowed path length this meta can be used for.
lenMargin unit 0 The amount a path's length might differ from the true constrains in order to still qualify. This helps prevent unwanted exclusions and compensates for stretchable parts (e.g. rubber bands). The margin can be given in ldu, mm or a percentage upon the lenTarget value.
partName ldrawRef LDraw part which represents the static version of a path which matches this metas constrains. Currently this reference is never loaded so it does not have to exists. future versions of LDCad might use it in e.g. part usage overviews etc.
partDescr string Description to use for the given partName. Currently nothing is done with this value but future versions of LDCad might use it when e.g. the partName LDraw file can not be found (is virtual)

=== Spring content META ===

Spring content metas are used to define parts which include a movable spring inside a dedicated subfile. Based upon a collection of 0 !LDCAD SPRING_ lines LDCad will be able to generate many kinds of spring oriented parts for use in your models. In order to also view those models correctly in other LDraw viewer/editor software a generated meta can be used to add plain LDraw fallback code to the subfile.

==== The spring point META ====

The spring point meta is used to define at most two points using different group settings. These are the points the generated spring will connect using one or more section metas.

Point metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_POINT [group=start] [posOri=0 24 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this point to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This point represents the start or bottom of the spring.

end: This point represents the end or top of the spring.

It is not allowed to set group to something another point is already set to.

posOri LDraw matrix Position and location of this spring point.

==== The spring cap META ====

The cap meta is used to add static part(s) to ether the start or end of the spring oriented part.

Example

0 !LDCAD SPRING_CAP [group=start] [color=16] [posOri=0 24 0 1 0 0 0 1 0 0 0 1] [part=3005.dat]

Properties

Property Type Default Description
group enum
Group is used to assign this cap to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

color ldrawColNr 16 Color to use for this cap part.
posOri LDraw matrix Position and location of this cap part.
part ldrawRef LDraw part to use for this cap. Can be anything but in practice it should be a single LDraw part as it might hurt render performance otherwise.

==== The spring anchor META ====

The anchor meta is used to force a custom center (and orientation) for one of the spring related groups. There can only be one anchor meta per group type in any spring content subfile.

Anchor metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_ANCHOR [group=start] [posOri=0 48 0 1 0 0 0 1 0 0 0 1]

Properties

Property Type Default Description
group enum
Group is used to assign this anchor to one of the automatic LDCad groups available for spring parts. It must be set to one of the following:

start: This cap connects to the start or bottom of the spring.

end: This cap connects to the end or top of the spring.

It is not allowed to set group to something another anchor is already set to.

posOri LDraw matrix Position and location of this anhor.

==== The spring section META ====

The section meta is used to define the appearance of (part of) the spring wire connecting the two spring points. At least one section meta should be present. When multiple section metas are given the available spring length will be divided among them based on the proportion property.

Section metas must only be used in the header and optionally kept grouped together.

Example

0 !LDCAD SPRING_SECTION [windingCnt=5] [proportion=1]

Properties

Property Type Default Description
windingCnt float 5.0 Number of windings around the springs' Y-direction this meta should make within the available length.
proportion integer 1
Defines the portion of the total spring length this section controls. If set to 0 the wire will be wound tightly and this section's length depends on the number of windings and wire thickness. If set to non zero the available length will be calculated by taking the leftover length (spring length minus the length used by zero proportion sections) divided by the sum of all proportion values multiplied by this meta's proportional value.

For example imagine having a spring of length 100 using 4 section metas. If one of those sections uses a proportion of 2 and the other three use 1 the resulting section lengths will be: 40 (2 5ths), 20 (1 5th), 20 and 20.