`MeshSettingsCollection`

A collection of mesh setting definitions.

Example

application = cf.Application.getInstance()
project = application:NewProject()

-- Add two mesh setting definions

properties1 = cf.LocalMeshSettings.GetDefaultProperties()
properties1.Label = "LocalMeshSettings1"
localMeshSettings1 = project.Definitions.MeshSettings:Add(properties1)
localMeshSettings2 = project.Definitions.MeshSettings:Add(cf.Enums.MeshSizeOptionEnum.Coarse)

-- Create a cuboid with its base corner at the specified 'Point'

corner = cf.Point(-0.25, -0.25, 0)
cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25)

-- Set local mesh settings on cuboid
cubeproperties = cube:GetProperties()
cubeproperties.LocalMeshSettingsEnabled = true
cubeproperties.MeshSettings = localMeshSettings1
cube:SetProperties(cubeproperties)

Inheritance

The MeshSettingsCollection object is derived from the Object object.

Usage locations

The MeshSettingsCollection object can be accessed from the following locations:

Collection lists

Property List

Count: The number of LocalMeshSettings items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Add ( table): Add a mesh setting definion with default values. (Returns a LocalMeshSettings object.)
Add ( MeshSizeOptionEnum): Add a mesh setting definion with standard, coarse or fine mesh settings. (Returns a LocalMeshSettings object.)
Delete (): Deletes the entity.
DeleteEntities ( List of Object): Delete the given list of entities from the collection.
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 LocalMeshSettings for the given index in the collection. (Returns a LocalMeshSettings object.)
Item (label string): Returns the LocalMeshSettings for the given label in the collection. (Returns a LocalMeshSettings object.)
Items (): Returns a table of LocalMeshSettings items. (Returns a UnsupportedType(List of LocalMeshSettings) object.)
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.

Static Function List

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

Property Details

Count

The number of LocalMeshSettings items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

Add ( table)

Add a mesh setting definion with default values.

Input Parameters

(table)

Return

LocalMeshSettings

Add ( MeshSizeOptionEnum)

Add a mesh setting definion with standard, coarse or fine mesh settings.

Input Parameters

(MeshSizeOptionEnum)

Return

LocalMeshSettings

Delete ()

Deletes the entity.

DeleteEntities ( List of Object)

Delete the given list of entities from the collection.

Input Parameters

(List of Object)

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 LocalMeshSettings for the given index in the collection.

Input Parameters

index(number): The index of the LocalMeshSettings.

Return

LocalMeshSettings: The item in the collection

Item (label string)

Returns the LocalMeshSettings for the given label in the collection.

Input Parameters

label(string): The label of the LocalMeshSettings.

Return

LocalMeshSettings: The item in the collection

Items ()

Returns a table of LocalMeshSettings items.

Return

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

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.

Static Function Details

GetDefaultProperties ()

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

Return

table: A table containing the default properties.