SelectionList - Revision history

WikiSysop: /* :GetNext(POSITION pos) */

2024-02-01T04:58:46Z

:GetNext(POSITION pos)

← Older revision		Revision as of 22:58, 31 January 2024
Line 107:		Line 107:
	::''pos – POSITION – current position in list		::''pos – POSITION – current position in list

	Example - note that GetNext(pos) is returning two values ...		'''''Example Code:'''''

			-- note that GetNext(pos) is returning two values ...

	local pos = obj_list:GetHeadPosition()		local pos = obj_list:GetHeadPosition()

WikiSysop: /* :GetNext(POSITION pos) */

2023-09-07T14:23:38Z

:GetNext(POSITION pos)

← Older revision		Revision as of 08:23, 7 September 2023
Line 109:		Line 109:
	Example - note that GetNext(pos) is returning two values ...		Example - note that GetNext(pos) is returning two values ...

	local pos = obj_list:GetHeadPosition() local object while pos ~= nil do		local pos = obj_list:GetHeadPosition()
			local object
			while pos ~= nil do
			object, pos = obj_list:GetNext(pos)
			-- Do Something With Object ....
			end

	~~object, pos = obj_list:GetNext(pos) DO SOMETHING WITH OBJECT .... end~~		----

	~~----~~
	=== :GetPrev(POSITION pos) ===		=== :GetPrev(POSITION pos) ===

WikiSysop: /* :GetBoundingBox() */

2023-09-07T14:21:46Z

:GetBoundingBox()

← Older revision		Revision as of 08:21, 7 September 2023
Line 91:		Line 91:

	Return a Box2D with the bounds of the selected objects		Return a Box2D with the bounds of the selected objects



	----		----

	=== :GetHeadPosition() ===		=== :GetHeadPosition() ===

WikiSysop: /* :CanTransform(integer flags) */

2023-09-07T14:21:28Z

:CanTransform(integer flags)

← Older revision		Revision as of 08:21, 7 September 2023
Line 60:		Line 60:
	8 = Scale Symetric		8 = Scale Symetric
	16 = Scale Asymetric </nowiki>		16 = Scale Asymetric </nowiki>


	----		----

WikiSysop at 14:21, 7 September 2023

2023-09-07T14:21:11Z

← Older revision		Revision as of 08:21, 7 September 2023
Line 2:		Line 2:
	[[Category:SDK]]		[[Category:SDK]]
	This object holds a list of CadObjects representing the current selection in the program.		This object holds a list of CadObjects representing the current selection in the program.




	== Properties ==		== Properties ==
Line 12:		Line 10:

	Read Only - integer – return the number of objects in the list		Read Only - integer – return the number of objects in the list

WikiSysop: /* :Transform(Matrix2D xform) */

2023-09-07T14:20:47Z

:Transform(Matrix2D xform)

← Older revision		Revision as of 08:20, 7 September 2023
Line 167:		Line 167:


	'''Usage: ~~GetNext~~()'''		'''Usage: job.Selection()'''
	<nowiki>		<nowiki>
	The selection is accessed via the job …		The selection is accessed via the job …
Line 186:		Line 186:

	[[File:Back.jpg\|right\|50px\|link=High Level Objects]]		[[File:Back.jpg\|right\|50px\|link=High Level Objects]]

	==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 14:20, 7 September 2023

2023-09-07T14:20:14Z

@@ Line 3: / Line 3: @@
 This object holds a list of CadObjects representing the current selection in the program.
- <nowiki>
@@ Line 176: / Line 164: @@
 ::''xform – Matrix2D – transformation matrix to apply to objects  ''

WikiSysop: Created page with " link=High Level Objects Category:SDK This object holds a list of CadObjects representing the current selection in the program. ..."

2021-08-04T02:42:58Z

Created page with " right|50px|link=High Level Objects Category:SDK This object holds a list of CadObjects representing the current selection in the program. <nowiki>..."

New page

[[File:Back.jpg|right|50px|link=High Level Objects]]
[[Category:SDK]]
This object holds a list of CadObjects representing the current selection in the program.

<nowiki>
The selection is accessed via the job …
-- Check we have a document loaded
local job = VectricJob()
if not job.Exists then
DisplayMessageBox("No job loaded")
return false;
end -- if end
local selection = job.Selection
if selection.IsEmpty then
MessageBox("Please select one or more vectors to label")
return false
end </nowiki>

== Properties ==

----
=== .Count ===

Read Only - integer – return the number of objects in the list

----
=== .IsEmpty ===

Read Only - bool – return true if the list is empty

== Methods ==

=== :Add( CadObject obj, bool add_tail, bool group_add) ===

Add the passed object to the list

::''obj –CadObject –object to put in list''

::''add_tail –bool –if true add to end of selection else insert at start group_add –bool –if you are adding a lot of objects to the selection, set this true and call :GroupSelectionFinished() when you have added all the objects. This stops a lot of unnecessary updating while you are updating the selection. ''

----
=== :AddHead( CadObject obj) ===

Add the passed object to the front of the list

::''obj –CadObject –object to put in list ''

----
=== :AddTail( CadObject obj) ===

Add the passed object to the end of the list

::''obj –CadObject –object to put in list ''

----
=== :CanTransform(integer flags) ===

Return true if object can be transformed - these can be combined e.g 3 (1+2) will check for both Move and Rotate flags –integer –value indicating type of transform –
<nowiki>
1 = Move
2 = Rotate
4 = Mirror
8 = Scale Symetric
16 = Scale Asymetric </nowiki>

----

=== :CanSelect(CadObject obj) ===

Return true if passed object can be selected

::''obj –CadObject –object to test ''

----
=== :Clear() ===

Clear the selection (list is emptied)

----
=== :GetAt(POSITION pos) ===

Returns the object at the current position

::''pos – POSITION – current position in list ''

----
=== :GetBoundingBox() ===

Return a Box2D with the bounds of the selected objects

----
=== :GetHeadPosition() ===

Returns a POSITION variable to allow access to the head of the list

----
=== :GetNext(POSITION pos) ===

Returns the object at the current position AND a new value for position pointing to the next item in the list (or nil if at end of list)

::''pos – POSITION – current position in list

Example - note that GetNext(pos) is returning two values ...

local pos = obj_list:GetHeadPosition() local object while pos ~= nil do

object, pos = obj_list:GetNext(pos) DO SOMETHING WITH OBJECT .... end

----
=== :GetPrev(POSITION pos) ===

Returns the object at the current position AND a new value for position, pointing to the previous item in the list (or nil if at start of list)

::''pos – POSITION – current position in list :GetTailPosition() ''

::''Returns a POSITION variable to allow access to the tail (end) of the list ''

----
=== :GroupSelectionFinished() ===

Call this if you have been using :Add(…) with group_add set to true to update the application when you have finished adding objects to the selection.

----
=== :RemoveOnLayer(UUID layer_id) ===

Remove any objects from the selection which are on the layer with the passed id. The objects are just removed from the selection, they are not deleted are changed in any other way.

----
=== :Remove( CadObject obj, bool group_remove) ===

Remove the passed object from the selection
::''obj –CadObject –object to put in list group_remove –bool –if you are removing a lot of objects to the selection, set this true and call :GroupSelectionFinished() when you have removed all the objects. This stops a lot of unnecessary updating while you are updating the selection. ''

----
=== :RemoveHead() ===

Remove the id at the front of the list and return it

----
=== :RemoveTail() ===

Remove the id at the end of the list and return it

----
=== :Transform(Matrix2D xform) ===

Transform all objects in list by passed transform

::''xform – Matrix2D – transformation matrix to apply to objects ''

[[File:Back.jpg|right|50px|link=High Level Objects]]
==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]