`MeshAssemblyCollection`

A collection of mesh assemblies.

Example

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

    -- Add two empty mesh assemblies

project.Meshes.Assemblies:Add()
project.Meshes.Assemblies:Add()

    -- Obtain a handle to the 'MeshAssemblyCollection'
    
meshAssemblies =  project.Meshes.Assemblies

    -- Store the number of assemblies.
    
meshAssembliesCount = meshAssemblies.Count

Usage locations (collections)

The following objects contain the MeshAssemblyCollection collection:

MeshCollection(.Assemblies)

Property List

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

Method List

Add (): Adds an empty assembly to the collection. (Returns a MeshAssembly object.)
Add (parts List of Mesh): Adds an assembly containing the given parts. (Returns a MeshAssembly object.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number): Returns the MeshAssembly at the given index. (Returns a MeshAssembly object.)
Item (label string): Returns the MeshAssembly with the given label. (Returns a MeshAssembly object.)
Items (): Returns a table of MeshAssembly. (Returns a List of MeshAssembly 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 MeshAssembly at the given index in the collection. (Read MeshAssembly)
[string]: Returns the MeshAssembly with the given name in the collection. (Read MeshAssembly)

Property Details

Count

The number of MeshAssembly items in the collection.

Type: number
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Method Details

Add ()

Adds an empty assembly to the collection.

Return

MeshAssembly: The new assembly.

Add (parts List of Mesh)

Adds an assembly containing the given parts.

Input Parameters

parts(List of Mesh): The parts to place in the assembly.

Return

MeshAssembly: The new assembly.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the MeshAssembly.

Return

boolean: The success of the check.

Item (index number)

Returns the MeshAssembly at the given index.

Input Parameters

index(number): The index of the MeshAssembly.

Return

MeshAssembly: The MeshAssembly at the given index.

Item (label string)

Returns the MeshAssembly with the given label.

Input Parameters

label(string): The label of the MeshAssembly.

Return

MeshAssembly: The MeshAssembly with the given label.

Items ()

Returns a table of MeshAssembly.

Return

List of MeshAssembly: A table of MeshAssembly.

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 MeshAssembly.