`Find`

The find tools.

Example

application = cf.Application.getInstance()
project = application:NewProject()
project.Contents.Geometry:AddEllipse(cf.Point(), 2, 2)
project.Contents.Geometry:AddRectangle(cf.Point(), 1, 1)

    -- Find the geometry that clashes

clashingGeometry = project.Contents.Geometry.Find:GetClashingGeometry()

Inheritance

The Find object is derived from the Object object.

Usage locations

The Find object can be accessed from the following locations:

Properties
- GeometryCollection collection has property Find.

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.)
EdgeLoop (edges List of Edge): Find the smallest closed loop from the specified list of edges. (Returns a List of Edge object.)
GetClashingGeometry (): Find parts where geometry clashes or where one part is completely inside another. (Returns a List of Geometry object.)
GetClashingGeometry (geometrylist List of Geometry): Find parts where geometry clashes or where one part is completely inside another from the given list of geometry parts. (Returns a List of 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.)
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.

EdgeLoop (edges List of Edge)

Find the smallest closed loop from the specified list of edges.

Input Parameters

edges(List of Edge): The list of edges which forms part of the closed loop.

Return

List of Edge: The list of edges forming a closed loop.

GetClashingGeometry ()

Find parts where geometry clashes or where one part is completely inside another.

Return

List of Geometry: The list of clashing geometry.

GetClashingGeometry (geometrylist List of Geometry)

Find parts where geometry clashes or where one part is completely inside another from the given list of geometry parts.

Input Parameters

geometrylist(List of Geometry): The list of geometry parts from which a search for clashes is conducted.

Return

List of Geometry: The list of clashing geometry.

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.