`MeshCollection`

A collection of editable meshes.

Example

application = cf.Application.GetInstance()
project = application:NewProject()
    
    -- Initialise the frequency

project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06"

    -- Create geometry and mesh

project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1)
project.Mesher:Mesh()
project.Contents.Geometry["Sphere1"]:UnlinkMesh()
project.Mesher:Mesh()
project.Contents.Geometry["Sphere1"]:UnlinkMesh()
    
    -- Obtain a handle to the 'MeshCollection'

meshCollection = project.Contents.Meshes

    -- Print the number of meshes in the collection

meshCollectionCount = meshCollection.Count

Inheritance

The MeshCollection object is derived from the CollectionOf_Mesh object.

Usage locations

The MeshCollection object can be accessed from the following locations:

Collection lists
- ModelContents object has collection Meshes.

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Count: The number of Mesh items in the collection. (Read only number)
Find: The mesh find tools. (Read only MeshFind)
Label: The object label. (Read/Write string)
Locked: A boolean that indicates whether the entity or it's ancestor is locked or not. (Read/Write boolean)
Repair: Mesh repair tools. (Read only MeshRepair)
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.)
Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Item (index number): Returns the Mesh for the given index in the collection. (Returns a Mesh object.)
Item (label string): Returns the Mesh for the given label in the collection. (Returns a Mesh object.)
Items (): Returns a table of Mesh items. (Returns a UnsupportedType(List of Mesh) object.)
MergeVertices (meshes List of Mesh, tolerance number, snapToGeometry boolean, snapToNamedPoints boolean): Merge model mesh vertices within a given tolerance. Able to snap to named points and geometry points within the given tolerance.
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
UniqueName (label string): Generates a unique name base 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 string object.)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

Count

The number of Mesh items in the collection.

Type: number
Access: Read only

Find

The mesh find tools.

Type: MeshFind
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Locked

A boolean that indicates whether the entity or it's ancestor is locked or not.

Type: boolean
Access: Read/Write

Repair

Mesh repair tools.

Type: MeshRepair
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 item.

Return

boolean: The success of the check.

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

Item (index number)

Returns the Mesh for the given index in the collection.

Input Parameters

index(number): The index of the Mesh.

Return

Mesh: The item in the collection

Item (label string)

Returns the Mesh for the given label in the collection.

Input Parameters

label(string): The label of the Mesh.

Return

Mesh: The item in the collection

Items ()

Returns a table of Mesh items.

Return

UnsupportedType(List of Mesh): The list of items in the collection

MergeVertices (meshes List of Mesh, tolerance number, snapToGeometry boolean, snapToNamedPoints boolean)

Merge model mesh vertices within a given tolerance. Able to snap to named points and geometry points within the given tolerance.

Input Parameters

meshes(List of Mesh): The list of meshes to merge vertices on.
tolerance(number): The tolerance to use for the distance between mesh vertices.
snapToGeometry(boolean): Specifies whether or not to snap to geometry points within the given tolerance.
snapToNamedPoints(boolean): Specifies whether or not to snap to named points within the given tolerance.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

UniqueName (label string)

Generates a unique name base 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

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.