FaceCollection

A collection of faces.

Example

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

    -- Create geometry which contains faces 
    
cube = project.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)

    -- Set the local mesh size on each face

for key,value in pairs(cube.Faces) do
    value.LocalMeshSize = 0.1
end

Usage locations (collections)

The following objects contain the FaceCollection collection:

Property List

Count
The number of Face items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

ClosestTo (point Point)
Gets the closest face, in this list, to the given point. Ties are broken by returning the older face. (Returns a Face object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Delete (faces List of Face)
Delete the given list of faces.
Item (index number)
Returns the Face at the given index. (Returns a Face object.)
Item (label string)
Returns the Face with the given label. (Returns a Face object.)
Items ()
Returns a table of Face. (Returns a List of Face object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the Face at the given index in the collection. (Read Face)
[string]
Returns the Face with the given name in the collection. (Read Face)

Property Details

Count
The number of Face items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

ClosestTo (point Point)
Gets the closest face, in this list, to the given point. Ties are broken by returning the older face.
Input Parameters
point(Point)
The point to query against.
Return
Face
The closest face to the point.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the Face.
Return
boolean
The success of the check.
Delete (faces List of Face)
Delete the given list of faces.
Input Parameters
faces(List of Face)
List of faces to delete.
Item (index number)
Returns the Face at the given index.
Input Parameters
index(number)
The index of the Face.
Return
Face
The Face at the given index.
Item (label string)
Returns the Face with the given label.
Input Parameters
label(string)
The label of the Face.
Return
Face
The Face with the given label.
Items ()
Returns a table of Face.
Return
List of Face
A table of Face.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for Face.