`Edge`

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

Example

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

    -- Create geometry which contains edges/wires

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

Usage locations

The Edge object can be accessed from the following locations:

Properties
- WirePort object has property Wire.
Methods
- TopologyEntityCollectionOf_Edge collection has method Item(number).
- TopologyEntityCollectionOf_Edge collection has method Item(string).
- EdgeCollection collection has method Item(number).
- EdgeCollection collection has method Item(string).
- WireCollection collection has method Item(number).
- WireCollection collection has method Item(string).
- Find object has method EdgeLoop(List of Edge).

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (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)
Geometry: The geometry operator that the region belongs to. (Read only Geometry)
Label: The object label. (Read/Write string)
Length: The length of the edge. (Read only number)
LocalIntrinsicWireRadiusEnabled: 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 ParametricExpression)
LocalMeshSizeEnabled: Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean)
LocalWireRadius: The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only applicable for wires (free edges). (Read/Write ParametricExpression)
LocalWireRadiusEnabled: Specifies if the local wire radius should be used for the wire. Only applicable for wires (free edges). (Read/Write boolean)
SolutionMethod: The local solution method used for the wire. (Read/Write EdgeSolutionMethodEnum)
SurroundingMedium: The medium in which the wire (free edge) is embedded.Only applicable for wires (free edges). (Read only Medium)
Type: The object type string. (Read only string)
Visible: Specifies whether the geometry must be shown or hidden. (Read/Write boolean)
Windscreen: The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to Windscreen. (Read/Write WindscreenSolutionMethod)

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

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

CentreOfGravity

A point indicating the centre of gravity of this entity.

Type: Point
Access: Read only

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: Read/Write

CoatingEnabled

Specifies if a coating should be applied to the wire.Only applicable for wires (free edges).

Type: boolean
Access: Read/Write

CoreMedium

The wire core medium.Only applicable for wires (free edges).

Type: Medium
Access: Read/Write

EdgeType

The type of edge.

Type: GeometryEdgeEnum
Access: Read only

Faulty

Indicates whether the geometry entity has faults.

Type: boolean
Access: Read only

Geometry

The geometry operator that the region belongs to.

Type: Geometry
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Length

The length of the edge.

Type: number
Access: Read only

LocalIntrinsicWireRadiusEnabled

Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires (free edges).

Type: boolean
Access: Read/Write

LocalMeshSize

The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true.

Type: ParametricExpression
Access: Read/Write

LocalMeshSizeEnabled

Specifies if the local mesh size should be used for the wire/edge.

Type: boolean
Access: Read/Write

LocalWireRadius

The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only applicable for wires (free edges).

Type: ParametricExpression
Access: Read/Write

LocalWireRadiusEnabled

Specifies if the local wire radius should be used for the wire. Only applicable for wires (free edges).

Type: boolean
Access: Read/Write

SolutionMethod

The local solution method used for the wire.

Type: EdgeSolutionMethodEnum
Access: Read/Write

SurroundingMedium

The medium in which the wire (free edge) is embedded.Only applicable for wires (free edges).

Type: Medium
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Visible

Specifies whether the geometry must be shown or hidden.

Type: boolean
Access: Read/Write

Windscreen

The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to Windscreen.

Type: WindscreenSolutionMethod
Access: Read/Write

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.