:github_url: hide

<!---
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/Godot-CCP/doc_classes/AnimatedBar.xml.

.. _class_AnimatedBar:

-->
<a name="TOP"></a>

# AnimatedBar

**Inherits:** [Container](https://docs.godotengine.org/en/stable/classes/class_container.html)

**Inherited By:** [HAnimatedBar](./HAnimatedBar.md), [VAnimatedBar](./VAnimatedBar.md)

Class for creating tool bar.

<a name="Description"></a>

## Description

Emits custom siglalls when one of button children is pressed.

See also [HAnimatedBar](./HAnimatedBar.md) and [VAnimatedBar](./VAnimatedBar.md).




.. tabs::

 .. code-tab:: gdscript

    func Test():
    pritn("TEST!")






.. tabs::

 .. code-tab:: csharp

    private void Test()
    {
        GD.Print("TEST!");
    }






.. tabs::

[text](https://docs.godotengine.org/en/stable/classes/class_text.html)

Text with multiple lines.

Second line of text.



There was a blank line.

[/text]



<a name="Properties"></a>

## Properties

|                                                                                |                                                                              |                  |
|--------------------------------------------------------------------------------|------------------------------------------------------------------------------|------------------|
| [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html)         | [fill_remaining_space](#property_fill_remaining_space)                       | ``true``         |
| [NodePath](https://docs.godotengine.org/en/stable/classes/class_nodepath.html) | [navigation_buttons_custom_left](#property_navigation_buttons_custom_left)   | ``NodePath("")`` |
| [NodePath](https://docs.godotengine.org/en/stable/classes/class_nodepath.html) | [navigation_buttons_custom_right](#property_navigation_buttons_custom_right) | ``NodePath("")`` |
| [float](https://docs.godotengine.org/en/stable/classes/class_float.html)       | [navigation_buttons_spacing](#property_navigation_buttons_spacing)           | ``5.0``          |
| [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html)         | [navigation_buttons_use_custom](#property_navigation_buttons_use_custom)     | ``false``        |
| [int](https://docs.godotengine.org/en/stable/classes/class_int.html)           | [navigation_buttons_visibility](#property_navigation_buttons_visibility)     | ``3``            |
| [float](https://docs.godotengine.org/en/stable/classes/class_float.html)       | [spacing](#property_spacing)                                                 | ``10.0``         |
| [float](https://docs.godotengine.org/en/stable/classes/class_float.html)       | [speed](#property_speed)                                                     | ``4.0``          |

<a name="Methods"></a>

## Methods

|                                                                        |                                                                                             |
|------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
| [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) | [are_navigation_buttons_visible](./AnimatedBar.md#method_are_navigation_buttons_visible)( ) |
| *void*                                                                 | [deactivate_focus](./AnimatedBar.md#method_deactivate_focus)( )                             |
| [int](https://docs.godotengine.org/en/stable/classes/class_int.html)   | [get_options_quantity](./AnimatedBar.md#method_get_options_quantity)( ) *const*             |
| [ORIENTATION](./AnimatedBar.md#enum_ORIENTATION)                       | [get_orientation](./AnimatedBar.md#method_get_orientation)( ) *const*                       |

---

<a name="Signals"></a>

## Signals

<a name="signal_focus_activated"></a>

#### **focus_activated**( focused_child_id\: [int](https://docs.godotengine.org/en/stable/classes/class_int.html) )

Emitted when option changes from nothing to something.

<a name="signal_focus_changed"></a>

#### **focus_changed**( focused_child_id\: [int](https://docs.godotengine.org/en/stable/classes/class_int.html) )

Emitted when one option changes to another.

<a name="signal_focus_deactivated"></a>

#### **focus_deactivated**( )

Emitted when option changes from something to nothing.

<a name="signal_options_quantity_changed"></a>

#### **options_quantity_changed**( new_quantity\: [int](https://docs.godotengine.org/en/stable/classes/class_int.html) )

Emitted when quantity of options changes.

---

<a name="Enumerations"></a>

## Enumerations

<a name="enum_ORIENTATION"></a>

#### enum **ORIENTATION**:

<a name="constant_ORIENTATION_HORIZONTAL"></a>

##### [ORIENTATION](./AnimatedBar.md#enum_ORIENTATION) **ORIENTATION_HORIZONTAL** = ``1``

Value of [HAnimatedBar](./HAnimatedBar.md).

<a name="constant_ORIENTATION_VERTICAL"></a>

##### [ORIENTATION](./AnimatedBar.md#enum_ORIENTATION) **ORIENTATION_VERTICAL** = ``2``

Value of [VAnimatedBar](./VAnimatedBar.md).

<a name="constant_ORIENTATION_UNDEFINED"></a>

##### [ORIENTATION](./AnimatedBar.md#enum_ORIENTATION) **ORIENTATION_UNDEFINED** = ``0``

Default value.

---

<a name="PropertyDescriptions"></a>

## Property Descriptions

<a name="property_fill_remaining_space"></a>

#### [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) **fill_remaining_space** = ``true``

- *void* **set_fill_remaining_space**( value\: [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) )
- [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) **is_remaining_space_filled**( )

If ``true`` [Control](https://docs.godotengine.org/en/stable/classes/class_control.html) children are stretched to fill remaining space.

<a name="property_navigation_buttons_custom_left"></a>

#### [NodePath](https://docs.godotengine.org/en/stable/classes/class_nodepath.html) **navigation_buttons_custom_left** = ``NodePath("")``

- *void* **set_custom_left_navigation_button**( value\: [NodePath](https://docs.godotengine.org/en/stable/classes/class_nodepath.html) )
- [NodePath](https://docs.godotengine.org/en/stable/classes/class_nodepath.html) **get_custom_left_navigation_button**( )

If is not set to null pointer and [navigation_buttons_use_custom](./animatedbar.md#property_navigation_buttons_use_custom) is set to ``true`` then child found by this path replaces default left navigation button.

<a name="property_navigation_buttons_custom_right"></a>

#### [NodePath](https://docs.godotengine.org/en/stable/classes/class_nodepath.html) **navigation_buttons_custom_right** = ``NodePath("")``

- *void* **set_custom_right_navigation_button**( value\: [NodePath](https://docs.godotengine.org/en/stable/classes/class_nodepath.html) )
- [NodePath](https://docs.godotengine.org/en/stable/classes/class_nodepath.html) **get_custom_right_navigation_button**( )

If is not set to null pointer and [navigation_buttons_use_custom](./animatedbar.md#property_navigation_buttons_use_custom) is set to ``true`` then child found by this path replaces default right navigation button.

<a name="property_navigation_buttons_spacing"></a>

#### [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **navigation_buttons_spacing** = ``5.0``

- *void* **set_navigation_buttons_spacing**( value\: [float](https://docs.godotengine.org/en/stable/classes/class_float.html) )
- [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **get_navigation_buttons_spacing**( )

Defines space between navigation buttons and other content.

<a name="property_navigation_buttons_use_custom"></a>

#### [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) **navigation_buttons_use_custom** = ``false``

- *void* **use_custom_navigation_buttons**( value\: [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) )
- [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) **are_custom_navigation_buttons_used**( )

Defines if to use custom navigation buttons.

<a name="property_navigation_buttons_visibility"></a>

#### [int](https://docs.godotengine.org/en/stable/classes/class_int.html) **navigation_buttons_visibility** = ``3``

- *void* **set_navigation_buttons_visibility**( value\: [int](https://docs.godotengine.org/en/stable/classes/class_int.html) )
- [int](https://docs.godotengine.org/en/stable/classes/class_int.html) **get_navigation_buttons_visibility**( )

If set to 0 then navigation buttons are always hidden.

If set to 1 then navigation buttons are always visible.

If set to other number then navigation buttons whill automatically hide and show up.

<a name="property_spacing"></a>

#### [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **spacing** = ``10.0``

- *void* **set_spacing**( value\: [float](https://docs.godotengine.org/en/stable/classes/class_float.html) )
- [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **get_spacing**( )

Defines space between individual [Control](https://docs.godotengine.org/en/stable/classes/class_control.html) Children.

<a name="property_speed"></a>

#### [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **speed** = ``4.0``

- *void* **set_speed**( value\: [float](https://docs.godotengine.org/en/stable/classes/class_float.html) )
- [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **get_speed**( )

Defines sliding speed of content after pressing one of navigation buttons.

---

<a name="MethodDescriptions"></a>

## Method Descriptions

<a name="method_are_navigation_buttons_visible"></a>

#### [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) **are_navigation_buttons_visible**( )

Returns ``true`` if left and right navigation buttons(by default, those with arrows) are visible.

<a name="method_deactivate_focus"></a>

#### *void* **deactivate_focus**( )

Does same thing as pressing already chosen butoon(eg. choosing already choosen tool).

<a name="method_get_options_quantity"></a>

#### [int](https://docs.godotengine.org/en/stable/classes/class_int.html) **get_options_quantity**( ) *const*

Return number of [Control](https://docs.godotengine.org/en/stable/classes/class_control.html) children.

<a name="method_get_orientation"></a>

#### [ORIENTATION](./AnimatedBar.md#enum_ORIENTATION) **get_orientation**( ) *const*

Returns orientation of this class.

**Note:** It is C++ virtual const method and subclasses like [HAnimatedBar](./HAnimatedBar.md) may overwrite it.