> For the complete documentation index, see [llms.txt](https://docs.openbrim.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openbrim.org/developers/paramml-developer-guide/core-objects/3d-geometric-objects/surface.md).
# Surface
This section will discuss the use of Surface object(s) to represent a 2D surface or a 3D volume if thickness parameter is specified.
To create a Surface object, at least three points are required. The values of these points at each corner of the surface must be determined in the coordinate system and the surface must be defined by connecting the points in a consecutive, counter-clockwise manner.
Surface objects conform to the cross-sectional definition of the assigned Alignment in the transverse direction.
**Syantax:**
```
...
...
...
```
**Example:**
The "Surface" object combines the entered points and defines them as a surface. In simpler terms, the surface is formed by grouping each entered point under the Surface object.
```xml
```
 To view this example in the library, see ()
**Example:**
```xml
```
 If point objects are not entered consecutively, the surface may not be created as desired or an error may occur.
```xml
```
 Therefore, the order in which the points are entered is important. If the points are entered in the wrong order, the surface will not be formed correctly. To view this example in the library, see ()
**Example:**
By specifying a thickness value, the "surface" becomes a 3D volume object. The Thickness parameter can be assigned a value in the same unit system used for the coordinates of the points.
```xml
```
 To view this example in the library, see ()
**Example:**
The “IsCutout” parameter can be used to specify if the surface should be cut or not. A value of 1 or "Yes" indicates that the surface should be cut, and a value of 2 or "No" indicates that the surface should not be cut and should be created as is.
```xml
```
 The Draw Border parameter queries whether to draw border lines on the shape. Default value is 1
“Yes” which means the border lines will be drawn, and a value of “No” means that the border lines will not be drawn.
```xml
```
 To view this example in the library, see ()
**Example:**
```xml
```
 To view this example in the library, see ()
\| | **Label** | **Mandatory** | **Name and Type Attributes** | **Default Description and Value Attributes** | **Other Attributes** | | --- | --- | --- | --- | --- | | 1 | Curved | No | N="IsCurved" | D="Curved: Does this surface curve along alignment definitions? \[Yes=1/No=0]" V="0" | Role="Input" | | 2 | Cutout | No | N="IsCutout" | D="Cutout: Does this surface represent a cutout? \[Yes=1/No=0]" V="0" | Role="Input" | | 3 | Draw Border | No | N="DrawBorder" | D="Draw Border: Should a border drawn around the surface? \[Yes=1/No=0]" V="0" | Role="Input" | | 4 | Thickness | No | N="Thickness" | D="Thickness: The thickness of the surface. (optional)" V="2" | Role="Input"UT="Length" UC="Section" |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.openbrim.org/developers/paramml-developer-guide/core-objects/3d-geometric-objects/surface.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.