WireCollection

A collection of wires.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create geometry which contains wires 
    
polyline = project.Geometry:AddPolyline({cf.Point(0, 0, 0), cf.Point(1, 1, 1), cf.Point(0, 1, 0)})

    -- Set the local mesh size of each wire

for key,value in pairs(polyline.Wires) do
    value.LocalMeshSize = 0.1
end

Usage locations (collections)

The following objects contain the WireCollection collection:

Property List

Count
The number of Edge items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

ClosestTo (point Point)
Gets the closest wire, in this list, to the given point. Ties are broken by returning the older wire. (Returns a Edge object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Delete (wires List of Edge)
Delete the given list of wires.
Item (index number)
Returns the Edge at the given index. (Returns a Edge object.)
Item (label string)
Returns the Edge with the given label. (Returns a Edge object.)
Items ()
Returns a table of Edge. (Returns a List of Edge object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the Edge at the given index in the collection. (Read Edge)
[string]
Returns the Edge with the given name in the collection. (Read Edge)

Property Details

Count
The number of Edge items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

ClosestTo (point Point)
Gets the closest wire, in this list, to the given point. Ties are broken by returning the older wire.
Input Parameters
point(Point)
The point to query against.
Return
Edge
The closest wire to the point.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the Edge.
Return
boolean
The success of the check.
Delete (wires List of Edge)
Delete the given list of wires.
Input Parameters
wires(List of Edge)
List of wires to delete.
Item (index number)
Returns the Edge at the given index.
Input Parameters
index(number)
The index of the Edge.
Return
Edge
The Edge at the given index.
Item (label string)
Returns the Edge with the given label.
Input Parameters
label(string)
The label of the Edge.
Return
Edge
The Edge with the given label.
Items ()
Returns a table of Edge.
Return
List of Edge
A table of Edge.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for Edge.