Vectric Lua Interface for Gadgets: Difference between revisions
No edit summary |
No edit summary |
||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[File:Back.jpg|right|50px|link=Main Page]] | [[File:Back.jpg|right|50px|link=Main Page]] | ||
[[Category:SDK]] | [[Category:SDK]] | ||
======''Version 3. | ======''Version 3.1''====== | ||
'''Please Note: ''The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version | '''Please Note: ''The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 12.0, published 9th September 2024. by Vectric Ltd.''''' | ||
::Most current document and sample Gadgets can be downloaded from Vertric at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information ] | ::Most current document and sample Gadgets can be downloaded from Vertric at '''[https://gadgets.vectric.com/developerinfo.html Vertric Developer Information ]''' | ||
[[File:VLIFG.jpg|thumb|Vectric SDK ver | [[File:VLIFG.jpg|thumb|Vectric SDK ver 12.0]] | ||
<p>The Script interface and associated documentation is designed for people who are familiar with programming and is provided as a development tool for such people. It is extremely important to understand that Vectric cannot offer individual support for people wanting to write scripts. This documentation and the associated example scripts available from the [https://www.vectric.com Vectric web site] are the only way you can learn about the script interface and develop your own gadgets. The appropriate area on the [http://forum.vectric.com/index.php Vectric forum] may also be useful for asking questions of other users.</p> | <p>The Script interface and associated documentation is designed for people who are familiar with programming and is provided as a development tool for such people. It is extremely important to understand that Vectric cannot offer individual support for people wanting to write scripts. This documentation and the associated example scripts available from the [https://www.vectric.com Vectric web site] are the only way you can learn about the script interface and develop your own gadgets. The appropriate area on the [http://forum.vectric.com/index.php Vectric forum] may also be useful for asking questions of other users.</p> | ||
<strong>Introduction</strong> | <strong>Introduction</strong> | ||
<p>The Script interface and associated documentation is designed for people who are familiar with | <p>The Script interface and associated documentation is designed for people who are familiar with | ||
| Line 26: | Line 26: | ||
<strong>Software Development Kit</strong> | <strong>Software Development Kit</strong> | ||
;*[[SDK: Revisions | Revision History]] | ;*[[SDK: Revisions | Revision History]] | ||
;*[[Gadget File Requirements]] | |||
;*[[Global_Methods]] | ;*[[Global_Methods]] | ||
;*[[Job Related Global Methods]] | ;*[[Job Related Global Methods]] | ||
| Line 40: | Line 41: | ||
;*[[DocumentVariableList]] | ;*[[DocumentVariableList]] | ||
;*[[DocumentVariable]] | ;*[[DocumentVariable]] | ||
;*[[ | ;*[[JimAndi Toolbox]] | ||
;*[[Wiki Toolbox]] | |||
;*[[Licence.txt]] | |||
[[File:Back.jpg|right|50px|link=Main Page]] | [[File:Back.jpg|right|50px|link=Main Page]] | ||
Latest revision as of 20:44, 15 September 2024
Version 3.1
Please Note: The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 12.0, published 9th September 2024. by Vectric Ltd.
- Most current document and sample Gadgets can be downloaded from Vertric at Vertric Developer Information
The Script interface and associated documentation is designed for people who are familiar with programming and is provided as a development tool for such people. It is extremely important to understand that Vectric cannot offer individual support for people wanting to write scripts. This documentation and the associated example scripts available from the Vectric web site are the only way you can learn about the script interface and develop your own gadgets. The appropriate area on the Vectric forum may also be useful for asking questions of other users.
Introduction
The Script interface and associated documentation is designed for people who are familiar with programming and is provided as a development tool for such people. It is extremely important to understand that Vectric cannot offer individual support for people wanting to write scripts. This documentation and the associated example scripts available from the Vectric web site are the only way you can learn about the script interface and develop your own gadgets. The appropriate area on the Vectric forum may also be useful for asking questions of other users.
This document lists the objects (classes) available to Lua scripts (Gadgets) from VCarve Pro V7.5 and Aspire V4.5
An object in Lua can have both methods and properties. A method is called using ‘:’ after the object name e.g. job:Refresh2DView(), a property is accessed via ‘.’ e.g. job.Exists . Properties can be either read only (R/O i.e Get Values) or read / write (R/W - Get/Set Values).
Software Development Kit
- Revision History
- Gadget File Requirements
- Global_Methods
- Job Related Global Methods
- Vector Object Related Global Methods
- Component Related Global Methods – Aspire Only
- Document Variable Related Global Methods
- Data File Locations Related Global Methods
- High Level Objects
- Creating Vectors From Script
- Low Level Geometry
- Toolpaths
- User Interface
- Aspire Only
- DocumentVariableList
- DocumentVariable
- JimAndi Toolbox
- Wiki Toolbox
- Licence.txt