`WireCollection`

A collection of wires.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Create geometry which contains wires

polyline = project.Contents.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

Inheritance

The WireCollection object is derived from the TopologyEntityCollectionOf_Edge object.

Usage locations

The WireCollection object can be accessed from the following locations:

Collection lists
- Geometry object has collection Wires.
- AnalyticalCurve object has collection Wires.
- BezierCurve object has collection Wires.
- Cone object has collection Wires.
- ConstrainedSurface object has collection Wires.
- Cuboid object has collection Wires.
- Cylinder object has collection Wires.
- Ellipse object has collection Wires.
- EllipticArc object has collection Wires.
- FittedSpline object has collection Wires.
- Flare object has collection Wires.
- Helix object has collection Wires.
- HyperbolicArc object has collection Wires.
- ImprintPoints object has collection Wires.
- Intersect object has collection Wires.
- Loft object has collection Wires.
- PathSweep object has collection Wires.
- ProjectGeometry object has collection Wires.
- RepairAndSewFaces object has collection Wires.
- RepairPart object has collection Wires.
- Spin object has collection Wires.
- Split object has collection Wires.
- Stitch object has collection Wires.
- Subtract object has collection Wires.
- Sweep object has collection Wires.
- Union object has collection Wires.
- Simplify object has collection Wires.
- Line object has collection Wires.
- NurbsSurface object has collection Wires.
- ParabolicArc object has collection Wires.
- Paraboloid object has collection Wires.
- Polygon object has collection Wires.
- Polyline object has collection Wires.
- Primitive object has collection Wires.
- Rectangle object has collection Wires.
- Sphere object has collection Wires.
- AbstractSurfaceCurve object has collection Wires.
- SurfaceBezierCurve object has collection Wires.
- SurfaceLine object has collection Wires.
- SurfaceRegularLines object has collection Wires.

Property List

Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.