ConstrainedSurface
A constrained surface.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Create the tables for the surface values points = {} normals = {} uvSurfaceParams = {} -- Initialise the surface values for v = 0, 2 do for u = 1, 5 do points[u+v*5] = cf.Point(u, math.sin(((u-1)/4) * math.pi) + 0.5 - v, 0) normals[u+v*5] = cf.Point(0,0,1) uvSurfaceParams[u+v*5] = cf.UVPoint((u-1)/4, v) end end -- Create the constrained surface project.Contents.Geometry:AddConstrainedSurface(points, normals, uvSurfaceParams)
Inheritance
The ConstrainedSurface object is derived from the Geometry object.
Usage locations
The ConstrainedSurface object can be accessed from the following locations:
- Methods
- GeometryCollection collection has method AddConstrainedSurface(table).
- GeometryCollection collection has method AddConstrainedSurface(List of Point, List of Point, List of UVPoint).
- RepresentationGeometryCollection collection has method AddConstrainedSurface(table).
- RepresentationGeometryCollection collection has method AddConstrainedSurface(List of Point, List of Point, List of UVPoint).
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- Faulty
- Indicates whether the geometry has faults. (Read only boolean)
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- 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)
- Locked
- A boolean that indicates whether the entity or it's ancestor is locked or not. (Read/Write boolean)
- MeshSettings
- The locally defined mesh setting to use. This property is only available if LocalMeshSettingsEnabled is true. (Read/Write MeshSettings)
- Parent
- The parent part of this geometry. If this is a top level part nil will be returned. (Read only Geometry)
- Points
- The collection of points that define the constrained surface. (Read/Write ConstrainedSurfacePointList)
- SimulationMeshStatus
- The status of the simulation mesh. (Read only SimulationMeshStatusEnum)
- SymmetryEnabled
- Use symmetry to mirror points with respect to the symmetry plane specified by SymmetryPlane. (Read/Write boolean)
- SymmetryPlane
- Symmetry plane orientation. (Read/Write ConstrainedSurfSymmetryPlaneEnum)
- SymmetryPlaneConstantSurfaceParameter
- Constant surface parameter at the plane of symmetry. (Read/Write ConstrainedSurfSymmetryPlaneConstParamEnum)
- SymmetryPlaneUValue
- U' value at symmetry plane. Only enabled if SymmetryPlaneConstantSurfaceParameter is set to U. (Read/Write ParametricExpression)
- SymmetryPlaneVValue
- V' value at symmetry plane. Only enabled if SymmetryPlaneConstantSurfaceParameter is set to V. (Read/Write ParametricExpression)
- Type
- The object type string. (Read only string)
Collection List
- Edges
- The collection of edges of the operator. (EdgeCollection of Edge.)
- Faces
- The collection of faces of the operator. (FaceCollection of Face.)
- Regions
- The collection of regions of the operator. (RegionCollection of Region.)
- Transforms
- The collection of transforms on the operator. (TransformCollection of Transform.)
- Wires
- The collection of wires of the operator. (WireCollection of Edge.)
Method List
- ConvertToPrimitive ()
- Convert the geometry into its primitive base form, returning a new part without the concrete type properties. The reference to the original part will become invalid. (Returns a Geometry object.)
- 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.)
- Explode ()
- Explode the geometry into separate surface and edge parts. The new parts represent a snapshot of the geometry at the time it was exploded. (Returns a List of Geometry 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.)
- ReverseFaceNormals ()
- Reverse the geometry face normals.
- ReverseFaceNormals (faces List of Face)
- Reverse the geometry face normals.
- 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
- Faulty
- Indicates whether the geometry has faults.
- Type
- boolean
- Access
- Read only
- Included
- A boolean value defining if an entity is excluded or included.
- Type
- boolean
- Access
- Read/Write
- 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
- Locked
- A boolean that indicates whether the entity or it's ancestor is locked or not.
- Type
- boolean
- Access
- Read/Write
- MeshSettings
- The locally defined mesh setting to use. This property is only available if LocalMeshSettingsEnabled is true.
- Type
- MeshSettings
- Access
- Read/Write
- Parent
- The parent part of this geometry. If this is a top level part nil will be returned.
- Type
- Geometry
- Access
- Read only
- Points
- The collection of points that define the constrained surface.
- Type
- ConstrainedSurfacePointList
- Access
- Read/Write
- SimulationMeshStatus
- The status of the simulation mesh.
- Type
- SimulationMeshStatusEnum
- Access
- Read only
- SymmetryEnabled
- Use symmetry to mirror points with respect to the symmetry plane specified by SymmetryPlane.
- Type
- boolean
- Access
- Read/Write
- SymmetryPlane
- Symmetry plane orientation.
- Type
- ConstrainedSurfSymmetryPlaneEnum
- Access
- Read/Write
- Constant surface parameter at the plane of symmetry.
- Type
- ConstrainedSurfSymmetryPlaneConstParamEnum
- Access
- Read/Write
- SymmetryPlaneUValue
- U' value at symmetry plane. Only enabled if SymmetryPlaneConstantSurfaceParameter is set to U.
- Type
- ParametricExpression
- Access
- Read/Write
- SymmetryPlaneVValue
- V' value at symmetry plane. Only enabled if SymmetryPlaneConstantSurfaceParameter is set to V.
- Type
- ParametricExpression
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- Edges
- The collection of edges of the operator.
- Type
- EdgeCollection
- Faces
- The collection of faces of the operator.
- Type
- FaceCollection
- Regions
- The collection of regions of the operator.
- Type
- RegionCollection
- Transforms
- The collection of transforms on the operator.
- Wires
- The collection of wires of the operator.
- Type
- WireCollection
Method Details
- ConvertToPrimitive ()
- Convert the geometry into its primitive base form, returning a new part without the concrete type properties. The reference to the original part will become invalid.
- Return
- Geometry
- The new primitive geometry base.
- CopyAndMirror (properties table)
- Apply a copy and mirror using a table defining the properties.
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties.
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry.
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties.
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the geometry.
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- Explode ()
- Explode the geometry into separate surface and edge parts. The new parts represent a snapshot of the geometry at the time it was exploded.
- 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.
- ReverseFaceNormals ()
- Reverse the geometry face normals.
- ReverseFaceNormals (faces List of Face)
- Reverse the geometry face normals.
- 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.