`GeometryRebuild`

The rebuild tools.

Example

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

    -- Create some geometry with a hole to fill

ellipse = project.Contents.Geometry:AddEllipse(cf.Point(), 2, 2)
rectangle = project.Contents.Geometry:AddRectangle(cf.Point(), 1, 1)
subtract = project.Contents.Geometry:Subtract(ellipse, {rectangle})

    -- Convert the geometry to primitive before it can be rebuild

geometry = subtract:ConvertToPrimitive()

    -- Find one of the inner edges to construct an edge loop to fill

centreEdge = geometry.Edges:ClosestTo(cf.Point())
edgeLoop = project.Contents.Geometry.Find:EdgeLoop({centreEdge})

    -- Fill the hole with the found inner edge loop

project.Contents.Geometry.Rebuild:FillHole(edgeLoop)

Inheritance

The GeometryRebuild object is derived from the Object object.

Usage locations

The GeometryRebuild object can be accessed from the following locations:

Properties
- GeometryCollection collection has property Rebuild.

Property List

FillHoleSettings: The settings to be used during the hole filling operation. (Read only FillHoleSettings)
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.)
FillHole (edges List of Edge): Fill the hole using the specified bounding edges.
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

FillHoleSettings

The settings to be used during the hole filling operation.

Type: FillHoleSettings
Access: Read only

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.

FillHole (edges List of Edge)

Fill the hole using the specified bounding edges.

Input Parameters

edges(List of Edge): The list of edges forming a closed loop, which defines the hole which must be filled.

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.