ChildOperatorCollection

A collection of child operators.

Example

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

    -- Union two geometry parts
    
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()

    -- Remove the sphere from the union
    
union.Children["Sphere1"]:Delete()

Usage locations (collections)

The following objects contain the ChildOperatorCollection collection:

Property List

Count
The number of Geometry 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 Geometry at the given index. (Returns a Geometry object.)
Item (label string)
Returns the Geometry with the given label. (Returns a Geometry object.)
Items ()
Returns a table of Geometry. (Returns a List of Geometry object.)
Replace (target Geometry, source Geometry)
Replace the given child operator with the specified operator.
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 Geometry at the given index in the collection. (Read Geometry)
[string]
Returns the Geometry with the given name in the collection. (Read Geometry)

Property Details

Count
The number of Geometry 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 Geometry.
Return
boolean
The success of the check.
Item (index number)
Returns the Geometry at the given index.
Input Parameters
index(number)
The index of the Geometry.
Return
Geometry
The Geometry at the given index.
Item (label string)
Returns the Geometry with the given label.
Input Parameters
label(string)
The label of the Geometry.
Return
Geometry
The Geometry with the given label.
Items ()
Returns a table of Geometry.
Return
List of Geometry
A table of Geometry.
Replace (target Geometry, source Geometry)
Replace the given child operator with the specified operator.
Input Parameters
target(Geometry)
The child operator to replace.
source(Geometry)
The new operator.
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 Geometry.