RegionCollection

A collection of regions.

Example

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

    -- Create geometry which contains regions 
    
project.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)
project.Geometry:AddSphere(cf.Point(0.5, 0.5, 0.5), 1)
union = project.Geometry:Union()

    -- Set the local mesh size on each region

for key,value in pairs(union.Regions) do
    value.LocalMeshSize = 0.1
end

Usage locations (collections)

The following objects contain the RegionCollection collection:

Property List

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

Method List

Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the Region at the given index. (Returns a Region object.)
Item (label string)
Returns the Region with the given label. (Returns a Region object.)
Items ()
Returns a table of Region. (Returns a List of Region 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 Region at the given index in the collection. (Read Region)
[string]
Returns the Region with the given name in the collection. (Read Region)

Property Details

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

Method Details

Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the Region.
Return
boolean
The success of the check.
Item (index number)
Returns the Region at the given index.
Input Parameters
index(number)
The index of the Region.
Return
Region
The Region at the given index.
Item (label string)
Returns the Region with the given label.
Input Parameters
label(string)
The label of the Region.
Return
Region
The Region with the given label.
Items ()
Returns a table of Region.
Return
List of Region
A table of Region.
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 Region.