GeometryAssemblyCollection
A collection of geometry assemblies.
Example
app = cf.GetApplication() project = app:NewProject() cuboid = project.Geometry:AddCuboid(cf.Point(0,0,0),1,1,1) assembly = project.Geometry.Assemblies:Add({cuboid}) assemblyLabel = assembly.Label -- Retrieve an assembly assembly = project.Geometry.Assemblies:Item(assemblyLabel)
Usage locations (collections)
The following objects contain the GeometryAssemblyCollection collection:
Property List
Method List
- Add ()
- Adds an empty assembly to the collection. (Returns a GeometryAssembly object.)
- Add (parts List of Geometry)
- Adds an assembly containing the given parts. (Returns a GeometryAssembly object.)
- Contains (label string)
- Checks if the collection contains an item with the given label. (Returns a boolean object.)
- Item (index number)
- Returns the GeometryAssembly at the given index. (Returns a GeometryAssembly object.)
- Item (label string)
- Returns the GeometryAssembly with the given label. (Returns a GeometryAssembly object.)
- Items ()
- Returns a table of GeometryAssembly. (Returns a List of GeometryAssembly 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 GeometryAssembly at the given index in the collection. (Read GeometryAssembly)
- [string]
- Returns the GeometryAssembly with the given name in the collection. (Read GeometryAssembly)
Property Details
Method Details
- Add ()
- Adds an empty assembly to the collection.
- Return
- GeometryAssembly
- The new assembly.
- Add (parts List of Geometry)
- Adds an assembly containing the given parts.
- Input Parameters
- Return
- GeometryAssembly
- The new assembly.
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the GeometryAssembly at the given index.
- Input Parameters
- index(number)
- The index of the GeometryAssembly.
- Return
- GeometryAssembly
- The GeometryAssembly at the given index.
- Item (label string)
- Returns the GeometryAssembly with the given label.
- Input Parameters
- label(string)
- The label of the GeometryAssembly.
- Return
- GeometryAssembly
- The GeometryAssembly with the given label.
- Items ()
- Returns a table of GeometryAssembly.
- Return
- List of GeometryAssembly
- A table of GeometryAssembly.
- 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.