CadObjectGroup

This object is derived from CadObject and represents a group of CadObjects within the job.

Properties

This object inherits all documented properties from the CadObject base class with the following additions

.Count

Interaction: Read Only

Returns:(integer) the number of CadObjects in the group

.IsEmpty

Interaction: Read Only

Returns: (bool) a true if the CadObjectGroup is empty

Methods

This object inherits all documented methods from the CadObject base class with the following additions

:GetAt(POSITION pos)

Returns: the object at the current position

pos (POSTION) current position in list

:GetHead()

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

:GetHeadPosition()

Returns: (POSITION) variable to allow access to the head of the group

:GetNext(POSITION pos)

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

pos (POSTION) current position in group

:GetPrev(POSITION pos)

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

pos (POSTION) current position in list

:GetTailPosition()

Returns: (POSITION) variable to allow access to the tail (end) of the group

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 Vertric Developer Information