EdgeCollection

Example

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

    -- Create geometry which contains edges 
    
cuboid = project.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)

    -- Set the local mesh size of each edge

for key,value in pairs(cuboid.Edges) do
    value.LocalMeshSize = 0.1
end

Usage locations (collections)

The following objects contain the EdgeCollection collection:

• AnalyticalCurve(.Edges)
• BezierCurve(.Edges)
• Cone(.Edges)
• ConstrainedSurface(.Edges)
• Cuboid(.Edges)
• Cylinder(.Edges)
• Ellipse(.Edges)
• EllipticArc(.Edges)
• FittedSpline(.Edges)
• Flare(.Edges)
• Geometry(.Edges)
• Helix(.Edges)
• HyperbolicArc(.Edges)
• ImprintPoints(.Edges)
• Intersect(.Edges)
• Line(.Edges)
• Loft(.Edges)
• NurbsSurface(.Edges)
• ParabolicArc(.Edges)
• Paraboloid(.Edges)
• PathSweep(.Edges)
• Polygon(.Edges)
• Polyline(.Edges)
• Primitive(.Edges)
• ProjectGeometry(.Edges)
• Rectangle(.Edges)
• Simplify(.Edges)
• Spheroid(.Edges)
• Spin(.Edges)
• Split(.Edges)
• Stitch(.Edges)
• Subtract(.Edges)
• SurfaceBezierCurve(.Edges)
• SurfaceLine(.Edges)
• SurfaceRegularLines(.Edges)
• Sweep(.Edges)
• Union(.Edges)

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 edge, in this list, to the given point. Ties are broken by returning the older edge. (Returns a Edge object.)

Contains (label string)

Checks if the collection contains an item with the given label. (Returns a boolean object.)

Delete (edges List of Edge)

Delete the given list of edges.

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 edge, in this list, to the given point. Ties are broken by returning the older edge.

Input Parameters

point(Point)

The point to query against.

Return

Edge

The closest edge 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 (edges List of Edge)

Delete the given list of edges.

Input Parameters

edges(List of Edge)

List of edges 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.