mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-05 14:10:19 +03:00
cf78697eea
Currently including `zh_CN` and `es` which both have very high completion ratios. Others will be added once they reach a significant percentage too. These RST files will be used by godot-docs in place of its `classes` folder after we sync with https://github.com/godotengine/godot-docs/pull/5458. The update workflow is manual for now (example for `zh_CN`): - Build `godotengine/godot` in the branch we currently track (now `3.x`) - Run `godot --doctool -l zh_CN` - Run `cd doc && make rst LANGARG=zh_CN` - Copy `doc/_build/rst/*` to `classes/zh_CN/` here - Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
208 lines
19 KiB
ReStructuredText
208 lines
19 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the EditorSpatialGizmo.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_EditorSpatialGizmo:
|
|
|
|
EditorSpatialGizmo
|
|
==================
|
|
|
|
**Inherits:** :ref:`SpatialGizmo<class_SpatialGizmo>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Custom gizmo for editing Spatial objects.
|
|
|
|
Descripción
|
|
----------------------
|
|
|
|
Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. See :ref:`EditorSpatialGizmoPlugin<class_EditorSpatialGizmoPlugin>` for more information.
|
|
|
|
Métodos
|
|
--------------
|
|
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_collision_segments<class_EditorSpatialGizmo_method_add_collision_segments>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` segments **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_collision_triangles<class_EditorSpatialGizmo_method_add_collision_triangles>` **(** :ref:`TriangleMesh<class_TriangleMesh>` triangles **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_handles<class_EditorSpatialGizmo_method_add_handles>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` handles, :ref:`Material<class_Material>` material, :ref:`bool<class_bool>` billboard=false, :ref:`bool<class_bool>` secondary=false **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_lines<class_EditorSpatialGizmo_method_add_lines>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` lines, :ref:`Material<class_Material>` material, :ref:`bool<class_bool>` billboard=false, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_mesh<class_EditorSpatialGizmo_method_add_mesh>` **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`SkinReference<class_SkinReference>` skeleton=null, :ref:`Material<class_Material>` material=null **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_unscaled_billboard<class_EditorSpatialGizmo_method_add_unscaled_billboard>` **(** :ref:`Material<class_Material>` material, :ref:`float<class_float>` default_scale=1, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`clear<class_EditorSpatialGizmo_method_clear>` **(** **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`commit_handle<class_EditorSpatialGizmo_method_commit_handle>` **(** :ref:`int<class_int>` index, :ref:`Variant<class_Variant>` restore, :ref:`bool<class_bool>` cancel=false **)** |virtual| |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_handle_name<class_EditorSpatialGizmo_method_get_handle_name>` **(** :ref:`int<class_int>` index **)** |virtual| |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`get_handle_value<class_EditorSpatialGizmo_method_get_handle_value>` **(** :ref:`int<class_int>` index **)** |virtual| |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`EditorSpatialGizmoPlugin<class_EditorSpatialGizmoPlugin>` | :ref:`get_plugin<class_EditorSpatialGizmo_method_get_plugin>` **(** **)** |const| |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Spatial<class_Spatial>` | :ref:`get_spatial_node<class_EditorSpatialGizmo_method_get_spatial_node>` **(** **)** |const| |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_handle_highlighted<class_EditorSpatialGizmo_method_is_handle_highlighted>` **(** :ref:`int<class_int>` index **)** |virtual| |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`redraw<class_EditorSpatialGizmo_method_redraw>` **(** **)** |virtual| |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_handle<class_EditorSpatialGizmo_method_set_handle>` **(** :ref:`int<class_int>` index, :ref:`Camera<class_Camera>` camera, :ref:`Vector2<class_Vector2>` point **)** |virtual| |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_hidden<class_EditorSpatialGizmo_method_set_hidden>` **(** :ref:`bool<class_bool>` hidden **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_spatial_node<class_EditorSpatialGizmo_method_set_spatial_node>` **(** :ref:`Node<class_Node>` node **)** |
|
|
+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Descripciones de Métodos
|
|
------------------------------------------------
|
|
|
|
.. _class_EditorSpatialGizmo_method_add_collision_segments:
|
|
|
|
- void **add_collision_segments** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` segments **)**
|
|
|
|
Añade los ``segmentos`` especificados a la forma de colisión del gizmo para la recogida. Llama a esta función durante :ref:`redraw<class_EditorSpatialGizmo_method_redraw>`.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_add_collision_triangles:
|
|
|
|
- void **add_collision_triangles** **(** :ref:`TriangleMesh<class_TriangleMesh>` triangles **)**
|
|
|
|
Añade triángulos de colisión al gizmo para recoger. También se puede generar un :ref:`TriangleMesh<class_TriangleMesh>` a partir de un :ref:`Mesh<class_Mesh>` normal. Llama a esta función durante el :ref:`redraw<class_EditorSpatialGizmo_method_redraw>`.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_add_handles:
|
|
|
|
- void **add_handles** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` handles, :ref:`Material<class_Material>` material, :ref:`bool<class_bool>` billboard=false, :ref:`bool<class_bool>` secondary=false **)**
|
|
|
|
Añade una lista de manejadores (puntos) que pueden utilizarse para deformar el objeto que se está editando.
|
|
|
|
Hay funciones virtuales que serán llamadas al editar estos "manejadores". Llama a esta función durante el :ref:`redraw<class_EditorSpatialGizmo_method_redraw>`.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_add_lines:
|
|
|
|
- void **add_lines** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` lines, :ref:`Material<class_Material>` material, :ref:`bool<class_bool>` billboard=false, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)**
|
|
|
|
Añade líneas al gizmo (como conjuntos de 2 puntos), con un material determinado. Las líneas se utilizan para visualizar el aparato. Llama a esta función durante :ref:`redraw<class_EditorSpatialGizmo_method_redraw>`.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_add_mesh:
|
|
|
|
- void **add_mesh** **(** :ref:`Mesh<class_Mesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`SkinReference<class_SkinReference>` skeleton=null, :ref:`Material<class_Material>` material=null **)**
|
|
|
|
Añade una malla al gizmo con el estado especificado de ``billboard``, ``skeleton`` y ``material``. Si ``billboard`` es ``true``, la malla girará siempre de cara a la cámara. Llama a esta función durante :ref:`redraw<class_EditorSpatialGizmo_method_redraw>`.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_add_unscaled_billboard:
|
|
|
|
- void **add_unscaled_billboard** **(** :ref:`Material<class_Material>` material, :ref:`float<class_float>` default_scale=1, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ) **)**
|
|
|
|
Añade una billboard sin escala para la visualización. Llame a esta función durante el :ref:`redraw<class_EditorSpatialGizmo_method_redraw>`.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_clear:
|
|
|
|
- void **clear** **(** **)**
|
|
|
|
Quita todo lo que hay en el gizmo, incluyendo las mallas, las colisiones y manejadoras.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_commit_handle:
|
|
|
|
- void **commit_handle** **(** :ref:`int<class_int>` index, :ref:`Variant<class_Variant>` restore, :ref:`bool<class_bool>` cancel=false **)** |virtual|
|
|
|
|
Comprueba que un "manejador" está siendo editado (los "handles" deben haber sido añadidos previamente por :ref:`add_handles<class_EditorSpatialGizmo_method_add_handles>`).
|
|
|
|
Si el parámetro ``cancel`` es ``true``, se proporciona una opción para restaurar el valor editado al original.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_get_handle_name:
|
|
|
|
- :ref:`String<class_String>` **get_handle_name** **(** :ref:`int<class_int>` index **)** |virtual|
|
|
|
|
Obtiene el nombre de un "manejador" editado (los "manejadores" deben haber sido añadidos previamente por :ref:`add_handles<class_EditorSpatialGizmo_method_add_handles>`).
|
|
|
|
Los "manejadores" pueden ser nombrados por referencia al usuario cuando se edita.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_get_handle_value:
|
|
|
|
- :ref:`Variant<class_Variant>` **get_handle_value** **(** :ref:`int<class_int>` index **)** |virtual|
|
|
|
|
Obtiene el valor real de un manejador. Este valor puede ser cualquier cosa y se usa para eventualmente deshacer el movimiento cuando se llama a :ref:`commit_handle<class_EditorSpatialGizmo_method_commit_handle>`.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_get_plugin:
|
|
|
|
- :ref:`EditorSpatialGizmoPlugin<class_EditorSpatialGizmoPlugin>` **get_plugin** **(** **)** |const|
|
|
|
|
Returns the :ref:`EditorSpatialGizmoPlugin<class_EditorSpatialGizmoPlugin>` that owns this gizmo. It's useful to retrieve materials using :ref:`EditorSpatialGizmoPlugin.get_material<class_EditorSpatialGizmoPlugin_method_get_material>`.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_get_spatial_node:
|
|
|
|
- :ref:`Spatial<class_Spatial>` **get_spatial_node** **(** **)** |const|
|
|
|
|
Returns the Spatial node associated with this gizmo.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_is_handle_highlighted:
|
|
|
|
- :ref:`bool<class_bool>` **is_handle_highlighted** **(** :ref:`int<class_int>` index **)** |virtual|
|
|
|
|
Devuelve ``true`` si el mango del índice ``index`` está resaltado al pasar el ratón por encima.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_redraw:
|
|
|
|
- void **redraw** **(** **)** |virtual|
|
|
|
|
This function is called when the :ref:`Spatial<class_Spatial>` this gizmo refers to changes (the :ref:`Spatial.update_gizmo<class_Spatial_method_update_gizmo>` is called).
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_set_handle:
|
|
|
|
- void **set_handle** **(** :ref:`int<class_int>` index, :ref:`Camera<class_Camera>` camera, :ref:`Vector2<class_Vector2>` point **)** |virtual|
|
|
|
|
This function is used when the user drags a gizmo handle (previously added with :ref:`add_handles<class_EditorSpatialGizmo_method_add_handles>`) in screen coordinates.
|
|
|
|
The :ref:`Camera<class_Camera>` is also provided so screen coordinates can be converted to raycasts.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_set_hidden:
|
|
|
|
- void **set_hidden** **(** :ref:`bool<class_bool>` hidden **)**
|
|
|
|
Establece el estado oculto del aparato. Si ``true``, el aparato estará oculto. Si ``false``, se mostrará.
|
|
|
|
----
|
|
|
|
.. _class_EditorSpatialGizmo_method_set_spatial_node:
|
|
|
|
- void **set_spatial_node** **(** :ref:`Node<class_Node>` node **)**
|
|
|
|
Sets the reference :ref:`Spatial<class_Spatial>` node for the gizmo. ``node`` must inherit from :ref:`Spatial<class_Spatial>`.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|