Renga STDL

https://help.rengabim.com/stdl/en/
Admin
Renga STDL is a Lua-based language for creating style templates in Renga, allowing users to define...
Tokens:69,234
Snippets:361
Trust Score:9.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### Create Evolution Solid

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Builds an evolution solid by moving a generating curve (profile) along a guide curve (path). Requires the profile curve, its placement in the XY plane, the guide path, and optional evolution parameters.

```lua
Solid Evolve(Curve2D _profile_, Placement3D _placement_, Curve3D _path_, EvolutionParameters _oParameters_)
```

```lua
local profile = CreateCircle2D(Point2D(0, 0), 25)
local placement = Placement3D(Point3D(0, 0, 0), Vector3D(0, 0, 1), Vector3D(1, 0, 0))
local path = CreateCompositeCurve3D{CreateLineSegment3D(Point3D(0, 0, 0), Point3D(0, 0, 400)),
CreateArc3DByThreePoints(Point3D(0, 0, 400), Point3D(250, 0, 650), Point3D(500, 0, 400))}
parameter = EvolutionParameters()
parameter.OutwardOffset = 10
solid = Evolve(profile, placement, path, parameter):ShowTangentEdges(false)
```

--------------------------------

### Add Rebar Set Example

Source: https://help.rengabim.com/stdl/en/reinforcement

Demonstrates how to add a set of rebars using the Style.AddRebarSet function. This function requires a rebar style ID, a curve defining the rebar's path, a vector, and the step and count for the rebar set.

```example
Style.AddRebarSet(rebarStyleId, CreateLineSegment3D(Point3D(-500, 0, 0),
Point3D(500, 0, 0)),
Vector3D(1, 0, 0), 200, 5)
```

--------------------------------

### RstBuilder.exe Example with Module Inclusion

Source: https://help.rengabim.com/stdl/en/style_template_building

Illustrates how to use the `-i` or `--include` option to specify multiple Lua modules required by the script when building a style template.

```bash
RstBuilder.exe configuration.json run.lua -s 1.0 -o category.rst -i C:\Modules\mod1.lua -i C:\Modules\mod2.lua
```

--------------------------------

### Evolve

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Creates an evolution solid by moving a profile curve along a guide curve.

```APIDOC
## POST /api/solids/evolve

### Description
Creates an evolution solid. The evolution solid is built by moving the generating curve along the guide curve.

### Method
POST

### Endpoint
/api/solids/evolve

### Parameters
#### Request Body
- **profile** (Curve2D) - Required - The generatrix curve.
- **placement** (Placement3D) - Required - The coordinate system in the XY plane of which the profile is located.
- **path** (Curve3D) - Required - The guide curve.
- **oParameters** (EvolutionParameters) - Optional - Evolution operation parameters.

### Request Example
```json
{
  "profile": {
    "type": "Circle2D",
    "center": {"x": 0, "y": 0},
    "radius": 25
  },
  "placement": {
    "origin": {"x": 0, "y": 0, "z": 0},
    "xAxis": {"x": 0, "y": 0, "z": 1},
    "zAxis": {"x": 1, "y": 0, "z": 0}
  },
  "path": {
    "type": "CompositeCurve3D",
    "curves": [
      {
        "type": "LineSegment3D",
        "startPoint": {"x": 0, "y": 0, "z": 0},
        "endPoint": {"x": 0, "y": 0, "z": 400}
      }
    ]
  },
  "oParameters": {
    "OutwardOffset": 10
  }
}
```

### Response
#### Success Response (200)
- **solidId** (string) - The unique identifier for the created solid.

#### Response Example
```json
{
  "solidId": "evolve_44556"
}
```
```

--------------------------------

### JSON Example: User Enumeration Parameter

Source: https://help.rengabim.com/stdl/en/reinforcement

Provides an example of a JSON structure for a user-defined enumeration parameter within Renga STDL style templates. It includes the parameter's name, text, type, and a list of selectable items.

```json
{
  "name": "UserEnumParameter",
  "text": "User Defined Option",
  "type": "UserEnum",
  "items": [
    {
      "key": "Item1",
      "text": "Item 1"
    },
    {
      "key": "Item2",
      "text": "Item 2"
    },
    {
      "key": "Item3",
      "text": "Item 3"
    }
  ]
}
```

--------------------------------

### Create Swept Disk Solid

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Constructs a swept disk solid by moving a circular disk along a 3D curve. Parameters include the disk's radius, an optional inner radius for a central hole, and the guiding 3D curve.

```lua
Solid CreateSweptDiskSolid(number _radius_, number _innerRadius_, Curve3D _path_)
```

--------------------------------

### Set Insulation Skeleton (Renga STDL)

Source: https://help.rengabim.com/stdl/en/namespace_style

The `SetInsulationSkeleton` function allows for the definition of an insulation structure for an object. It takes a table of parts, where each part is defined by 2D section curves, 3D placement, a guide curve, and cap types. This is used for creating complex insulation geometries.

```lua
local spine1 = CreateLineSegment3D(Point3D(0, 0, 0), Point3D(100, 0, 0))
local spine2 = CreateLineSegment3D(Point3D(0, 0, 0), Point3D(0, 100, 0))
local contour = CreateRectangle2D(Point2D(100, 100), 0, 100, 50)
local placement1 = Placement3D(Point3D(0, 0, 0), Vector3D(-1, 0, 0), Vector3D(0, 0, -1))
local placement2 = Placement3D(Point3D(0, 0, 0), Vector3D(0, 1, 0), Vector3D(0, 0, -1))
Style.SetInsulationSkeleton({
  {{contour}, {placement1}, spine1, InsulationCapType.None, InsulationCapType.Flat},
  {{contour}, {placement2}, spine2, InsulationCapType.Flat}
})
```

--------------------------------

### Lua Script: Get Parameter Value Example

Source: https://help.rengabim.com/stdl/en/reinforcement

Demonstrates how to retrieve parameter values within a Lua script using the `Style.GetParameterValues()` function in Renga STDL. It accesses a specific parameter ('Width') from a group ('Dimensions').

```lua
local parameters = Style.GetParameterValues()
print(parameters.Dimensions.Width)
```

--------------------------------

### Lua Script: Get Rebar Style and Diameter Example

Source: https://help.rengabim.com/stdl/en/reinforcement

Illustrates how to fetch a rebar style by its ID using `Project.GetRebarStyle()`, cast it to a parameter container, and then retrieve specific style parameters like 'RebarDiameter' in Renga STDL.

```lua
local style = Project.GetRebarStyle(rebarStyleId)
local parameters = CastToParameterContainer(style)
print(parameters:GetParameterValues().RebarDiameter)
```

--------------------------------

### RstBuilder.exe Options and Descriptions

Source: https://help.rengabim.com/stdl/en/style_template_building

Lists and describes the available command-line options for RstBuilder.exe, including help, version, configuration file path, Lua script path, STDL version, output file path, and include paths for additional modules.

```markdown
| Option | Description |
|---|---|
| `-h`, `--help` | Display the utility help. |
| `-v`, `--version` | Display the utility version information. |
| `--configuration path_to_configuration_file` | Specify the location of the file in JSON format. |
| `--executable_lua path_to_executable_lua_file` | Specify the location of the Lua-script file. |
| `-s stdl_version`, `--stdlversion stdl_version` | Set the STDL version. |
| `-o path_to_output_file`, `--output path_to_output_file` | Specify the location of the created category file in RST format. |
| `-i path_to_include_lua_file`, `--include path_to_include_lua_file` | Specify the location of additional Lua scripts and modules. |
```

--------------------------------

### RstBuilder.exe Command Line Usage

Source: https://help.rengabim.com/stdl/en/style_template_building

Demonstrates the basic command-line format for RstBuilder.exe, specifying configuration, Lua script, and optional parameters like STDL version and output file.

```bash
RstBuilder.exe [configuration] [executable_lua] [options]
RstBuilder.exe configuration.json run.lua -s 1.0 -i library.lua
RstBuilder.exe --executable_lua C:\Project\run.lua --configuration C:\Project\configuration.json --stdlVersion 1.0 --output C:\Project\category.rst
```

--------------------------------

### Create Arc 2D - Renga STDL API

Source: https://help.rengabim.com/stdl/en/struct_rectangular_profile

Provides examples of creating 2D arcs using different methods within the Renga STDL API. These include creating arcs by center, start, and end points, or by three points.

```Renga STDL
CreateArc2DByCenterStartEndPoints
CreateArc2DByThreePoints
```

--------------------------------

### Create Lofted Solid from Profiles and Placements

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Creates a lofted solid by sweeping along a series of profile curves defined by their positions and orientations. The number of profiles must match the number of placements. Optional parameters can control the lofting behavior.

```lua
local profiles = {CreateRectangle2D(Point2D(0, 0), 0, 100, 200),
CreateCircle2D(Point2D(0, 0), 300)}
local placements = {Placement3D(Point3D(0, 0, 0), Vector3D(0, 0, 1), Vector3D(1, 0, 0)),
Placement3D(Point3D(1000, 0, 1000), Vector3D(1, 0, 0), Vector3D(0, 0, 1))}
parameters = LoftParameters()
parameters.GuideCurve = CreateArc3DByCenterStartEndPoints(Point3D(1000, 0, 0), Point3D(0, 0, 0), Point3D(1000, 0, 1000))
solid = Loft(profiles, placements, parameters)
```

--------------------------------

### Get Parameter Values and Declare Variables (Lua)

Source: https://help.rengabim.com/stdl/en/gas_stove

This Lua script retrieves parameter values set by the user in the Renga object style editor and declares corresponding local variables. It accesses parameters nested under 'Dimensions' and assigns them to variables like 'width', 'depth', and 'height'.

```lua
local parameters = Style.GetParameterValues()
local width = parameters.Dimensions.Width
local depth = parameters.Dimensions.Depth
local height = parameters.Dimensions.Height
```

--------------------------------

### Create Arc by Center, Start, and End Points

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Creates a circular arc defined by its center, start point, and end point. The direction of the arc can be specified as clockwise or counter-clockwise.

```APIDOC
## POST /websites/help_rengabim_stdl_en/CreateArc3DByCenterStartEndPoints

### Description
Creates a circular arc by center, start and end points.

### Method
POST

### Endpoint
/websites/help_rengabim_stdl_en/CreateArc3DByCenterStartEndPoints

### Parameters
#### Request Body
- **centerPoint** (Point3D) - Required - The center of the arc.
- **startPoint** (Point3D) - Required - The start point of the arc. It defines the radius.
- **endPoint** (Point3D) - Required - The end point of the arc.
- **clockwise** (boolean) - Required - The direction of the arc. If it is true, then the direction is clockwise, if viewed against of the vector product of the vectors (startPoint - centerPoint) and (endPoint - centerPoint).

### Request Example
```json
{
  "centerPoint": {"x": 0, "y": 0, "z": 0},
  "startPoint": {"x": 1, "y": 0, "z": 0},
  "endPoint": {"x": 0, "y": 1, "z": 0},
  "clockwise": true
}
```

### Response
#### Success Response (200)
- **curve3D** (Curve3D) - The created 3D circular arc.

#### Response Example
```json
{
  "curve3D": {"type": "Arc3D", "center": {"x": 0, "y": 0, "z": 0}, "startPoint": {"x": 1, "y": 0, "z": 0}, "endPoint": {"x": 0, "y": 1, "z": 0}, "clockwise": true}
}
```
```

--------------------------------

### Placement3D API

Source: https://help.rengabim.com/stdl/en/class_placement3_d-members

This section details the methods and constructors available for the Placement3D object within the Renga STDL Style Template API, used for defining and manipulating 3D object placements.

```APIDOC
## Placement3D API

### Description
Provides methods for manipulating and querying the placement of 3D objects, including transformations like rotation, scaling, and shifting, as well as retrieving orientation information.

### Methods

#### Clone()
- **Description**: Creates a deep copy of the Placement3D object.
- **Returns**: Placement3D - A new Placement3D object that is a copy of the original.

#### GetMatrix()
- **Description**: Retrieves the transformation matrix associated with the placement.
- **Returns**: Matrix3D - The Matrix3D representing the placement.

#### GetOrigin()
- **Description**: Gets the origin point of the placement.
- **Returns**: Point3D - The Point3D representing the origin.

#### GetXAxis()
- **Description**: Gets the X-axis vector of the placement.
- **Returns**: Vector3D - The Vector3D representing the X-axis.

#### GetXAxisDirection()
- **Description**: Gets the direction vector of the X-axis.
- **Returns**: Vector3D - The Vector3D representing the X-axis direction.

#### GetYAxis()
- **Description**: Gets the Y-axis vector of the placement.
- **Returns**: Vector3D - The Vector3D representing the Y-axis.

#### GetYAxisDirection()
- **Description**: Gets the direction vector of the Y-axis.
- **Returns**: Vector3D - The Vector3D representing the Y-axis direction.

#### GetZAxis()
- **Description**: Gets the Z-axis vector of the placement.
- **Returns**: Vector3D - The Vector3D representing the Z-axis.

#### GetZAxisDirection()
- **Description**: Gets the direction vector of the Z-axis.
- **Returns**: Vector3D - The Vector3D representing the Z-axis direction.

#### operator==(Placement3D other)
- **Description**: Compares two Placement3D objects for equality.
- **Parameters**:
  - **other** (Placement3D) - The Placement3D object to compare with.
- **Returns**: boolean - True if the placements are equal, false otherwise.

#### operator!=(Placement3D other)
- **Description**: Compares two Placement3D objects for inequality.
- **Parameters**:
  - **other** (Placement3D) - The Placement3D object to compare with.
- **Returns**: boolean - True if the placements are not equal, false otherwise.

#### Rotate(Axis3D axis, number angle)
- **Description**: Rotates the placement around a specified axis by a given angle.
- **Parameters**:
  - **axis** (Axis3D) - The axis of rotation.
  - **angle** (number) - The angle of rotation in degrees.
- **Returns**: Placement3D - The rotated Placement3D object.

#### Scale(Point3D fixedPoint, number xScale, number yScale, number zScale)
- **Description**: Scales the placement relative to a fixed point.
- **Parameters**:
  - **fixedPoint** (Point3D) - The point to scale from.
  - **xScale** (number) - The scaling factor along the X-axis.
  - **yScale** (number) - The scaling factor along the Y-axis.
  - **zScale** (number) - The scaling factor along the Z-axis.
- **Returns**: Placement3D - The scaled Placement3D object.

#### Shift(number x, number y, number z)
- **Description**: Translates the placement by the specified offsets.
- **Parameters**:
  - **x** (number) - The offset along the X-axis.
  - **y** (number) - The offset along the Y-axis.
  - **z** (number) - The offset along the Z-axis.
- **Returns**: Placement3D - The shifted Placement3D object.

#### Transform(Matrix3D matrix)
- **Description**: Applies a transformation matrix to the placement.
- **Parameters**:
  - **matrix** (Matrix3D) - The transformation matrix to apply.
- **Returns**: Placement3D - The transformed Placement3D object.

### Constructors

#### Placement3D(Point3D point, Vector3D zAxisDirection, Vector3D xAxisDirection)
- **Description**: Creates a new Placement3D object with the specified origin and axis directions.
- **Parameters**:
  - **point** (Point3D) - The origin point of the placement.
  - **zAxisDirection** (Vector3D) - The direction vector for the Z-axis.
  - **xAxisDirection** (Vector3D) - The direction vector for the X-axis.
- **Returns**: Placement3D - The newly created Placement3D object.
```

--------------------------------

### Curve2D Rotation Example in Renga STDL

Source: https://help.rengabim.com/stdl/en/class_curve2_d

Provides a specific example of rotating a curve around a given point by a specified angle. The angle is expected in radians, and the point defines the center of rotation.

```Renga STDL
self.Rotate(point, angle)
```

--------------------------------

### Solid Object Methods

Source: https://help.rengabim.com/stdl/en/class_solid-members

This section details the methods available for the Solid object in the Renga STDL Style Template API, including transformations and display options.

```APIDOC
## Solid Object Methods

### Description
Provides methods for manipulating and displaying Solid objects within the Renga STDL environment.

### Method
N/A (These are object methods, not direct API endpoints)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A (These are object methods, not API calls)

#### Response Example
N/A

### Available Methods:

- **Clone()**: Creates a copy of the Solid object.
- **operator==(Solid other)**: Compares two Solid objects for equality.
- **operator~=(Solid other)**: Compares two Solid objects for inequality.
- **Rotate(Axis3D axis, number angle)**: Rotates the Solid object around a specified axis by a given angle.
- **Scale(Point3D fixedPoint, number xScale, number yScale, number zScale)**: Scales the Solid object from a fixed point with specified scaling factors for each axis.
- **Shift(number dx, number dy, number dz)**: Translates the Solid object by specified distances along the X, Y, and Z axes.
- **ShowTangentEdges(boolean show)**: Controls the visibility of tangent edges for the Solid object.
- **Transform(Matrix3D matrix)**: Applies a 3D transformation matrix to the Solid object.
```

--------------------------------

### FillArea Constructor and Methods (Renga STDL API)

Source: https://help.rengabim.com/stdl/en/class_fill_area-members

Demonstrates the constructors and various methods available for the FillArea object in the Renga STDL API. This includes creating FillArea objects with outer and inner boundaries, retrieving boundaries, and performing transformations like rotation, scaling, and shifting.

```Renga STDL API
FillArea()
FillArea(Curve2D outerBoundary, table oInnerBoundaries)
GetInnerBoundaries()
GetOuterBoundary()
operator==(FillArea other)
operator~=(FillArea other)
Rotate(Point2D point, number angle)
Scale(Point2D point, number xScale, number yScale)
Shift(number x, number y)
Transform(Matrix2D matrix)
```

--------------------------------

### Renga STDL Style Template API - Overview

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

This section provides an overview of the Renga STDL Style Template API, detailing its capabilities for 2D and 3D modeling, and interaction with the Renga project.

```APIDOC
## Renga STDL Style Template API

### Description
The Renga STDL Style Template API allows developers to programmatically create, manipulate, and interact with style templates within the Renga project. It supports operations related to 2D and 3D modeling, as well as project interactions.

### Topics Covered
- 2D Modeling
- 3D Modeling
- Interacting with the Renga project
```

--------------------------------

### Create 3D Line Segment

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Creates a 3D line segment defined by its start and end points.

```APIDOC
## POST /websites/help_rengabim_stdl_en/CreateLineSegment3D

### Description
Creates line segment.

### Method
POST

### Endpoint
/websites/help_rengabim_stdl_en/CreateLineSegment3D

### Parameters
#### Request Body
- **startPoint** (Point3D) - Required - The start point of the segment.
- **endPoint** (Point3D) - Required - The end point of the segment.

### Request Example
```json
{
  "startPoint": {"x": 0, "y": 0, "z": 0},
  "endPoint": {"x": 1, "y": 1, "z": 1}
}
```

### Response
#### Success Response (200)
- **curve3D** (Curve3D) - The created 3D line segment.

#### Response Example
```json
{
  "curve3D": {"type": "LineSegment3D", "startPoint": {"x": 0, "y": 0, "z": 0}, "endPoint": {"x": 1, "y": 1, "z": 1}}
}
```
```

--------------------------------

### Create Arc by Three Points

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Creates a circular arc that passes through a start point, an intermediate point, and an end point.

```APIDOC
## POST /websites/help_rengabim_stdl_en/CreateArc3DByThreePoints

### Description
Creates circular arc from startPoint to endPoint through intermediatePoint.

### Method
POST

### Endpoint
/websites/help_rengabim_stdl_en/CreateArc3DByThreePoints

### Parameters
#### Request Body
- **startPoint** (Point3D) - Required - The start point of the arc.
- **intermediatePoint** (Point3D) - Required - The point lying on the arc.
- **endPoint** (Point3D) - Required - The end point of the arc.

### Request Example
```json
{
  "startPoint": {"x": 1, "y": 0, "z": 0},
  "intermediatePoint": {"x": 0, "y": 1, "z": 0},
  "endPoint": {"x": -1, "y": 0, "z": 0}
}
```

### Response
#### Success Response (200)
- **curve3D** (Curve3D) - The created 3D circular arc.

#### Response Example
```json
{
  "curve3D": {"type": "Arc3D", "startPoint": {"x": 1, "y": 0, "z": 0}, "intermediatePoint": {"x": 0, "y": 1, "z": 0}, "endPoint": {"x": -1, "y": 0, "z": 0}}
}
```
```

--------------------------------

### Renga STDL Style Template API - Interacting with the Renga Project

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Information on how to interact with the Renga project using the Style Template API.

```APIDOC
## Interacting with the Renga Project via Style Template API

### Description
This section outlines the methods provided by the Renga STDL Style Template API to interact with the broader Renga project environment. This includes accessing project data, applying templates, and managing project elements.

### Key Functionalities
- Accessing project settings and parameters.
- Applying created style templates to project elements.
- Querying existing elements within the Renga project.
- Managing namespaces and definitions.
```

--------------------------------

### Create Elliptical Arc

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Creates an elliptical arc defined by its center, normal, major vector, radii, start and end points, and direction.

```APIDOC
## POST /websites/help_rengabim_stdl_en/CreateEllipticalArc3D

### Description
Creates elliptical arc.

### Method
POST

### Endpoint
/websites/help_rengabim_stdl_en/CreateEllipticalArc3D

### Parameters
#### Request Body
- **center** (Point3D) - Required - The center of the ellipse.
- **normal** (Vector3D) - Required - The vector orthogonal to the plane of the ellipse.
- **majorVector** (Vector3D) - Required - The vector co-directed with the first semi-axis. The second semi-axis is co-directed with the vector product normal*majorVector.
- **majorRadius** (number) - Required - The value of the first semi-axis.
- **minorRadius** (number) - Required - The value of the second semi-axis.
- **startPoint** (Point3D) - Required - The start point of the arc.
- **endPoint** (Point3D) - Required - The end point of the arc.
- **clockwise** (boolean) - Required - The arc direction. If equal to true, the arc directs clockwise if viewed against vector 'normal'.

### Request Example
```json
{
  "center": {"x": 0, "y": 0, "z": 0},
  "normal": {"x": 0, "y": 0, "z": 1},
  "majorVector": {"x": 1, "y": 0, "z": 0},
  "majorRadius": 5,
  "minorRadius": 3,
  "startPoint": {"x": 5, "y": 0, "z": 0},
  "endPoint": {"x": 0, "y": 3, "z": 0},
  "clockwise": false
}
```

### Response
#### Success Response (200)
- **curve3D** (Curve3D) - The created 3D elliptical arc.

#### Response Example
```json
{
  "curve3D": {"type": "EllipticalArc3D", "center": {"x": 0, "y": 0, "z": 0}, "normal": {"x": 0, "y": 0, "z": 1}, "majorVector": {"x": 1, "y": 0, "z": 0}, "majorRadius": 5, "minorRadius": 3, "startPoint": {"x": 5, "y": 0, "z": 0}, "endPoint": {"x": 0, "y": 3, "z": 0}, "clockwise": false}
}
```
```

--------------------------------

### Create Composite Curve

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Creates a composite curve by joining a sequence of curves. The end point of each curve must match the start point of the next curve.

```APIDOC
## POST /websites/help_rengabim_stdl_en/CreateCompositeCurve3D

### Description
Creates a composite curve. The start point of every curve should be equal to the end point of previous one.

### Method
POST

### Endpoint
/websites/help_rengabim_stdl_en/CreateCompositeCurve3D

### Parameters
#### Request Body
- **curves** (table of Curve3D) - Required - A set of curves (`Curve3D`).

### Request Example
```json
{
  "curves": [
    {"type": "LineSegment3D", "startPoint": {"x": 0, "y": 0, "z": 0}, "endPoint": {"x": 1, "y": 0, "z": 0}},
    {"type": "Arc3D", "center": {"x": 1, "y": 0, "z": 0}, "startPoint": {"x": 1, "y": 0, "z": 0}, "endPoint": {"x": 1, "y": 1, "z": 0}, "clockwise": false}
  ]
}
```

### Response
#### Success Response (200)
- **curve3D** (Curve3D) - The created composite 3D curve.

#### Response Example
```json
{
  "curve3D": {"type": "CompositeCurve3D", "curves": [...]}
}
```
```

--------------------------------

### Point2D API

Source: https://help.rengabim.com/stdl/en/class_point2_d

Documentation for the Point2D class, including its constructor, methods for manipulation (Shift, Rotate, Scale, Transform), and property accessors (GetX, GetY).

```APIDOC
## Class Point2D

### Description
Two-dimensional point.

### Constructor
**Point2D** (number x, number y)

Initializes a new instance of the Point2D class.

### Methods

#### Shift
**Shift** (number x, number y)

Shifts the point by the specified values along the coordinate axes.

**Parameters**
- **x** (number) - The value to shift along the x-axis.
- **y** (number) - The value to shift along the y-axis.

#### Rotate
**Rotate** (Point2D point, number angle)

Rotates the point.

**Parameters**
- **point** (Point2D) - Center of rotation.
- **angle** (number) - The angle in radians.

#### Scale
**Scale** (Point2D fixedPoint, number xScale, number yScale)

Scales the point.

**Parameters**
- **fixedPoint** (Point2D) - Fixed point.
- **xScale** (number) - X scale coefficient.
- **yScale** (number) - Y scale coefficient.

#### Transform
**Transform** (Matrix2D matrix)

Transforms according to the matrix.

**Parameters**
- **matrix** (Matrix2D) - The transformation matrix.

#### Clone
**Clone** ()

Returns a copy of the object.

#### GetX
**GetX** ()

Returns the x-coordinate of the point.

#### GetY
**GetY** ()

Returns the y-coordinate of the point.

#### operator==
**operator==** (Point2D other)

Checks for equality.

**Parameters**
- **other** (Point2D) - The point to compare with.

#### operator~=
**operator~=** (Point2D other)

Checks for inequality.

**Parameters**
- **other** (Point2D) - The point to compare with.
```

--------------------------------

### Create Composite Curve (Lua)

Source: https://help.rengabim.com/stdl/en/group___two-dimensional

Creates a composite curve by joining a sequence of other curves. The end point of each curve must match the start point of the next curve in the sequence.

```lua
CreateCompositeCurve2D(curves)
```

--------------------------------

### Configure Ports with Style.GetPort() and SetPlacement/SetPipeParameters

Source: https://help.rengabim.com/stdl/en/engineering_system_object

Manages port configurations, including position, anchor, and connection parameters. It involves retrieving a port by name and then setting its placement using Placement3D or its pipe parameters using connection type and diameter.

```lua
local height = Style.GetParameter("Dimensions", "Height"):GetValue()
local coldWaterOrigin = Point3D(0, 0, height)
local portPlacement = Placement3D(coldWaterOrigin, Vector3D(0, 1, 0), Vector3D(1, 0, 0))
Style.GetPort("PortName"):SetPlacement(portPlacement)
local connectionType = Style.GetParameter("Port", "ConnectionType"):GetValue()
local diameter = Style.GetParameter("Port", "Diameter"):GetValue())
Style.GetPort("PortName"):SetPipeParameters(connectionType, diameter)
```

--------------------------------

### Create Right Prism Solid

Source: https://help.rengabim.com/stdl/en/group___three-dimensional

Creates a right prism with its base on the XY-plane and axis along the Z-axis. Requires a list of 2D points defining the base edges and the prism's height. An optional placement can be provided.

```lua
Solid CreateRightPrism(table _points_, number _height_, Placement3D _oPlacement_)
```

--------------------------------

### Create Arc from Three Points (Lua)

Source: https://help.rengabim.com/stdl/en/group___two-dimensional

Creates a circular arc defined by a start point, an intermediate point, and an end point. The intermediate point must lie on the arc.

```lua
CreateArc2DByThreePoints(startPoint, intermediatePoint, endPoint)
```

--------------------------------

### Symbolic Expression Syntax and Limitations

Source: https://help.rengabim.com/stdl/en/expressions

Details on how to construct symbolic expressions, including supported operations, functions, constants, and limitations within Renga STDL.

```APIDOC
## Symbolic Expressions in Renga STDL

### Description
This section describes the syntax for creating symbolic expressions in Renga STDL, including supported mathematical operations, functions, and constants. It also outlines the limitations that must be considered when defining these expressions.

### Supported Operations
- `+`: addition
- `-`: subtraction
- `*`: multiplication
- `/`: division
- `^`: exponentiation
- `-`: unary minus

### Supported Mathematical Functions
- `sin(radians)`: sine
- `cos(radians)`: cosine
- `tan(radians)`: tangent
- `sind(degrees)`: sine
- `cosd(degrees)`: cosine
- `tand(degrees)`: tangent
- `asin(value)`: arcsine (result in radians)
- `acos(value)`: arccosine (result in radians)
- `atan(value)`: arctangent (result in radians)
- `asind(value)`: arcsine (result in degrees)
- `acosd(value)`: arccosine (result in degrees)
- `atand(value)`: arctangent (result in degrees)
- `sqrt(value)`: square root
- `exp(value)`: exponential
- `ln(value)`: natural logarithm
- `lg(value)`: decimal logarithm
- `deg(radians)`: convert radians to degrees
- `rad(degrees)`: convert degrees to radians
- `abs(value)`: absolute value

### Supported Constants
- `M_PI`: π
- `M_PI_2`: π / 2
- `M_PI_4`: π / 4
- `M_SQRT2`: √2
- `M_E`: e (base of natural logarithm)
- `M_PHI`: φ (golden ratio)
- `M_RADDEG`: 180 / π
- `M_DEGRAD`: π / 180

### Limitations
- Maximum variable length: 512 characters.
- Maximum expression length: 2048 characters.
- Integrate, differentiate, and limit operations are not supported.
- Simplifying mathematical expressions (e.g., reducing fractions) is not supported.

**Note:** Due to these limitations, analytical calculations for complex expressions might be inaccurate (e.g., calculating `sin(t)/t` at zero).
```

--------------------------------

### Style Parameter Group API

Source: https://help.rengabim.com/stdl/en/class_parameter_group

Provides methods to manage parameter groups within Renga STDL style templates, including getting parameters, setting visibility, and setting enabled state.

```APIDOC
## Style Parameter Group API

### Description
This section details the API for managing style parameter groups. It includes functions to retrieve specific parameters by name, and to control the visibility and editability of the entire parameter group within the object style editor.

### Method
Various (specific methods detailed below)

### Endpoint
N/A (These are likely class methods or functions within the Renga STDL environment)

### Parameters
#### GetParameter
- **parameterName** (string) - Required - The name of the parameter to retrieve.

#### SetVisible
- **isVisible** (boolean) - Required - `true` to make the group visible, `false` to hide it.

#### SetEnabled
- **isEnabled** (boolean) - Required - `true` to enable editing of the group, `false` to disable it.

### Request Example
```json
{
  "getParameter": {
    "parameterName": "ExampleParameterName"
  }
}
```

```json
{
  "setVisible": {
    "isVisible": true
  }
}
```

```json
{
  "setEnabled": {
    "isEnabled": false
  }
}
```

### Response
#### Success Response (200)
- **GetParameter**: Returns a parameter object if found, otherwise nil.
- **SetVisible**: Returns nil upon successful execution.
- **SetEnabled**: Returns nil upon successful execution.

#### Response Example
```json
{
  "getParameter": {
    "type": "string",
    "value": "SomeValue"
  }
}
```

```json
{
  "setVisible": null
}
```

```json
{
  "setEnabled": null
}
```
```

--------------------------------

### Point3D API

Source: https://help.rengabim.com/stdl/en/class_point3_d

Documentation for the Point3D class, including its constructor and member functions for manipulation and information retrieval.

```APIDOC
## Class Point3D

### Description
Three-dimensional point.

### Constructor
**Point3D** (number x, number y, number z)

Constructor for creating a new Point3D object.

### Member Functions

#### Shift
**Shift** (number x, number y, number z)

Shifts the point by the specified values along the coordinate axes.

**Parameters**
- **x** (number) - The value to shift along the x-axis.
- **y** (number) - The value to shift along the y-axis.
- **z** (number) - The value to shift along the z-axis.

**Returns**
- self (Point3D) - The modified Point3D object.

#### Rotate
**Rotate** (Axis3D axis, number angle)

Rotates the point around a specified axis by a given angle.

**Parameters**
- **axis** (Axis3D) - The axis of rotation.
- **angle** (number) - The angle of rotation in radians.

**Returns**
- self (Point3D) - The rotated Point3D object.

#### Scale
**Scale** (Point3D fixedPoint, number xScale, number yScale, number zScale)

Scales the point relative to a fixed point with specified scaling factors.

**Parameters**
- **fixedPoint** (Point3D) - The point around which scaling is performed.
- **xScale** (number) - The scaling factor along the x-axis.
- **yScale** (number) - The scaling factor along the y-axis.
- **zScale** (number) - The scaling factor along the z-axis.

**Returns**
- self (Point3D) - The scaled Point3D object.

#### Transform
**Transform** (Matrix3D matrix)

Transforms the point according to the provided transformation matrix.

**Parameters**
- **matrix** (Matrix3D) - The transformation matrix.

**Returns**
- self (Point3D) - The transformed Point3D object.

#### Clone
**Clone** ()

Returns a copy of the Point3D object.

**Returns**
- Point3D - A new Point3D object that is a copy of the original.

#### GetX
**GetX** ()

Returns the x-coordinate of the point.

**Returns**
- number - The x-coordinate.

#### GetY
**GetY** ()

Returns the y-coordinate of the point.

**Returns**
- number - The y-coordinate.

#### GetZ
**GetZ** ()

Returns the z-coordinate of the point.

**Returns**
- number - The z-coordinate.

#### operator==
**operator==** (Point3D other)

Checks if this Point3D object is equal to another Point3D object.

**Parameters**
- **other** (Point3D) - The other Point3D object to compare with.

**Returns**
- boolean - True if the points are equal, false otherwise.

#### operator~=
**operator~=** (Point3D other)

Checks if this Point3D object is not equal to another Point3D object.

**Parameters**
- **other** (Point3D) - The other Point3D object to compare with.

**Returns**
- boolean - True if the points are not equal, false otherwise.
```

--------------------------------

### Create Elliptical Arc (Lua)

Source: https://help.rengabim.com/stdl/en/group___two-dimensional

Creates an elliptical arc segment. It requires the ellipse's center, radii, rotation angle, start and end points, and a flag to specify the arc direction (clockwise or counterclockwise).

```lua
CreateEllipticalArc2DByCenterStartEndPoints(center, angle, radiusAlongXAxis, radiusAlongYAxis, startPoint, endPoint, clockwise)
```

--------------------------------

### GeometrySet2D Constructor and Basic Operations

Source: https://help.rengabim.com/stdl/en/class_geometry_set2_d

Demonstrates the creation of a GeometrySet2D object and basic operations like adding curves and fills. This is fundamental for building geometric shapes.

```javascript
// Constructor
let geometrySet = new GeometrySet2D();

// Adds a curve to geometry set.
geometrySet.AddCurve(new Curve2D(...));

// Adds an area filled with the material color.
geometrySet.AddMaterialColorSolidArea(new FillArea(...));

// Adds an area filled with the line color.
geometrySet.AddLineColorSolidArea(new FillArea(...));
```

--------------------------------

### Get Parameter Values with Style.GetParameterValues()

Source: https://help.rengabim.com/stdl/en/engineering_system_object

Retrieves all parameters for an object. The function returns a table containing parameter groups and their respective values. This is useful for accessing specific properties like dimensions.

```lua
local parameters = Style.GetParameterValues()
print(parameters.Dimensions.BodyWidth)
```

--------------------------------

### Get Parameter Value (Renga STDL API)

Source: https://help.rengabim.com/stdl/en/class_parameter-members

Retrieves the current value of a parameter. This is a fundamental operation for reading parameter data within the Renga project.

```csharp
Parameter.GetValue()
```

--------------------------------

### Port API

Source: https://help.rengabim.com/stdl/en/class_port-members

This section details the methods available for interacting with the 'Port' entity within the Renga project, including setting anchors, duct parameters, pipe parameters, and placement.

```APIDOC
## Port API Endpoints

### Description
Provides methods to configure and interact with Port entities in Renga projects.

### Method
Various (SetAnchor, SetDuctParameters, SetPipeParameters, SetPlacement)

### Endpoints
N/A (These are methods on the Port object, not distinct endpoints)

### Parameters
#### SetAnchor
- **anchor** (Axis3D) - Required - The anchor point for the port.

#### SetDuctParameters (CircularProfile)
- **connectorType** (DuctConnectorType) - Required - The type of duct connector.
- **profile** (CircularProfile) - Required - The circular profile of the duct.

#### SetDuctParameters (RectangularProfile)
- **connectorType** (DuctConnectorType) - Required - The type of duct connector.
- **profile** (RectangularProfile) - Required - The rectangular profile of the duct.

#### SetPipeParameters (number)
- **connectorType** (PipeConnectorType) - Required - The type of pipe connector.
- **nominalDiameter** (number) - Required - The nominal diameter of the pipe.

#### SetPipeParameters (PipeThreadSize)
- **connectorType** (PipeConnectorType) - Required - The type of pipe connector.
- **nominalDiameter** (PipeThreadSize) - Required - The nominal diameter of the pipe using a thread size.

#### SetPlacement
- **placement** (Placement3D) - Required - The 3D placement of the port.

### Request Example
```javascript
// Example for SetDuctParameters with CircularProfile
port.SetDuctParameters(DuctConnectorType.Inlet, new CircularProfile(100));

// Example for SetPipeParameters with number
port.SetPipeParameters(PipeConnectorType.Outlet, 50);
```

### Response
#### Success Response (void)
These methods typically do not return a value upon successful execution.

#### Response Example
N/A
```

--------------------------------

### Placement3D Constructor

Source: https://help.rengabim.com/stdl/en/class_placement3_d

Constructs a Placement3D object using a point and two direction vectors.

```APIDOC
## POST /websites/help_rengabim_stdl_en/Placement3D

### Description
Constructs a local coordinate system in three-dimensional space using a specified origin point and direction vectors for the Z and X axes.

### Method
POST

### Endpoint
/websites/help_rengabim_stdl_en/Placement3D

### Parameters
#### Request Body
- **point** (Point3D) - Required - The origin point of the coordinate system.
- **zAxisDirection** (Vector3D) - Required - The direction vector for the Z-axis.
- **xAxisDirection** (Vector3D) - Required - The direction vector for the X-axis.

### Request Example
```json
{
  "point": {"x": 0, "y": 0, "z": 0},
  "zAxisDirection": {"x": 0, "y": 0, "z": 1},
  "xAxisDirection": {"x": 1, "y": 0, "z": 0}
}
```

### Response
#### Success Response (200)
- **Placement3D** (Placement3D) - The newly created Placement3D object.

#### Response Example
```json
{
  "Placement3D": {
    "origin": {"x": 0, "y": 0, "z": 0},
    "xAxisDirection": {"x": 1, "y": 0, "z": 0},
    "yAxisDirection": {"x": 0, "y": 1, "z": 0},
    "zAxisDirection": {"x": 0, "y": 0, "z": 1}
  }
}
```
```

--------------------------------

### Vector3D Constructor and Member Functions (Renga STDL API)

Source: https://help.rengabim.com/stdl/en/class_vector3_d

Demonstrates the creation and usage of the Vector3D class, including its constructor, methods for cloning, accessing components (X, Y, Z), negating the vector, and equality/inequality checks.

```javascript
// Constructor
const vec = new Vector3D(10, 20, 30);

// Clone
const clonedVec = vec.Clone();

// Get components
const x = vec.GetX(); // 10
const y = vec.GetY(); // 20
const z = vec.GetZ(); // 30

// Negate
vec.Negate(); // Now vec is (-10, -20, -30)

// Equality check
const isEqual = (vec == otherVec);

// Inequality check
const isNotEqual = (vec ~= otherVec);
```
Tokens:
Raw