> 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/text3d.md).

# Text3D

Text3D object allow users to put text on 3D model view.

**Syntax Example:**

```
...
<O T="Text3D">
...
...
</O>
```

A Text3D object is required to have 3 Point objects to define its location.

**Example:**

```xml
<O N="Text3DObject1" T="Project" Category="3D Geometric Objects" TransAlignRule="Right">
 <!-- created by ParamML Examples on 01.02.2023 -->
 <O T="Surface" Thickness="20" Opacity="0.6">
 <O T="Point" X="0" Y="0" Z="0" />
 <O T="Point" X="30" Y="0" Z="0" />
 <O T="Point" X="30" Y="30" Z="0" />
 <O T="Point" X="0" Y="30" Z="0" />
 </O>
 <O T="Text3D" FontSize="5" Label="Text on 3D Model" X="5" Y="15" Z="25">
 <O T="Point" Z="0" Y="5" X="0" />
 <O T="Point" Z="0" Y="-5" X="0" />
 <O T="Point" Z="5" Y="5" X="0" />
 </O>
</O>
```

![](https://openbrim.atlassian.net/wiki/download/attachments/2158788609/image-20230201-155359.png?api=v2) To view this example in the library, see (<https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&obj=objiddr21jyh49cigudkjmgma5k>)

To display a calculated value in the text, you can use the "||" symbol between statements. This will cause the expression inside the "||" to be evaluated and displayed as the final result.

**Example:**

```xml
<O N="Text3DObject2" T="Project" Category="3D Geometric Objects" TransAlignRule="Right">
 <!-- created by ParamML Examples on 01.02.2023 -->
 <O T="Surface" Thickness="20" Opacity="0.6">
 <O T="Point" X="0" Y="0" Z="0" />
 <O T="Point" X="30" Y="0" Z="0" />
 <O T="Point" X="30" Y="30" Z="0" />
 <O T="Point" X="0" Y="30" Z="0" />
 </O>
 <P N="ForceX" V="12" />
 <P N="ForceY" V="17" />
 <O T="Text3D" FontSize="5" Label="Calculation=\|ForceX+ForceY\|" X="5" Y="15" Z="25">
 <O T="Point" Z="0" Y="5" X="0" />
 <O T="Point" Z="0" Y="-5" X="0" />
 <O T="Point" Z="5" Y="5" X="0" />
 </O>
</O>
```

![](https://openbrim.atlassian.net/wiki/download/attachments/2158788609/image-20230201-161414.png?api=v2) To view this example in the library, see (<https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&folder=3D+Geometric+Objects&obj=objid0jagk2kdp89fa701ew9izs>)

The "Text3D" object has another special use. Using the expression "|Self.N|", the name of the project object is automatically written on the 3D object.

**Example:**

```xml
<O N="Text3DObject3" T="Project" Category="3D Geometric Objects" TransAlignRule="Right">
 <!-- created by ParamML Examples on 01.02.2023 -->
 <O T="Surface" Thickness="20" Opacity="0.6">
 <O T="Point" X="0" Y="0" Z="0" />
 <O T="Point" X="30" Y="0" Z="0" />
 <O T="Point" X="30" Y="30" Z="0" />
 <O T="Point" X="0" Y="30" Z="0" />
 </O>
 <O T="Text3D" FontSize="5" Label="\|Self.N\|" X="5" Y="15" Z="25">
 <O T="Point" Z="0" Y="5" X="0" />
 <O T="Point" Z="0" Y="-5" X="0" />
 <O T="Point" Z="5" Y="5" X="0" />
 </O>
</O>
```

![](https://openbrim.atlassian.net/wiki/download/attachments/2158788609/image-20230201-162651.png?api=v2) To view this example in the library, see (<https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&folder=3D+Geometric+Objects&obj=objidyw9whr0h5lc70h70jj64lf>)

**Parameters of Text3D Object:**

\| | **Label** | **Mandatory** | **Description** | **Example** | | --- | --- | --- | --- | | 1 | FontSize | Yes | Font size of the text displayed in 3D view | FontSize="5" (integer or float)

FontSize="H/10" (expression) | 2 | Label | Yes | Text displayed in 3D view | Label="Sample Text" | | 3 | X | Yes | Location of center of text along X-axis | X="5" (integer or float)

X="L/2" (expression)\
\| 4 | Y | Yes | Location of center of text along Y-axis | Y="10" (integer or float)

Y="W/2" (expression)\
\| 5 | Z | Yes | Location of center of text along Z-axis. | Z="6" (integer or float)

Z="H/2" (expression)\
\| 6 | RX | Yes | Angle of rotation of text about X-axis | RX="1.57" (integer or float)

RX="PI/4" (expression)\
\| 7 | RY | Yes | Angle of rotation of text about Y-axis | RY="3.14" (integer or float)

RY="PI" (expression)\
\| 8 | Rz | Yes | Angle of rotation of text about Z-axis | RZ="1.57" (integer or float)

RZ="PI/4" (expression)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openbrim.org/developers/paramml-developer-guide/core-objects/3d-geometric-objects/text3d.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
