ContourGroup - Revision history

WikiSysop: /* Example Code */

2024-08-30T19:04:52Z

Example Code

← Older revision		Revision as of 13:04, 30 August 2024
Line 86:		Line 86:

	[[ -------------- MarkContourParameterSteps --------------------------------- \|		[[ -------------- MarkContourParameterSteps --------------------------------- \|

	\| Insert a marker at each parameter step around the contour and display the		\| Insert a marker at each parameter step around the contour and display the

	\| distance from the start point		\| distance from the start point

	\| ]]		\| ]]

Line 123:		Line 120:

	[[File:Back.jpg\|right\|50px\|link=Creating Vectors From Script]]		[[File:Back.jpg\|right\|50px\|link=Creating Vectors From Script]]

	==References==		==References==
	'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]		'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]

WikiSysop at 19:04, 30 August 2024

2024-08-30T19:04:37Z

← Older revision		Revision as of 13:04, 30 August 2024
Line 82:		Line 82:

	====Example Code====		====Example Code====
	<nowiki>
			<nowiki>

	[[ -------------- MarkContourParameterSteps --------------------------------- \|		[[ -------------- MarkContourParameterSteps --------------------------------- \|

Line 92:		Line 94:

	function MarkContourParameterSteps(num_steps, contour, layer)		function MarkContourParameterSteps(num_steps, contour, layer)



	local cursor = ContourCarriage(0, 0.0)		local cursor = ContourCarriage(0, 0.0)
			local contour_length = contour.Length
			local step_dist = contour_length / num_steps
			local end_index = num_steps
	local contour_length = contour.Length local step_dist = contour_length / num_steps		if contour.IsOpen then
			end_index = end_index + 1
			end -- if end

	local end_index = num_steps if contour.IsOpen then end_index = end_index + 1 end

	for i = 1, end_index do		for i = 1, end_index do

	local ctr_pos = cursor:Position(contour)		local ctr_pos = cursor:Position(contour)
			local marker = CadMarker("D:" .. (step_dist * (i - 1)), ctr_pos, 3)
	local marker = CadMarker("D:" .. (step_dist * (i - 1)), ctr_pos, 3) layer:AddObject(marker, true) cursor:Move(contour, step_dist)		layer:AddObject(marker, true)
			cursor:Move(contour, step_dist)
	end		end -- for end
	end </nowiki>		end -- function end
			</nowiki>

WikiSysop at 18:58, 30 August 2024

2024-08-30T18:58:25Z

← Older revision		Revision as of 12:58, 30 August 2024
Line 81:		Line 81:


	Example Code		====Example Code====
			<nowiki>
	[[ -------------- MarkContourParameterSteps --------------------------------- \|		[[ -------------- MarkContourParameterSteps --------------------------------- \|

Line 111:		Line 111:
	local marker = CadMarker("D:" .. (step_dist * (i - 1)), ctr_pos, 3) layer:AddObject(marker, true) cursor:Move(contour, step_dist)		local marker = CadMarker("D:" .. (step_dist * (i - 1)), ctr_pos, 3) layer:AddObject(marker, true) cursor:Move(contour, step_dist)

	end end		end
			end </nowiki>

WikiSysop at 18:57, 30 August 2024

2024-08-30T18:57:03Z

← Older revision		Revision as of 12:57, 30 August 2024
Line 3:		Line 3:
	This object is used to move along a contour a fixed distance at a time irrespective of the number of spans in the contour or the type of spans.		This object is used to move along a contour a fixed distance at a time irrespective of the number of spans in the contour or the type of spans.

	Constructor		==Constructor==

	ContourCarriage( Contour ctr, Point2D pt)		===ContourCarriage( Contour ctr, Point2D pt) ===

	Creates a ‘carriage’ for the passed contour and positions it at the nearest point on the contour to the passed point.		Creates a ‘carriage’ for the passed contour and positions it at the nearest point on the contour to the passed point.
Line 17:		Line 17:


	ContourCarriage( integer span_index, double parameter)		===ContourCarriage( integer span_index, double parameter)===

	Creates a ‘carriage’ for a contour and set its positions for the span with the passed index at the passed parameter position (in range 0-1.0) on the span. These values are normaly specified as 0,0.0 to position the carriage at the start of the first span in the contour.		Creates a ‘carriage’ for a contour and set its positions for the span with the passed index at the passed parameter position (in range 0-1.0) on the span. These values are normaly specified as 0,0.0 to position the carriage at the start of the first span in the contour.
Line 31:		Line 31:


	Properties		==Properties==

	.IsInvalid		===.IsInvalid===

	R/O - bool - Returns true if current position is invalid		R/O - bool - Returns true if current position is invalid
Line 39:		Line 39:


	.SpanIndex		===.SpanIndex===

	R/O - integer - Return span index for current position of carriage		R/O - integer - Return span index for current position of carriage
Line 45:		Line 45:


	.SpanParameter		===.SpanParameter===

	R/O - double - Return span parameter (in range 0-1.0) for current position of carriage		R/O - double - Return span parameter (in range 0-1.0) for current position of carriage
Line 51:		Line 51:


	Methods		==Methods==

	:Move( Contour ctr, double distance)		===:Move( Contour ctr, double distance)===

	Moves the carriage the requested distance along the contour. Returns true if manage to move requested distance successfully. If the contour is closed we will wrap around at the end, if it is open and you attempt to move past the end this method will return false.		Moves the carriage the requested distance along the contour. Returns true if manage to move requested distance successfully. If the contour is closed we will wrap around at the end, if it is open and you attempt to move past the end this method will return false.
Line 63:		Line 63:


	:Position( Contour ctr)		===:Position( Contour ctr)===

	Returns a Point2D representing the current position on the carriage on the passed contour		Returns a Point2D representing the current position on the carriage on the passed contour
Line 71:		Line 71:


	:UpdatePosition( Contour ctr, Point2D pt)		===:UpdatePosition( Contour ctr, Point2D pt)===

	Update the position of the carriage to the nearest position on the contour to the passed point.		Update the position of the carriage to the nearest position on the contour to the passed point.

WikiSysop at 03:20, 4 August 2021

2021-08-04T03:20:26Z

← Older revision		Revision as of 21:20, 3 August 2021
Line 1:		Line 1:
	[[File:Back.jpg\|right\|50px\|link=Creating Vectors From Script]]		[[File:Back.jpg\|right\|50px\|link=Creating Vectors From Script]]
			[[Category:SDK]]
			This object is used to move along a contour a fixed distance at a time irrespective of the number of spans in the contour or the type of spans.

			Constructor

			ContourCarriage( Contour ctr, Point2D pt)

			Creates a ‘carriage’ for the passed contour and positions it at the nearest point on the contour to the passed point.

			ctr-Contour -The contour that the carriage travels along

			pt-Point2D -The carriage is positioned on the contour at the closest position to this point





			ContourCarriage( integer span_index, double parameter)

			Creates a ‘carriage’ for a contour and set its positions for the span with the passed index at the passed parameter position (in range 0-1.0) on the span. These values are normaly specified as 0,0.0 to position the carriage at the start of the first span in the contour.

			span_index-integer -Index of span, carriage will be positioned at parameter-double -Parameter along span carriage will be positioned at





			e.g local cursor = ContourCarriage(0, 0.0)



			Properties

			.IsInvalid

			R/O - bool - Returns true if current position is invalid



			.SpanIndex

			R/O - integer - Return span index for current position of carriage



			.SpanParameter

			R/O - double - Return span parameter (in range 0-1.0) for current position of carriage



			Methods

			:Move( Contour ctr, double distance)

			Moves the carriage the requested distance along the contour. Returns true if manage to move requested distance successfully. If the contour is closed we will wrap around at the end, if it is open and you attempt to move past the end this method will return false.

			ctr-Contour -The contour this carriage rides along

			distance - double –The distance to move along the contour, negative values will move back towards the start



			:Position( Contour ctr)

			Returns a Point2D representing the current position on the carriage on the passed contour

			ctr-Contour -The contour this carriage rides along



			:UpdatePosition( Contour ctr, Point2D pt)

			Update the position of the carriage to the nearest position on the contour to the passed point.

			ctr-Contour -The contour that the carriage travels along

			pt-Point2D -The carriage is positioned on the contour at the closest position to this point



			Example Code

			[[ -------------- MarkContourParameterSteps --------------------------------- \|

			\| Insert a marker at each parameter step around the contour and display the

			\| distance from the start point

			\| ]]

			function MarkContourParameterSteps(num_steps, contour, layer)



			local cursor = ContourCarriage(0, 0.0)



			local contour_length = contour.Length local step_dist = contour_length / num_steps



			local end_index = num_steps if contour.IsOpen then end_index = end_index + 1 end

			for i = 1, end_index do

			local ctr_pos = cursor:Position(contour)

			local marker = CadMarker("D:" .. (step_dist * (i - 1)), ctr_pos, 3) layer:AddObject(marker, true) cursor:Move(contour, step_dist)

			end end

WikiSysop: Created page with "link=Creating Vectors From Script link=Creating Vectors From Script ==References== '''Please Note:'..."

2021-08-04T03:18:55Z

Created page with "right|50px|link=Creating Vectors From Script right|50px|link=Creating Vectors From Script ==References== '''Please Note:'..."

New page

[[File:Back.jpg|right|50px|link=Creating Vectors From Script]]

[[File:Back.jpg|right|50px|link=Creating Vectors From Script]]
==References==
'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]