RegionCollection

Example

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

    -- Create geometry which contains regions

project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)
project.Contents.Geometry:AddSphere(cf.Point(0.5, 0.5, 0.5), 1)
union = project.Contents.Geometry:Union()

    -- Set the local mesh size on each region

for key,value in pairs(union.Regions) do
    value.LocalMeshSize = 0.1
end

Inheritance

The RegionCollection object is derived from the Object object.

Usage locations

The RegionCollection object can be accessed from the following locations:

• Collection lists
  • Geometry object has collection Regions.
  • AnalyticalCurve object has collection Regions.
  • BezierCurve object has collection Regions.
  • Cone object has collection Regions.
  • ConstrainedSurface object has collection Regions.
  • Cuboid object has collection Regions.
  • Cylinder object has collection Regions.
  • Ellipse object has collection Regions.
  • EllipticArc object has collection Regions.
  • FittedSpline object has collection Regions.
  • Flare object has collection Regions.
  • Helix object has collection Regions.
  • HyperbolicArc object has collection Regions.
  • ImprintPoints object has collection Regions.
  • Intersect object has collection Regions.
  • Loft object has collection Regions.
  • PathSweep object has collection Regions.
  • ProjectGeometry object has collection Regions.
  • RepairAndSewFaces object has collection Regions.
  • RepairPart object has collection Regions.
  • Spin object has collection Regions.
  • Split object has collection Regions.
  • Stitch object has collection Regions.
  • Subtract object has collection Regions.
  • Sweep object has collection Regions.
  • Union object has collection Regions.
  • Simplify object has collection Regions.
  • Line object has collection Regions.
  • NurbsSurface object has collection Regions.
  • ParabolicArc object has collection Regions.
  • Paraboloid object has collection Regions.
  • Polygon object has collection Regions.
  • Polyline object has collection Regions.
  • Primitive object has collection Regions.
  • Rectangle object has collection Regions.
  • Sphere object has collection Regions.
  • AbstractSurfaceCurve object has collection Regions.
  • SurfaceBezierCurve object has collection Regions.
  • SurfaceLine object has collection Regions.
  • SurfaceRegularLines object has collection Regions.

Property List

Label

The object label. (Read/Write string)

Type

The object type string. (Read only string)

Method List

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

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

Label

The object label.

Type

string

Access

Read/Write

Type

The object type string.

Type

string

Access

Read only

Method Details

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.

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.