title	Line

Line

Classes

Line

Functions

getRotationPlane(rotation_plane) ⇒

Returns rotation plane from string representation (private)

createBaseLine(no, nodes, comment, params) ⇒

Creates line (private)

Line

Kind: global class

• Line
  • new Line(no, nodes, comment, params)
  • .Polyline(no, nodes, comment, params)
  • .Arc(no, nodes, control_point, arc_parameters, center_of_arc, alpha_adjustement_target, comment, params)
  • .Circle(no, center_of_circle, circle_radius, normal_point, comment, params)
  • .EllipticalArc(no, control_point_1, control_point_2, perimeter_point, elliptical_arc_alpha, elliptical_arc_beta, comment, params)
  • .Ellipse(no, nodes, control_point, comment, params)
  • .Parabola(no, nodes, control_point, parabola_alpha, comment, params)
  • .Spline(no, nodes, comment, params)
  • .NURBS(no, nodes, control_points_by_components, nurbs_order, comment, params)
  • .RectangularPolygon(no, center_point, length, width, plane, comment, params) ⇒
  • .nPolygon(no, control_point, no_edges, radius, rotation_plane, rotation_angle, join, comment, params) ⇒
  • .Rotation(rotation_values, rotation_type)
  • .NodesOnLine(values)
  • .Supports(line_support)
  • .MeshRefinement(line_mesh_refinement)
  • .WeldedJoints(values)

new Line(no, nodes, comment, params)

Creates line

Returns: Created line

Param	Type	Description
no	Number	Index of line, can be undefined
nodes	Array	List of Node indexes
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

line.Polyline(no, nodes, comment, params)

Creates polyline

Kind: instance method of Line

Param	Type	Description
no	Number	Index of line, can be undefined
nodes	Array	List of Node indexes
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

Example

// returns polyline
var line = new line();
line.Polyline(1, [1,2]);

line.Arc(no, nodes, control_point, arc_parameters, center_of_arc, alpha_adjustement_target, comment, params)

Creates arc line

Kind: instance method of Line

Param	Type	Description
no	Number	Index of line, can be undefined
nodes	Array	List of Node indexes
control_point	Array	Control point of arc
arc_parameters	Array	Arc's parameters, can be undefined (only one of three parameter can be set, when arc parameter is set, other parameters (control point) will be recalculated)
center_of_arc	Array	Center of arc, can be undefined (when center of is set, control point will be recalculated)
alpha_adjustement_target	Number	Subsequent adjustment of α by displacing node at: 1 - Beginning of arc 2 - Arc control point 3 - End of arc
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

line.Circle(no, center_of_circle, circle_radius, normal_point, comment, params)

Creates circle line

Kind: instance method of Line

Param	Type	Description
no	Number	Index of line, can be undefined
center_of_circle	Array	Center point of circle
circle_radius	Number	Radius of circle, can be undefined
normal_point	Array	Point of normal ti circle plane, can be undefined
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

line.EllipticalArc(no, control_point_1, control_point_2, perimeter_point, elliptical_arc_alpha, elliptical_arc_beta, comment, params)

Creates elliptical arc line

Kind: instance method of Line

Param	Type	Description
no	Number	Index of line, can be undefined
control_point_1	Array	First control point
control_point_2	Array	Second control point
perimeter_point	Array	Third control point - perimeter
elliptical_arc_alpha	Number	Arc angle α, can be undefined
elliptical_arc_beta	Number	Arc angle β, can be undefined
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

line.Ellipse(no, nodes, control_point, comment, params)

Creates ellipse line

Kind: instance method of Line

Param	Type	Description
no	Number	Index of line, can be undefined
nodes	Array	Nodes of ellipse
control_point	Array	Control point
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

line.Parabola(no, nodes, control_point, parabola_alpha, comment, params)

Creates parabola line

Kind: instance method of Line

Param	Type	Description
no	Number	Index of line, can be undefined
nodes	Array	Nodes of parabola
control_point	Array	Control point
parabola_alpha	Number	Parabola's parameter α
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

line.Spline(no, nodes, comment, params)

Creates spline

Kind: instance method of Line

Param	Type	Description
no	Number	Index of line, can be undefined
nodes	Array	Nodes of spline
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

line.NURBS(no, nodes, control_points_by_components, nurbs_order, comment, params)

Creates NURBS line

Kind: instance method of Line

Param	Type	Description
no	Number	Index of line, can be undefined
nodes	Array	Nodes of NURBS
control_points_by_components	Array	Control points
nurbs_order	Number	Nurbs order, can be undefined
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined

line.RectangularPolygon(no, center_point, length, width, plane, comment, params) ⇒

Create rectangular polygon

Kind: instance method of Line
Returns: Created rectangular polygon

Param	Type	Description
no	int	Number of the line, can be undefined
center_point	array	Center point by format
length	number	Length
width	number	Width
plane	string	Plane XY, XZ or YZ, can be undefined
comment	string	Comment for the line, can be undefined
params	Object	Parameters of the line, can be undefined

line.nPolygon(no, control_point, no_edges, radius, rotation_plane, rotation_angle, join, comment, params) ⇒

Creates nPolygon

Kind: instance method of Line
Returns: Created nPolygon

Param	Type	Description
no	int	Number of the line, can be undefined
control_point	array	Control point by format [x, y, z]
no_edges	number	Number of edges
radius	number	Radius
rotation_plane	string	Rotation plane (x-y, x-z), can be undefined (x-y by default)
rotation_angle	number	Rotation angle
join	string	Join in one "true" or in separate lines "false"
comment	string	Comment for the line, can be undefined
params	Object	Parameters of the line, can be undefined

line.Rotation(rotation_values, rotation_type)

Sets line rotation

Kind: instance method of Line

Param	Type	Description
rotation_values	Number	Rotation values depends on rotation type: 1 - [β] 2 - [help_node_index, rotation_plane ("x-y"
rotation_type	Number	Line rotation via: Angle (1), Help node (2), Inside (non-straight line) (3)

line.NodesOnLine(values)

Sets nodes on line

Kind: instance method of Line

Param	Type	Description
values	Array	Nodes on line values in format [[node_1, reference_1, from_start_1, from_end1_1] ... [node_n, reference_n, from_start_n, from_end_1]]

line.Supports(line_support)

Sets line supports

Kind: instance method of Line

Param	Type	Description
line_support	Number	Line supports object id

line.MeshRefinement(line_mesh_refinement)

Sets line mesh refinement

Kind: instance method of Line

Param	Type	Description
line_mesh_refinement	Array	Line mesh refinement object id

line.WeldedJoints(values)

Sets line welded joints

Kind: instance method of Line

Param	Type	Description
values	Array	Line welded joints values, [[weld1, surface1,1, surface2,1, surface3,1] ... [weldn, surface1n, surface2n, surface3n]]

getRotationPlane(rotation_plane) ⇒

Returns rotation plane from string representation (private)

Kind: global function
Returns: Rotation plane

Param	Type	Description
rotation_plane	String	Rotation plane (x-y, x-z)

createBaseLine(no, nodes, comment, params) ⇒

Creates line (private)

Kind: global function
Returns: Created line

Param	Type	Description
no	Number	Index of line, can be undefined
nodes	Array	List of Node indexes
comment	String	Comment, can be undefined
params	Object	Line's parameters, can be undefined