PolylineRefinement

A point refinement meshing rule. Objects in the vicinity of the polyline are meshed finer.

Example

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

    -- Create a mesh refinement polyline at the specified corners

corners = {cf.Point(), cf.Point(1, 0, 0), cf.Point(1, 1, 0)}
pointRefinement = project.MeshRefinementRules:AddPolylineRefinement(corners, 0.1, 0.01)

    -- Change the polyline refinement radius to 0.2
    
pointRefinement.Radius = 0.2

Inheritance

The PolylineRefinement object is derived from the MeshRefinementRule object.

Property List

Label
The object label. (Read/Write string)
LocalWorkplane
The polyline refinement's workplane. (Read only LocalWorkplane)
MeshSize
The target mesh size in the refinement region. (Read/Write Expression)
Radius
The radius around the polyline that will be affected by the refinement. (Read/Write Expression)
Type
The object type string. (Read only string)

Collection List

Corners
The collection of corner coordinates of the polyline refinement. (PolylineRefinementCornerCollection of LocalCoordinates.)

Method List

Delete ()
Delete the mesh refinement rule.
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.)
SetProperties (properties table)
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

Label
The object label.
Type
string
Access
Read/Write
LocalWorkplane
The polyline refinement's workplane.
Type
LocalWorkplane
Access
Read only
MeshSize
The target mesh size in the refinement region.
Type
Expression
Access
Read/Write
Radius
The radius around the polyline that will be affected by the refinement.
Type
Expression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Collection Details

Corners
The collection of corner coordinates of the polyline refinement.
Type
PolylineRefinementCornerCollection

Method Details

Delete ()
Delete the mesh refinement rule.
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 properties table.
SetProperties (properties table)
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(table)
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
The default properties table.