Line
Type of line
SubTypes
Fields Summary
- Field
- Description
- color
- Line color
- extrema
- Starting point of the line/End point of the line
- length
- Line length in meter
- mesh
- Mesh Line defining the mesh on the line
- meshReferenceLine
- Mesh imposed by another line
- nature
- Nature of the line (standard, no exist or "in air")
- region
- Region holding the line
- relaxation
- Relaxation of the mesh on the line
- visibility
- Line visibility
Methods Summary
- Method
- Description
- assignMeshLine
- Assign mesh line to lines
- assignRegion
- Assign regions to lines
- assignRelaxLine
- Assign relaxation to lines
- computeLengthLines
- Compute length of a line
- cutLineOnCurvilinearAbscissa
- Cut line on curvilinear abscissa
- cutLineOnPoint
- Cut line on point
- cutTwoLineOnInters
- Cut two lines at their intersection
- extendLineToLine
- Extend line to line
- extendLineToPoint
- Extend line to point
- extrude
- Extrude lines
- extrudeLines
- Extrude lines
- mesh
- Mesh lines
- orientMesh
- Orient mesh line for lines
- propagate
- Propagate lines
- setInvisible
- Modify line visibility
- setVisible
- Modify line visibility
Fields Details
- color
- color : Line color - [1..1] Color
- extrema
- extrema : Starting point of the line/End point of the line - [0..2] Point
- length
- length : Line length in meter - [1..1] Double
- mesh
- mesh : Mesh Line defining the mesh on the line - [0..1] MeshLine
- meshReferenceLine
- meshReferenceLine : Mesh imposed by another line - [1..1] MeshReferenceLine
- nature
- nature : Nature of the line (standard, no exist or "in air") - [0..1] Nature
- region
- region : Region holding the line - [0..1] RegionLine
- relaxation
- relaxation : Relaxation of the mesh on the line - [0..1] RelaxLine
- visibility
- visibility : Line visibility - [1..1] Visibility
Method Details
- assignMeshLine
-
-
Syntax
assignMeshLine(meshLine)
-
Parameters
- meshLine : Mesh Line to assign to Lines - [0..1] MeshLine
-
Returns
No return value
-
- assignRegion
-
-
Syntax
assignRegion(region)
-
Parameters
- region : Region Line to assign to Lines - [0..1] RegionLine
-
Returns
No return value
-
- assignRelaxLine
-
-
Syntax
assignRelaxLine(relaxLine)
-
Parameters
- relaxLine : Relaxation to assign to lines - [0..1] RelaxLine
-
Returns
No return value
-
- computeLengthLines
-
-
Syntax
result = computeLengthLines()
-
Parameters
No parameter
-
Returns
- length : length - [0..N] Double
-
- cutLineOnCurvilinearAbscissa
-
-
Syntax
cutLineOnCurvilinearAbscissa(curvilinearAbscissa)
-
Parameters
- curvilinearAbscissa : Curvilinear abscissa ]0.0;1.0[ - [1..1] Double
-
Returns
No return value
-
- cutLineOnPoint
-
-
Syntax
cutLineOnPoint(pointOnLine)
-
Parameters
- pointOnLine : Point on line to cut - [1..1] Point
-
Returns
No return value
-
- cutTwoLineOnInters
-
-
Syntax
cutTwoLineOnInters(lineForCut)
-
Parameters
- lineForCut : Second line - [1..1] Line
-
Returns
No return value
-
- extendLineToLine
- extendLineToPoint
-
-
Syntax
extendLineToPoint(pointToReach)
-
Parameters
- pointToReach : Point to reach - [1..1] Point
-
Returns
No return value
-
- extrude
-
-
Syntax
results = extrude(transformation, repetitionNumber, extrusionType, buildingOption)
-
Parameters
- transformation : Transformation for extrusion - [1..1] Transf
- repetitionNumber : Number of times to apply the transformation - [1..1] Integer
-
extrusionType : Extrusion type: Standard or Straight Forced - [1..1] Enumeration
Potential values :
- standard
- straightForced
-
buildingOption : Building options for extrusion - [1..1] Enumeration
Potential values :
- Lines
- Faces
- FacesWithMeshGenerator
-
Returns
-
- extrudeLines
-
-
Syntax
extrudeLines(transformation, repetitionNumber, extrusionType, buildingOption)
-
Parameters
- transformation : Transformation for extrusion - [1..1] Transf
- repetitionNumber : Number of times to apply the transformation - [1..1] Integer
-
extrusionType : Extrusion type: Standard or Straight Forced - [1..1] Enumeration
Potential values :
- standard
- straightForced
-
buildingOption : Building options for extrusion - [1..1] Enumeration
Potential values :
- Lines
- Faces
-
Returns
No return value
-
- mesh
-
-
Syntax
mesh()
-
Parameters
No parameter
-
Returns
No return value
-
- orientMesh
-
-
Syntax
orientMesh()
-
Parameters
No parameter
-
Returns
No return value
-
- propagate
-
-
Syntax
results = propagate(transformation, repetitionNumber)
-
Parameters
- transformation : Transformation for propagation - [1..1] Transf
- repetitionNumber : Number of times to apply the transformation - [1..1] Integer
-
Returns
-
- setInvisible
-
-
Syntax
setInvisible()
-
Parameters
No parameter
-
Returns
No return value
-
- setVisible
-
-
Syntax
setVisible()
-
Parameters
No parameter
-
Returns
No return value
-