# RotateBy Action

This **Node** has different versions for [**Scenes**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/project-objects/scene) and [**Scene2Ds**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/project-objects/scene2d). Find in the tabs below the documentation for both versions.

{% tabs %}
{% tab title="Scene" %}
**Overview**

![The RotateBy Action Node.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-017fa12cd5c812675c78cf90268fee330b9587b0%2Frotatebyactionupdatedimage.png?alt=media)

The **RotateBy Action Node** continuously rotates a [**Scene Object**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/scene-objects) by the *Euler angles* values specified in `Offset` for a given period of time, thus creating an **Animation**.

Furthermore, visit the [**Actions Nodes**](https://docs.incari.com/incari-studio/2023.2/toolbox/actions) page for a general introduction to these **Nodes**, and [**Rotation**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/attributes/common-attributes/transformation#rotation) for more detail about the `Rotation` **Attribute**.

[**Scope**](https://docs.incari.com/incari-studio/2023.2/overview#scopes): **Scene**, **Function**, **Prefab**.

**Attributes**

![The RotateBy Action Node Attributes.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-22c6bf23fccbf1a01dc9bd6cc6d1c1f7d3324584%2Frotatebyactionattributes.png?alt=media)

| Attribute        | Type          | Description                                                                                                                                                                                                                                                                                                                                     |
| ---------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Offset`         | **Vector3**   | The amount to rotate the **Object** by, measured in *Euler angles* along the X, Y, and Z axes, if none is received in the `Offset` **Input Socket**.                                                                                                                                                                                            |
| `Duration (sec)` | **Float**     | The total time of the **Action**, if none is received in the `Duration` **Input Socket**.                                                                                                                                                                                                                                                       |
| `Interpolation`  | **Drop-down** | The `Interpolation` method to use for calculating the intermediate values of the *Euler Angles*. It can be [*Linear*](https://en.wikipedia.org/wiki/Linear_interpolation), [*Sine Ease In*](https://easings.net/#easeInSine), [*Sine Ease In Out*](https://easings.net/#easeInOutSine), or [*Sine Ease Out*](https://easings.net/#easeOutSine). |

**Inputs**

| Input         | Type           | Description                                                                                                                                                                                               |
| ------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Instance ID` | **InstanceID** | The assigned [**Instance ID**](https://docs.incari.com/incari-studio/2023.2/toolbox/actions/..#instance-id) of the **Action**. If nothing is received, it automatically assigns 0 as the **Instance ID**. |
| (►) `Start`   | **Pulse**      | A standard **Input Pulse**, to trigger the execution of the **Node**.                                                                                                                                     |
| `Object ID`   | **ObjectID**   | The ID of the target **Object**.                                                                                                                                                                          |
| `Duration`    | **Float**      | The total time (in seconds).                                                                                                                                                                              |
| `Offset`      | **Vector3**    | The amount to rotate the **Object** by, measured in *Euler angles* along the X, Y, and Z axes.                                                                                                            |

**Outputs**

| Output        | Type           | Description                                                                                                                    |
| ------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `Instance ID` | **InstanceID** | The assigned [**Instance ID**](https://docs.incari.com/incari-studio/2023.2/toolbox/actions/..#instance-id) of the **Action**. |
| `OnStart` (►) | **Pulse**      | Flows to the next **Node** following **RotateBy Action** when the **Action** starts.                                           |
| `OnEnd` (►)   | **Pulse**      | Flows to the next **Node** following **RotateBy Action** when the **Action** stops.                                            |
| {% endtab %}  |                |                                                                                                                                |

{% tab title="Scene2D" %}
**Overview**

![The RotateBy Action Node.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-0feb3447a65e6bc9c662e33311b5820a68b7f74d%2Frotatebyactionnode2d.png?alt=media)

The **RotateBy Action Node** continuously rotates a [**Scene2D Object**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/scene2d-objects) by the value specified in `Offset` for a given period of time, thus creating an **Animation**.

Furthermore, visit the [**Actions Nodes**](https://docs.incari.com/incari-studio/2023.2/toolbox/actions) page for a general introduction to these **Nodes**, and [**Rotation**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/attributes/common-attributes/transformation#rotation) for more detail about the `Rotation` **Attribute**.

[**Scope**](https://docs.incari.com/incari-studio/2023.2/overview#scopes): **Scene**, **Function**, **Prefab**.

**Attributes**

![The RotateBy Action Node Attributes.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-a43e9b42d61aec83d3c487099ec0970618334431%2Frotatebyactionatts2d.png?alt=media)

| Attribute        | Type          | Description                                                                                                                                                                                                                                                                                                                                     |
| ---------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Offset`         | **Float**     | The amount to rotate the **Object** by, if none is received in the `Offset` **Input Socket**.                                                                                                                                                                                                                                                   |
| `Duration (sec)` | **Float**     | The total time of the **Action**, if none is received in the `Duration` **Input Socket**.                                                                                                                                                                                                                                                       |
| `Interpolation`  | **Drop-down** | The `Interpolation` method to use for calculating the intermediate values of the *Euler Angles*. It can be [*Linear*](https://en.wikipedia.org/wiki/Linear_interpolation), [*Sine Ease In*](https://easings.net/#easeInSine), [*Sine Ease In Out*](https://easings.net/#easeInOutSine), or [*Sine Ease Out*](https://easings.net/#easeOutSine). |

**Inputs**

| Input         | Type           | Description                                                                                                                                                                                               |
| ------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Instance ID` | **InstanceID** | The assigned [**Instance ID**](https://docs.incari.com/incari-studio/2023.2/toolbox/actions/..#instance-id) of the **Action**. If nothing is received, it automatically assigns 0 as the **Instance ID**. |
| (►) `Start`   | **Pulse**      | A standard **Input Pulse**, to trigger the execution of the **Node**.                                                                                                                                     |
| `Object ID`   | **ObjectID**   | The ID of the target **Object**.                                                                                                                                                                          |
| `Duration`    | **Float**      | The total time (in seconds).                                                                                                                                                                              |
| `Offset`      | **Float**      | The amount to rotate the **Object** by.                                                                                                                                                                   |

**Outputs**

| Output        | Type           | Description                                                                                                                    |
| ------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `Instance ID` | **InstanceID** | The assigned [**Instance ID**](https://docs.incari.com/incari-studio/2023.2/toolbox/actions/..#instance-id) of the **Action**. |
| `OnStart` (►) | **Pulse**      | Flows to the next **Node** following **RotateBy Action** when the **Action** starts.                                           |
| `OnEnd` (►)   | **Pulse**      | Flows to the next **Node** following **RotateBy Action** when the **Action** stops.                                            |
| {% endtab %}  |                |                                                                                                                                |
| {% endtabs %} |                |                                                                                                                                |

## Example

This section shows a simple example of how to use the **RotateBy Action** **Node** and the effect it has on an **Scene Object**. This concept can be applied as well to a **Scene2D Object**.

We start by [configuring the **Scene**](#scene-configuration), then [build the **Logic**](#logic), and finally show the [result](#final-result).

### Scene Configuration

We consider a [**Scene**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/project-objects/scene) with two [**Objects**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/scene-objects): a red [**Torus**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/scene-objects/primitives#torus) and a [**Directional Light**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/scene-objects/lights), both of which can be easily created in the [**Scene Outliner**](https://docs.incari.com/incari-studio/2023.2/modules/scene-outliner). Then, we set the `Scale` **Attribute** of the **Torus** to $$(2, 2, 2)$$, its `Rotation` to $$(30, 30, 0)$$, and the `Position` of the **Light** to $$(0, 200, 0)$$. See this configuration in the following image:

![Scene configuration.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-4296c822d62b37fce95d67b7cd79aa57db747807%2FExampleRotateFromTo_1.png?alt=media)

### Logic

We then need to configure the **Logic**. This is done in the [**Logic Editor**](https://docs.incari.com/incari-studio/2023.2/modules/logic-editor).

We use first a [**Get Rotation** **Node**](https://docs.incari.com/incari-studio/2023.2/toolbox/incari/object/get-rotation), which allows us to obtain an **Object's** current `Rotation` values, and then the **RotateFromTo Action** **Node**, to which we will feed the value previously obtained and configure it for it to *rotate* the **Object** from there to a fixed value of our choosing.

We use the **RotateBy Action** **Node** with the following **Attributes**:

* `Offset`: $$(60, 60, 0)$$
* `Duration (sec)`: $$3$$
* `Interpolation`: `Linear`

And we connect to it the [**Object Node**](https://docs.incari.com/incari-studio/2023.2/objects-and-types/scene-objects#objects-in-the-logic) of the red **Torus** and a **Pulse** to the `Start` **Input Socket**. Thus, having the following **Logic** configuration:

![Logic configuration.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-a5af3dc3a8680f32209a5abc402c9ab04489e7c1%2FExampleRotateBy_2.png?alt=media)

### Final result

Finally, the effect of the **RotateBy Action** **Node** when triggered is the following:

![Final result.](https://2561100106-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Ff6JZovzOqBctA4C1o76u%2Fuploads%2Fgit-blob-6a9b3b3d7c0d343927194cb8fa63f2123e5c2a02%2FExampleRotateBy_3.gif?alt=media)

## See Also

* [**RotateTo Action**](https://docs.incari.com/incari-studio/2023.2/toolbox/actions/rotatetoaction)
* [**RotateFromTo Action**](https://docs.incari.com/incari-studio/2023.2/toolbox/actions/rotatefromtoaction)

## External Links

* [*Rotation*](https://en.wikipedia.org/wiki/Rotation) on Wikipedia
* [*Euler angles*](https://en.wikipedia.org/wiki/Euler_angles) on Wikipedia
