Part Snapping Language Extension - Revision history

Steffen at 09:46, 23 February 2019

2019-02-23T09:46:19Z

← Older revision		Revision as of 09:46, 23 February 2019
Line 394:		Line 394:
	\| none		\| none
	\| See cylinder meta.		\| See cylinder meta.
			\|-
			\|}

			[[Category:LDraw Files Syntax]]

OrionP: /* The snap generic meta */

2018-11-30T22:13:08Z

The snap generic meta

← Older revision		Revision as of 22:13, 30 November 2018
Line 330:		Line 330:
	\|}		\|}

	====The ~~snap generic~~ meta====		====The SNAP_GEN meta====

	The generic meta is used to describe very oddly shaped things which in practice only have a few counter parts. Things like electric plugs and window glass etc.		The generic meta is used to describe very oddly shaped things which in practice only have a few counter parts. Things like electric plugs and window glass etc.
Line 338:		Line 338:
	'''Example'''		'''Example'''

	<code><nowiki>0 !~~LDCAD~~ SNAP_GEN [group=nxtc] [gender=M] [pos=0 -1.5 1.5] [ori=1 0 0 0 0 1 0 -1 0] [bounding=box 12.5 16.5 8]</nowiki></code>		<code><nowiki>0 !SNAP_GEN [group=nxtc] [gender=M] [pos=0 -1.5 1.5] [ori=1 0 0 0 0 1 0 -1 0] [bounding=box 12.5 16.5 8]</nowiki></code>

	'''Properties'''		'''Properties'''

OrionP: /* The snap fingers meta */

2018-11-30T22:12:17Z

The snap fingers meta

← Older revision		Revision as of 22:12, 30 November 2018
Line 262:		Line 262:
	\|}		\|}

	====The ~~snap fingers~~ meta====		====The SNAP_FGR meta====

	The fingers meta is used to describe all the interlocking finger like shapes. finger shapes will only be tested among them selves.		The fingers meta is used to describe all the interlocking finger like shapes. finger shapes will only be tested among them selves.
Line 268:		Line 268:
	'''Example'''		'''Example'''

	<code><nowiki>0 !~~LDCAD~~ SNAP_FGR [group=lckHng] [genderOfs=M] [seq=4.5 8 4.5] [radius=6] [center=true] [pos=-30 10 0] [ori=1 0 0 0 0 1 0 -1 0]</nowiki></code>		<code><nowiki>0 !SNAP_FGR [group=lckHng] [genderOfs=M] [seq=4.5 8 4.5] [radius=6] [center=true] [pos=-30 10 0] [ori=1 0 0 0 0 1 0 -1 0]</nowiki></code>

	'''Properties'''		'''Properties'''

OrionP: /* The snap clip meta */

2018-11-30T22:11:50Z

The snap clip meta

← Older revision		Revision as of 22:11, 30 November 2018
Line 199:		Line 199:
	\|}		\|}

	====The ~~snap clip~~ meta====		====The SNAP_CLP meta====

	The clip meta is used to describe all clip like shapes. Clips are always of the female gender and will be tested against male cylinder shapes.		The clip meta is used to describe all clip like shapes. Clips are always of the female gender and will be tested against male cylinder shapes.
Line 205:		Line 205:
	'''Example'''		'''Example'''

	<code><nowiki>0 !~~LDCAD~~ SNAP_CLP [radius=4] [length=8] [pos=0 0 0] [ori=1 0 0 0 1 0 0 0 1] [center=true]</nowiki></code>		<code><nowiki>0 !SNAP_CLP [radius=4] [length=8] [pos=0 0 0] [ori=1 0 0 0 1 0 0 0 1] [center=true]</nowiki></code>

	'''Properties'''		'''Properties'''

OrionP: /* The snap cylinder meta */

2018-11-30T22:11:27Z

The snap cylinder meta

← Older revision		Revision as of 22:11, 30 November 2018
Line 90:		Line 90:
	\|}		\|}

	====The ~~snap cylinder~~ meta====		====The SNAP_CYL meta====

	The cylinder meta is the main workhorse among the snap info metas. This because it describes holes and pens which is what LEGO is all about. If you take a good look at some LEGO bricks you'll notice all of them have similar interlocking holes and pens. The only real difference between them are the diameters and pattern of the hole/pens shapes (like the side of a key). It is this information that the cylinder meta tries to capture in order to calculate matching pairs.		The cylinder meta is the main workhorse among the snap info metas. This because it describes holes and pens which is what LEGO is all about. If you take a good look at some LEGO bricks you'll notice all of them have similar interlocking holes and pens. The only real difference between them are the diameters and pattern of the hole/pens shapes (like the side of a key). It is this information that the cylinder meta tries to capture in order to calculate matching pairs.
Line 96:		Line 96:
	'''Example'''		'''Example'''

	<code><nowiki>0 !~~LDCAD~~ SNAP_CYL [id=connhole] [gender=F] [caps=none] [secs=R 8 2 R 6 16 R 8 2] [center=true] [slide=true] [pos=0 0 0] [ori=1 0 0 0 1 0 0 0 1]</nowiki></code>		<code><nowiki>0 !SNAP_CYL [id=connhole] [gender=F] [caps=none] [secs=R 8 2 R 6 16 R 8 2] [center=true] [slide=true] [pos=0 0 0] [ori=1 0 0 0 1 0 0 0 1]</nowiki></code>

	'''Properties'''		'''Properties'''

OrionP: /* The snap generic meta */

2018-11-30T22:10:23Z

The snap generic meta

← Older revision		Revision as of 22:10, 30 November 2018
Line 379:		Line 379:
	\|		\|
	Defines a bounding shape which will be used in the 'best pair candidate' calculations. Is needed because the positional alone will might cause unwanted matches otherwise. There are several types of bounding shapes, namely:		Defines a bounding shape which will be used in the 'best pair candidate' calculations. Is needed because the positional alone will might cause unwanted matches otherwise. There are several types of bounding shapes, namely:
			* pnt: Single point / no bounding box, no extra info needed.
	pnt: Single point / no bounding box, no extra info needed.		* box: Box defined by its following x, y, and z radius', for example: box 10 8 10
			* cube: Cube defined by a following (half) size, for example: cube 8
	box: Box defined by its following x, y, and z radius', for example: box 10 8 10		* cyl: Cylinder defined by a following radius and length, for example: cyl 8 20
			* sph: Sphere defined by a following radius, for example: sph 8
	cube: Cube defined by a following (half) size, for example: cube 8

	cyl: Cylinder defined by a following radius and length, for example: cyl 8 20

	sph: Sphere defined by a following radius, for example: sph 8

	\|-		\|-
	\| scale		\| scale

OrionP: /* The snap cylinder meta */

2018-11-30T22:09:03Z

The snap cylinder meta

← Older revision		Revision as of 22:09, 30 November 2018
Line 145:		Line 145:
	* none: If mirroring is detected this information will not be inherited by the higher level part.		* none: If mirroring is detected this information will not be inherited by the higher level part.
	* cor: If mirroring is detected the snap information will be corrected by flipping one of the radius axis'.		* cor: If mirroring is detected the snap information will be corrected by flipping one of the radius axis'.

	\|-		\|-
	\| gender		\| gender
Line 164:		Line 163:

	For example a plain stud can be described using a single block: R 8 4 while a technic beam hole needs three: R 8 2 R 6 16 R 8 2.		For example a plain stud can be described using a single block: R 8 4 while a technic beam hole needs three: R 8 2 R 6 16 R 8 2.

	\|-		\|-
	\| caps		\| caps

OrionP: /* The snap cylinder meta */

2018-11-30T22:08:27Z

The snap cylinder meta

← Older revision		Revision as of 22:08, 30 November 2018
Line 132:		Line 132:
	\|		\|
	Defines how scaled references to the master (official) part should be handled information inheritance wise. Must be one of the following:		Defines how scaled references to the master (official) part should be handled information inheritance wise. Must be one of the following:
			* none: If scaling is detected this information will not be inherited by the higher level part.
	none: If scaling is detected this information will not be inherited by the higher level part.		* YOnly: The information will only be inherited if scaling is limited to the Y-axis, if X and or Z is scaled the info will not be inherited.
			* ROnly: The information will only be inherited if scaling is limited to the cylinder's radius (usually x and z) given its done symmetrical. If the info is scaled in any other way it will not be inherited.
	YOnly: The information will only be inherited if scaling is limited to the Y-axis, if X and or Z is scaled the info will not be inherited.		* YandR: The information will only be inherited if YOnly or ROnly rules apply.

	ROnly: The information will only be inherited if scaling is limited to the cylinder's radius (usually x and z) given its done symmetrical. If the info is scaled in any other way it will not be inherited.

	YandR: The information will only be inherited if YOnly or ROnly rules apply.

	\|-		\|-
Line 147:		Line 143:
	\|		\|
	Defines how mirrored references to the master (official) part should be handled information inheritance wise. Must be one of the following:		Defines how mirrored references to the master (official) part should be handled information inheritance wise. Must be one of the following:
			* none: If mirroring is detected this information will not be inherited by the higher level part.
	none: If mirroring is detected this information will not be inherited by the higher level part.		* cor: If mirroring is detected the snap information will be corrected by flipping one of the radius axis'.

	cor: If mirroring is detected the snap information will be corrected by flipping one of the radius axis'.

	\|-		\|-
Line 163:		Line 157:
	\|		\|
	Describes the shape of the hole (along the neg Y-axis) or pen by a sequence of shape variants, radius's and lengths. The info must be given in blocks of: shapeVariant radius length where shapeVariant must be one of the following:		Describes the shape of the hole (along the neg Y-axis) or pen by a sequence of shape variants, radius's and lengths. The info must be given in blocks of: shapeVariant radius length where shapeVariant must be one of the following:
			* R: Round.
	R: Round.		* A: Axle.
			* S: Square.
	A: Axle.		* _L: Flexible radius wise extension to the previous block's specs. This will be needed for e.g. the tip of an technic connector pin. Although it is slightly larger it allows for (temporary) compression while sliding the pin inside e.g. a beam hole.
			* L_: Same as _L but as an extension to the next section instead of the previous one.
	S: Square.

	_L: Flexible radius wise extension to the previous block's specs. This will be needed for e.g. the tip of an technic connector pin. Although it is slightly larger it allows for (temporary) compression while sliding the pin inside e.g. a beam hole.

	L_: Same as _L but as an extension to the next section instead of the previous one.

	For example a plain stud can be described using a single block: R 8 4 while a technic beam hole needs three: R 8 2 R 6 16 R 8 2.		For example a plain stud can be described using a single block: R 8 4 while a technic beam hole needs three: R 8 2 R 6 16 R 8 2.
Line 182:		Line 171:
	\|		\|
	Defines the ends of the shape, must be one of the following:		Defines the ends of the shape, must be one of the following:
			* none: The shape is open ended. e.g. a male axle or female beam hole.
	none: The shape is open ended. e.g. a male axle or female beam hole.		* one: The shape has one closed ending, which one depends on the gender. For male shapes it will be A (bottom) and for female shapes it will be B (top).
			* two: The shape is closed (blocked) at both sides. e.g. the male bar of a minifig suitcase handle.
	one: The shape has one closed ending, which one depends on the gender. For male shapes it will be A (bottom) and for female shapes it will be B (top).		* A: The bottom is closed / blocked. e.g. a stud.
			* B: The top is closed / blocked. e.g. an anti stud.
	two: The shape is closed (blocked) at both sides. e.g. the male bar of a minifig suitcase handle.

	A: The bottom is closed / blocked. e.g. a stud.

	B: The top is closed / blocked. e.g. an anti stud.

	\|-		\|-
	\| grid		\| grid
Line 203:		Line 186:

	Optionally each count value can be preceded by a C character indicating the grid should be centered on that axis. If no C is given the axis will add to the pos parameter. For example to center the 4x8 grid around it's pos parameter use: C 4 C 8 20 20		Optionally each count value can be preceded by a C character indicating the grid should be centered on that axis. If no C is given the axis will add to the pos parameter. For example to center the 4x8 grid around it's pos parameter use: C 4 C 8 20 20

	\|-		\|-
	\| center		\| center

OrionP at 22:05, 30 November 2018

2018-11-30T22:05:23Z

← Older revision		Revision as of 22:05, 30 November 2018
Line 18:		Line 18:
	The clear meta is used to flush all or part of the inherited snap information gathered for the current part file so far. This meta might be needed to replace inherited information in order to extend it or increase its detail. Like e.g. information obtained from an axle primitive because that primitive is used as part of a bigger shape inside this file.		The clear meta is used to flush all or part of the inherited snap information gathered for the current part file so far. This meta might be needed to replace inherited information in order to extend it or increase its detail. Like e.g. information obtained from an axle primitive because that primitive is used as part of a bigger shape inside this file.

	~~‘‘‘Example’’’~~		'''Example'''

	<code><nowiki>0 !SNAP_CLEAR [id=axleHole]</nowiki></code>		<code><nowiki>0 !SNAP_CLEAR [id=axleHole]</nowiki></code>

	~~‘‘‘Properties’’’~~		'''Properties'''

	{\| class="wikitable"		{\| class="wikitable"
Line 41:		Line 41:
	The include meta is used to add the information from another shadow library file to this part too. This is done non recursively.		The include meta is used to add the information from another shadow library file to this part too. This is done non recursively.

	~~‘‘‘Example’’’~~		'''Example'''

	<code><nowiki>0 !SNAP_INCL [ref=connhole.dat] [pos=-50 10 0] [ori=0 -1 0 0 0 -1 1 0 0] [grid=C 1 C 3 20 20]</nowiki></code>		<code><nowiki>0 !SNAP_INCL [ref=connhole.dat] [pos=-50 10 0] [ori=0 -1 0 0 0 -1 1 0 0] [grid=C 1 C 3 20 20]</nowiki></code>

	~~‘‘‘Properties’’’~~		'''Properties'''

	{\| class="wikitable"		{\| class="wikitable"
Line 94:		Line 94:
	The cylinder meta is the main workhorse among the snap info metas. This because it describes holes and pens which is what LEGO is all about. If you take a good look at some LEGO bricks you'll notice all of them have similar interlocking holes and pens. The only real difference between them are the diameters and pattern of the hole/pens shapes (like the side of a key). It is this information that the cylinder meta tries to capture in order to calculate matching pairs.		The cylinder meta is the main workhorse among the snap info metas. This because it describes holes and pens which is what LEGO is all about. If you take a good look at some LEGO bricks you'll notice all of them have similar interlocking holes and pens. The only real difference between them are the diameters and pattern of the hole/pens shapes (like the side of a key). It is this information that the cylinder meta tries to capture in order to calculate matching pairs.

	~~‘‘‘Example’’’~~		'''Example'''

	<code><nowiki>0 !LDCAD SNAP_CYL [id=connhole] [gender=F] [caps=none] [secs=R 8 2 R 6 16 R 8 2] [center=true] [slide=true] [pos=0 0 0] [ori=1 0 0 0 1 0 0 0 1]</nowiki></code>		<code><nowiki>0 !LDCAD SNAP_CYL [id=connhole] [gender=F] [caps=none] [secs=R 8 2 R 6 16 R 8 2] [center=true] [slide=true] [pos=0 0 0] [ori=1 0 0 0 1 0 0 0 1]</nowiki></code>

	~~‘‘‘Properties’’’~~		'''Properties'''

	{\| class="wikitable"		{\| class="wikitable"
Line 223:		Line 223:
	The clip meta is used to describe all clip like shapes. Clips are always of the female gender and will be tested against male cylinder shapes.		The clip meta is used to describe all clip like shapes. Clips are always of the female gender and will be tested against male cylinder shapes.

	~~‘‘‘Example’’’~~		'''Example'''

	<code><nowiki>0 !LDCAD SNAP_CLP [radius=4] [length=8] [pos=0 0 0] [ori=1 0 0 0 1 0 0 0 1] [center=true]</nowiki></code>		<code><nowiki>0 !LDCAD SNAP_CLP [radius=4] [length=8] [pos=0 0 0] [ori=1 0 0 0 1 0 0 0 1] [center=true]</nowiki></code>

	~~‘‘‘Properties’’’~~		'''Properties'''

	{\| class="wikitable"		{\| class="wikitable"
Line 286:		Line 286:
	The fingers meta is used to describe all the interlocking finger like shapes. finger shapes will only be tested among them selves.		The fingers meta is used to describe all the interlocking finger like shapes. finger shapes will only be tested among them selves.

	~~‘‘‘Example’’’~~		'''Example'''

	<code><nowiki>0 !LDCAD SNAP_FGR [group=lckHng] [genderOfs=M] [seq=4.5 8 4.5] [radius=6] [center=true] [pos=-30 10 0] [ori=1 0 0 0 0 1 0 -1 0]</nowiki></code>		<code><nowiki>0 !LDCAD SNAP_FGR [group=lckHng] [genderOfs=M] [seq=4.5 8 4.5] [radius=6] [center=true] [pos=-30 10 0] [ori=1 0 0 0 0 1 0 -1 0]</nowiki></code>

	~~‘‘‘Properties’’’~~		'''Properties'''

	{\| class="wikitable"		{\| class="wikitable"
Line 356:		Line 356:
	Matching is done only among generic metas themselves based on the group name alone. But the bounding information will influence the best candidate selection when multiple pairs are located closely together.		Matching is done only among generic metas themselves based on the group name alone. But the bounding information will influence the best candidate selection when multiple pairs are located closely together.

	~~‘‘‘Example’’’~~		'''Example'''

	<code><nowiki>0 !LDCAD SNAP_GEN [group=nxtc] [gender=M] [pos=0 -1.5 1.5] [ori=1 0 0 0 0 1 0 -1 0] [bounding=box 12.5 16.5 8]</nowiki></code>		<code><nowiki>0 !LDCAD SNAP_GEN [group=nxtc] [gender=M] [pos=0 -1.5 1.5] [ori=1 0 0 0 0 1 0 -1 0] [bounding=box 12.5 16.5 8]</nowiki></code>

	~~‘‘‘Properties’’’~~		'''Properties'''

	{\| class="wikitable"		{\| class="wikitable"

OrionP: /* The snap generic meta */

2018-11-30T22:03:10Z

The snap generic meta

← Older revision		Revision as of 22:03, 30 November 2018
Line 369:		Line 369:
	! Description		! Description
	\|-		\|-
	ID		\| ID
	\| string		\| string
	\|		\|
	\| See cylinder meta.		\| See cylinder meta.
	group		\|-
			\| group
	\| string		\| string
	\|		\|
	\| See cylinder meta.		\| See cylinder meta.
	pos		\|-
			\| pos
	\| vector		\| vector
	\|		\|
	\| See cylinder meta.		\| See cylinder meta.
	ori		\|-
			\| ori
	\| 3x3 matrix		\| 3x3 matrix
	\|		\|
	\| See cylinder meta.		\| See cylinder meta.
	gender		\|-
			\| gender
	\| enum		\| enum
	\| male		\| male
	\| See cylinder meta.		\| See cylinder meta.
	bounding		\|-
			\| bounding
	\| mixed array		\| mixed array
	\|		\|
Line 405:		Line 410:
	sph: Sphere defined by a following radius, for example: sph 8		sph: Sphere defined by a following radius, for example: sph 8

	scale		\|-
			\| scale
	\| enum		\| enum
	\| none		\| none
	\| See cylinder meta.		\| See cylinder meta.
	mirror		\|-
			\| mirror
	\| enum		\| enum
	\| none		\| none
	\| See cylinder meta.		\| See cylinder meta.