`Helix`

A helix.

Example

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

    -- Create a helix with the helix's base centre at the specified 'Point'
    
helixCentre = cf.Point(0, 0, 0)
helix = project.Geometry:AddHelix(helixCentre, 0.1, 0.1, 1.0, 5.0, false)

Inheritance

The Helix object is derived from the Geometry object.

Property List

BaseRadius: The radius of the helix base (parallel to the UV plane). If DefinitionMethod is not VariableRadiusAndTurns, the base radius applies along the entire helix length. (Read/Write Expression)
BoundingBox: A box indicating the bounding box of this entity. (Read only Box)
Centre: The centre point of the helix base. (Read/Write LocalCoordinates)
DefinitionMethod: Helix definition method as specified by the HelixDefinitionMethodEnum, e.g. BaseCentre or ApertureCentre. (Read/Write HelixDefinitionMethodEnum)
EndRadius: The radius of the helix top (parallel to the UV plane). Only valid if DefinitionMethod is VariableRadiusAndTurns. (Read/Write Expression)
Faulty: Indicates whether the geometry has faults. (Read only boolean)
Height: The height of the helix, in the N axis direction. Only valid if DefinitionMethod is VariableRadiusAndTurns or ConstantRadiusAndHeight. (Read/Write Expression)
Included: Specifies whether the geometry must be included or excluded. (Read/Write boolean)
Label: The object label. (Read/Write string)
LeftHandRotationEnabled: The rotation direction of the helix. Left handed if true, else right handed. (Read/Write boolean)
LocalWorkplane: The helix workplane. (Read only LocalWorkplane)
Locked: Specifies whether the geometry must be locked to prevent modifications. (Read/Write boolean)
MeshElementCount: Get the total number of mesh elements for the geometry part. (Read only number)
Parent: The parent part of this geometry. If this is a top level part nil will be returned. (Read only Geometry)
PitchAngle: The angle (degrees) formed between the tangent of the curve and the UV plane -- constant along the length of the helix. Only valid if DefinitionMethod is ConstantRadiusAndTurns or ConstantRadiusAndHeight. (Read/Write Expression)
SimulationMeshInfo: The quality of the mesh can be examined through these properties. (Read only MeshInfo)
SimulationMeshPresent: Specifies whether the geometry has an associated simulation mesh. (Read only boolean)
Turns: The number of turns of the helix. Only valid if DefinitionMethod is VariableRadiusAndTurns or ConstantRadiusAndTurns. (Read/Write Expression)
Type: The object type string. (Read only string)
Visible: Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

Collection List

Children: The collection of child operators of the operator. (ChildOperatorCollection of Geometry.)
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. (TransformGeometryCollection 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 Geometry object.)
CopyAndRotate (origin Coordinate, rotationaxis Coordinate, angle Expression, count number): Copy and rotate the geometry. (Returns a List of Geometry object.)
CopyAndRotate (properties table, count number): Apply a copy and rotate using a table defining the properties. (Returns a List of Geometry object.)
CopyAndTranslate (from Coordinate, to Coordinate, count number): Copy and translate the geometry. (Returns a List of Geometry object.)
CopyAndTranslate (properties table, count number): Apply a copy and translate using a table defining the properties. (Returns a List of Geometry object.)
Delete (): Delete the geometry.
DeleteMesh (): Deletes the geometry's associated simulation mesh.
Duplicate (): Duplicates the geometry. (Returns a Geometry 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.)
ReEvaluate (): Re-evaluate the model by initiating the mapping algorithm. The algorithm keeps track of the individual items when the geometry is modified. Models created in earlier versions of CADFEKO versions may not contain all the mapping information. As a result some items may be marked suspect.
ReverseFaceNormals (): Reverse the geometry face normals.
ReverseFaceNormals (faces List of Face): Reverse the geometry face normals.
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.
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

BaseRadius

The radius of the helix base (parallel to the UV plane). If DefinitionMethod is not VariableRadiusAndTurns, the base radius applies along the entire helix length.

Type: Expression
Access: Read/Write

BoundingBox

A box indicating the bounding box of this entity.

Type: Box
Access: Read only

Centre

The centre point of the helix base.

Type: LocalCoordinates
Access: Read/Write

DefinitionMethod

Helix definition method as specified by the HelixDefinitionMethodEnum, e.g. BaseCentre or ApertureCentre.

Type: HelixDefinitionMethodEnum
Access: Read/Write

EndRadius

The radius of the helix top (parallel to the UV plane). Only valid if DefinitionMethod is VariableRadiusAndTurns.

Type: Expression
Access: Read/Write

Faulty

Indicates whether the geometry has faults.

Type: boolean
Access: Read only

Height

The height of the helix, in the N axis direction. Only valid if DefinitionMethod is VariableRadiusAndTurns or ConstantRadiusAndHeight.

Type: Expression
Access: Read/Write

Included

Specifies whether the geometry must be included or excluded.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

LeftHandRotationEnabled

The rotation direction of the helix. Left handed if true, else right handed.

Type: boolean
Access: Read/Write

LocalWorkplane

The helix workplane.

Type: LocalWorkplane
Access: Read only

Locked

Specifies whether the geometry must be locked to prevent modifications.

Type: boolean
Access: Read/Write

MeshElementCount

Get the total number of mesh elements for the geometry part.

Type: number
Access: Read only

Parent

The parent part of this geometry. If this is a top level part nil will be returned.

Type: Geometry
Access: Read only

PitchAngle

The angle (degrees) formed between the tangent of the curve and the UV plane -- constant along the length of the helix. Only valid if DefinitionMethod is ConstantRadiusAndTurns or ConstantRadiusAndHeight.

Type: Expression
Access: Read/Write

SimulationMeshInfo

The quality of the mesh can be examined through these properties.

Type: MeshInfo
Access: Read only

SimulationMeshPresent

Specifies whether the geometry has an associated simulation mesh.

Type: boolean
Access: Read only

Turns

The number of turns of the helix. Only valid if DefinitionMethod is VariableRadiusAndTurns or ConstantRadiusAndTurns.

Type: Expression
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

Children

The collection of child operators of the operator.

Type: ChildOperatorCollection

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.

Type: TransformGeometryCollection

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.

Input Parameters

properties(table): A table of properties defining the mirror transform.

Return

Geometry: The mirrored geometry.

CopyAndRotate (origin Coordinate, rotationaxis Coordinate, angle Expression, count number)

Copy and rotate the geometry.

Input Parameters

origin(Coordinate): The coordinates of the origin of the rotation.
rotationaxis(Coordinate): The axis of rotation.
angle(Expression): The angle of rotation (degrees).
count(number): The number of copies.

Return

List of Geometry: The list of rotated 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 Geometry: The list of rotated geometry.

CopyAndTranslate (from Coordinate, to Coordinate, count number)

Copy and translate the geometry.

Input Parameters

from(Coordinate): Translate from coordinate.
to(Coordinate): Translate to coordinate.
count(number): The number of copies.

Return

List of Geometry: The list of translated 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 Geometry: The list of translated geometry.

Delete ()

Delete the geometry.

DeleteMesh ()

Deletes the geometry's associated simulation mesh.

Duplicate ()

Duplicates the geometry.

Return

Geometry: The duplicated geometry operator.

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.

Return

List of Geometry: The list of new surface and edge parts.

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.

ReEvaluate ()

Re-evaluate the model by initiating the mapping algorithm. The algorithm keeps track of the individual items when the geometry is modified. Models created in earlier versions of CADFEKO versions may not contain all the mapping information. As a result some items may be marked suspect.

ReverseFaceNormals ()

Reverse the geometry face normals.

ReverseFaceNormals (faces List of Face)

Reverse the geometry face normals.

Input Parameters

faces(List of Face): The list of faces to reverse normal.

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.

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: The default properties table.