# Edge

A geometry edge entity. When the edge is not connected to any faces it is considered to be a wire.

## Example

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

-- Create geometry which contains edges/wires

polyline = project.Geometry:AddPolyline({cf.Point(0, 0, 0), cf.Point(1, 1, 1), cf.Point(1,0,0)})

-- Remove the first wire from the polyline

polyline.Wires["Wire1"]:Delete()


## Inheritance

The Edge object is derived from the GeometryEntity object.

## Usage locations (object properties)

The following objects have properties using the Edge object:

## Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box)
CentreOfGravity
A point indicating the centre of gravity of this entity. (Read only Point)
Coating
The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this property will set CoatingEnabled to true.Only applicable for wires (free edges). (Read/Write Medium)
CoatingEnabled
Specifies if a coating should be applied to the wire.Only applicable for wires (free edges). (Read/Write boolean)
CoreMedium
The wire core medium.Only applicable for wires (free edges). (Read/Write Medium)
EdgeType
The type of edge. (Read only GeometryEdgeEnum)
Faulty
Indicates whether the geometry entity has faults. (Read only boolean)
Label
Length
The length of the edge. (Read only number)
Specifies if the local intrinsic wire radius should be used for the wire.Only applicable for wires (free edges). (Read/Write boolean)
LocalMeshSize
The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true. (Read/Write Expression)
LocalMeshSizeEnabled
Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean)
The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true.Only applicable for wires (free edges). (Read/Write Expression)
Specifies if the local wire radius should be used for the wire.Only applicable for wires (free edges). (Read/Write boolean)
Part
The geometry operator that the edge belongs to. (Read only Geometry)
SolutionMethod
The local solution method used for the wire.Only applicable for wires (free edges). (Read/Write EdgeSolutionMethodEnum)
SurroundingMedium
The medium in which the wire (free edge) is embedded.Only applicable for wires (free edges). (Read only Medium)
Suspect
Indicates whether the geometry entity is suspect. (Read only boolean)
Type
The object type string. (Read only string)
Windscreen
The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to Windscreen.Only applicable for wires (free edges). (Read only WindscreenSolutionMethod)

## Method List

Delete ()
Delete the wire/edge.
Duplicate ()
Create a duplicate of the edge as a new geometry operator. (Returns a Geometry 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.)
SetNotSuspect ()
Reset the suspect setting on the geometry entity.
SetProperties (properties table)
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.
ShortestDistanceTo (point Point)
Find the shortest distance between this edge and the given point. (Returns a number object.)

## Property Details

BoundingBox
A box indicating the bounding box of this entity.
Type
Box
Access
CentreOfGravity
A point indicating the centre of gravity of this entity.
Type
Point
Access
Coating
The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this property will set CoatingEnabled to true.Only applicable for wires (free edges).
Type
Medium
Access
CoatingEnabled
Specifies if a coating should be applied to the wire.Only applicable for wires (free edges).
Type
boolean
Access
CoreMedium
The wire core medium.Only applicable for wires (free edges).
Type
Medium
Access
EdgeType
The type of edge.
Type
GeometryEdgeEnum
Access
Faulty
Indicates whether the geometry entity has faults.
Type
boolean
Access
Label
The object label.
Type
string
Access
Length
The length of the edge.
Type
number
Access
Specifies if the local intrinsic wire radius should be used for the wire.Only applicable for wires (free edges).
Type
boolean
Access
LocalMeshSize
The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true.
Type
Expression
Access
LocalMeshSizeEnabled
Specifies if the local mesh size should be used for the wire/edge.
Type
boolean
Access
The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true.Only applicable for wires (free edges).
Type
Expression
Access
Specifies if the local wire radius should be used for the wire.Only applicable for wires (free edges).
Type
boolean
Access
Part
The geometry operator that the edge belongs to.
Type
Geometry
Access
SolutionMethod
The local solution method used for the wire.Only applicable for wires (free edges).
Type
EdgeSolutionMethodEnum
Access
SurroundingMedium
The medium in which the wire (free edge) is embedded.Only applicable for wires (free edges).
Type
Medium
Access
Suspect
Indicates whether the geometry entity is suspect.
Type
boolean
Access
Type
The object type string.
Type
string
Access
Windscreen
The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to Windscreen.Only applicable for wires (free edges).
Type
WindscreenSolutionMethod
Access

## Method Details

Delete ()
Delete the wire/edge.
Duplicate ()
Create a duplicate of the edge as a new geometry operator.
Return
Geometry
The geometry operator containing the duplicated edge.
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 properties table.
SetNotSuspect ()
Reset the suspect setting on the geometry entity.
SetProperties (properties table)
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(table)
A table of properties defining the new state of the object.
ShortestDistanceTo (point Point)
Find the shortest distance between this edge and the given point.
Input Parameters
point(Point)
The point to query against.
Return
number
The shortest distance between the given point and this edge.