Mesh

An editable mesh object.

Example

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

sphere = project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1)
project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06"
project.Mesher:Mesh()
sphere:UnlinkMesh()

    -- Delete the created mesh

mesh = project.Contents.Meshes[1]
mesh:Delete()

Inheritance

The Mesh object is derived from the Object object.

Usage locations

The Mesh object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Label
The object label. (Read/Write string)
LocalMeshSettingsEnabled
Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean)
LocalWorkplane
The source workplane. (Read/Write LocalWorkplane)
MeshSettings
The locally defined mesh setting to use. (Read/Write MeshSettings)
Type
The object type string. (Read only string)
Visible
Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

Collection List

CurvilinearFaces
The collection of faces meshed with curvilinear triangles. The faces form part of the mesh model. (MeshCurvilinearTriangleFaceCollection of MeshCurvilinearTriangleFace.)
CurvilinearWires
The collection of wires meshed with curvilinear segments. The wires form part of the mesh model. (MeshSegmentCurvilinearWireCollection of MeshCurvilinearWire.)
Cylinders
The collection of unmeshed cylinders that form part of the mesh model. (MeshCylinderCollection of MeshCylinder.)
Faces
The collection of faces meshed with flat triangles. The faces form part of the mesh model. (MeshTriangleFaceCollection of MeshTriangleFace.)
Plates
The collection of unmeshed plates that form part of the mesh model. (MeshPlateCollection of MeshPlate.)
Transforms
The collection of transforms on the operator. (TransformCollection of Transform.)
Wires
The collection of wires meshed with segments. The wires form part of the mesh model. (MeshSegmentWireCollection of MeshWire.)

Method List

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry. (Returns a List of Object 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.)
Replace (replacementMesh Mesh)
Replace the the mesh with another mesh transferring the properties and ports to the new mesh. (Returns a Mesh 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.
UnlinkMesh (unlinkoption UnlinkMeshOptionEnum)
Unlinks the geometry's associated simulation mesh. (Returns a Mesh 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
Label
The object label.
Type
string
Access
Read/Write
LocalMeshSettingsEnabled
Control if the locally defined mesh settings should be used for the entity.
Type
boolean
Access
Read/Write
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
Read/Write
MeshSettings
The locally defined mesh setting to use.
Type
MeshSettings
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the geometry must be shown or hidden.
Type
boolean
Access
Read/Write

Collection Details

CurvilinearFaces
The collection of faces meshed with curvilinear triangles. The faces form part of the mesh model.
Type
MeshCurvilinearTriangleFaceCollection
CurvilinearWires
The collection of wires meshed with curvilinear segments. The wires form part of the mesh model.
Type
MeshSegmentCurvilinearWireCollection
Cylinders
The collection of unmeshed cylinders that form part of the mesh model.
Type
MeshCylinderCollection
Faces
The collection of faces meshed with flat triangles. The faces form part of the mesh model.
Type
MeshTriangleFaceCollection
Plates
The collection of unmeshed plates that form part of the mesh model.
Type
MeshPlateCollection
Transforms
The collection of transforms on the operator.
Type
TransformCollection
Wires
The collection of wires meshed with segments. The wires form part of the mesh model.
Type
MeshSegmentWireCollection

Method Details

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
Object
The mirrored geometry.
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the rotate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of rotated geometry.
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry.
Input Parameters
origin(Point)
The coordinates of the origin of the rotation.
rotationaxis(Vector)
The axis of rotation.
angle(number)
The angle of rotation (degrees).
count(number)
The number of copies.
Return
List of Object
The list of rotated geometry.
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the translate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of translated geometry.
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry.
Input Parameters
from(Point)
Translate from coordinate.
to(Point)
Translate to coordinate.
count(number)
The number of copies.
Return
List of Object
The list of translated geometry.
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.
Replace (replacementMesh Mesh)
Replace the the mesh with another mesh transferring the properties and ports to the new mesh.
Input Parameters
replacementMesh(Mesh)
The target replacement mesh.
Return
Mesh
The resulting mesh.
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.
UnlinkMesh (unlinkoption UnlinkMeshOptionEnum)
Unlinks the geometry's associated simulation mesh.
Input Parameters
unlinkoption(UnlinkMeshOptionEnum)
Mesh ports are created. Solution entities are either keep with their original assignment or reassigned to the new port.
Return
Mesh
The unlinked mesh.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.