> For the complete documentation index, see [llms.txt](https://icosa.gitbook.io/open-brush-plugin-scripting-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://icosa.gitbook.io/open-brush-plugin-scripting-docs/readme/rotation.md).

# Rotation

## Summary

Represents a rotation or orientation in 3D space. See <https://docs.unity3d.com/ScriptReference/Quaternion.html> for further documentation

## Class Properties

<table data-full-width="false"><thead><tr><th>Name</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td>zero</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a><br>Read-only</td><td>A rotation of zero in all axes</td></tr><tr><td>left</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a><br>Read-only</td><td>A 90 degree anti-clockwise rotation in the y axis (yaw)</td></tr><tr><td>right</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a><br>Read-only</td><td>A 90 degree clockwise rotation in the y axis (yaw)</td></tr><tr><td>up</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a><br>Read-only</td><td>A 90 degree clockwise rotation in the x axis (pitch)</td></tr><tr><td>down</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a><br>Read-only</td><td>A 90 degree anti-clockwise rotation in the x axis (pitch)</td></tr></tbody></table>

## Instance Properties

<table data-full-width="false"><thead><tr><th>Name</th><th>Return Type</th><th>Description</th></tr></thead><tbody><tr><td>this[index]</td><td>number<br>Read/Write</td><td>The amount of rotation in degrees around a single axis (0=x, 1=y, 2=z)</td></tr><tr><td>x</td><td>number<br>Read/Write</td><td>The amount of rotation around the x axis in degrees</td></tr><tr><td>y</td><td>number<br>Read/Write</td><td>The amount of rotation around the y axis in degrees</td></tr><tr><td>z</td><td>number<br>Read/Write</td><td>The amount of rotation around the z axis in degrees</td></tr><tr><td>normalized</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a><br>Read-only</td><td>Converts this rotation to one with the same orientation but with a magnitude of 1</td></tr><tr><td>inverse</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a><br>Read-only</td><td>Returns the Inverse of this rotation</td></tr><tr><td>angle</td><td>number<br>Read/Write</td><td>The angle in degrees of the angle-axis representation of this rotation</td></tr><tr><td>axis</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a><br>Read/Write</td><td>The axis part of the angle-axis representation of this rotation</td></tr></tbody></table>

## Class Methods

### Rotation:New(x, y, z)

Creates a new Rotation

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>number</td><td>0</td><td>The angle of rotation on the x axis in degrees</td></tr><tr><td>y</td><td>number</td><td>0</td><td>The angle of rotation on the y axis in degrees</td></tr><tr><td>z</td><td>number</td><td>0</td><td>The angle of rotation on the z axis in degrees</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>myRotation = Rotation:New(45, -90, 0)
</strong></code></pre>

### Rotation:Angle(a, b)

Returns the angle in degrees between two rotations

**Returns:** number (Returns the angle in degrees between two rotations)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The first rotation angle</td></tr><tr><td>b</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The second rotation angle</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:Angle(a, b)
</strong></code></pre>

### Rotation:AngleAxis(angle, axis)

Creates a rotation which rotates angle degrees around axis

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Returns a Quaternion that represents the rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>angle</td><td>number</td><td></td><td>The angle in degrees</td></tr><tr><td>axis</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>The axis of rotation</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:AngleAxis(angle, axis)
</strong></code></pre>

### Rotation:Dot(a, b)

The dot product between two rotations

**Returns:** number (Returns the dot product between two rotations)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The first rotation</td></tr><tr><td>b</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The second rotation</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:Dot(a, b)
</strong></code></pre>

### Rotation:FromToRotation(from, to)

Creates a rotation which rotates from fromDirection to toDirection

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Returns a Quaternion that represents the rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>from</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>The initial direction vector</td></tr><tr><td>to</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>The target direction vector</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:FromToRotation(from, to)
</strong></code></pre>

### Rotation:Lerp(a, b, t)

Interpolates between a and b by t and normalizes the result afterwards. The parameter t is clamped to the range \[0, 1]

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Interpolated rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The first rotation</td></tr><tr><td>b</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The second rotation</td></tr><tr><td>t</td><td>number</td><td></td><td>A ratio between 0 and 1</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:Lerp(a, b, t)
</strong></code></pre>

### Rotation:LerpUnclamped(a, b, t)

Interpolates between a and b by t and normalizes the result afterwards. The parameter t is not clamped

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Interpolated rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The first rotation</td></tr><tr><td>b</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The second rotation</td></tr><tr><td>t</td><td>number</td><td></td><td>A ratio between 0 and 1</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:LerpUnclamped(a, b, t)
</strong></code></pre>

### Rotation:LookRotation(forward)

Creates a rotation with the specified forward and upwards directions

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Rotation with specified forward direction)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>forward</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>Vector3 forward direction</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:LookRotation(forward)
</strong></code></pre>

### Rotation:LookRotation(forward, up)

Creates a rotation with the specified forward and upwards directions

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Rotation with specified forward and up directions)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>forward</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>Vector3 forward direction</td></tr><tr><td>up</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>Vector3 up direction</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:LookRotation(forward, up)
</strong></code></pre>

### Rotation:Normalize(a)

Converts this quaternion to one with the same orientation but with a magnitude of 1

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Normalized rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The input rotation</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:Normalize(a)
</strong></code></pre>

### Rotation:RotateTowards(from, to, maxDegreesDelta)

Rotates a rotation from towards to

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Rotation rotated from towards to)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>from</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>Rotation from</td></tr><tr><td>to</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>Rotation to</td></tr><tr><td>maxDegreesDelta</td><td>number</td><td></td><td>Max degrees delta</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:RotateTowards(to, maxDegreesDelta)
</strong></code></pre>

### Rotation:Slerp(a, b, t)

Spherically interpolates between quaternions a and b by ratio t. The parameter t is clamped to the range \[0, 1]

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Spherically interpolated rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The first rotation</td></tr><tr><td>b</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The second rotation</td></tr><tr><td>t</td><td>number</td><td></td><td>A ratio between 0 and 1</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:Slerp(a, b, t)
</strong></code></pre>

### Rotation:SlerpUnclamped(a, b, t)

Spherically interpolates between a and b by t. The parameter t is not clamped

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (Spherically interpolated rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The first rotation</td></tr><tr><td>b</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The second rotation</td></tr><tr><td>t</td><td>number</td><td></td><td>A ratio</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = Rotation:SlerpUnclamped(a, b, t)
</strong></code></pre>

## Instance Methods

### rotation:SetFromToRotation(fromDirection, toDirection)

Creates a rotation which rotates from one direction to another

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (A rotation that would change one direction to the other)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>fromDirection</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>The starting direction</td></tr><tr><td>toDirection</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>The target direction</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>newRot = myRotation:SetFromToRotation(Vector3:New(0, 5, 5), Vector3:New(5, 5, 0))
</strong></code></pre>

### rotation:SetLookRotation(view)

Creates a rotation with the specified forward directions

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (The new Rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>view</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>The direction to look in</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = myRotation:SetLookRotation(view)
</strong></code></pre>

### rotation:SetLookRotation(view, up)

Creates a rotation with the specified forward and upwards directions

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (The new Rotation)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>view</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>The direction to look in</td></tr><tr><td>up</td><td><a href="/open-brush-plugin-scripting-docs/readme/vector3.md">Vector3</a></td><td></td><td>The vector that defines in which direction is up</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = myRotation:SetLookRotation(view, up)
</strong></code></pre>

### rotation:Multiply(other)

Combines two rotations

**Returns:** [Rotation](/open-brush-plugin-scripting-docs/readme/rotation.md) (The rotation that represents applying both rotations in turn)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>other</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The other rotation</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>result = myRotation:Multiply(anotherRotation)
</strong></code></pre>

### rotation:NotEquals(other)

Determines whether this rotation is not equal to the specified rotation

**Returns:** boolean (true if this rotation is not equal to the specified rotation; otherwise, false)

**Parameters:**

<table data-full-width="false"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>other</td><td><a href="/open-brush-plugin-scripting-docs/readme/rotation.md">Rotation</a></td><td></td><td>The rotation to compare</td></tr></tbody></table>

#### Example

<pre class="language-lua"><code class="lang-lua"><strong>if myRotation:NotEquals(rot2) then print("rotations are different") end
</strong></code></pre>


---

# 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://icosa.gitbook.io/open-brush-plugin-scripting-docs/readme/rotation.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.