mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
141 lines
5.6 KiB
ReStructuredText
141 lines
5.6 KiB
ReStructuredText
: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/doc/classes/VisualShaderNodeBillboard.xml.
|
|
|
|
.. _class_VisualShaderNodeBillboard:
|
|
|
|
VisualShaderNodeBillboard
|
|
=========================
|
|
|
|
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A node that controls how the object faces the camera to be used within the visual shader graph.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
The output port of this node needs to be connected to ``Model View Matrix`` port of :ref:`VisualShaderNodeOutput<class_VisualShaderNodeOutput>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+--------------------------------------------------------------------+--------------------------------------------------------------------------------+-----------+
|
|
| :ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` | :ref:`billboard_type<class_VisualShaderNodeBillboard_property_billboard_type>` | ``1`` |
|
|
+--------------------------------------------------------------------+--------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`keep_scale<class_VisualShaderNodeBillboard_property_keep_scale>` | ``false`` |
|
|
+--------------------------------------------------------------------+--------------------------------------------------------------------------------+-----------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualShaderNodeBillboard_BillboardType:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **BillboardType**: :ref:`🔗<enum_VisualShaderNodeBillboard_BillboardType>`
|
|
|
|
.. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_DISABLED:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` **BILLBOARD_TYPE_DISABLED** = ``0``
|
|
|
|
Billboarding is disabled and the node does nothing.
|
|
|
|
.. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_ENABLED:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` **BILLBOARD_TYPE_ENABLED** = ``1``
|
|
|
|
A standard billboarding algorithm is enabled.
|
|
|
|
.. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_FIXED_Y:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` **BILLBOARD_TYPE_FIXED_Y** = ``2``
|
|
|
|
A billboarding algorithm to rotate around Y-axis is enabled.
|
|
|
|
.. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_PARTICLES:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` **BILLBOARD_TYPE_PARTICLES** = ``3``
|
|
|
|
A billboarding algorithm designed to use on particles is enabled.
|
|
|
|
.. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` **BILLBOARD_TYPE_MAX** = ``4``
|
|
|
|
Represents the size of the :ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` enum.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeBillboard_property_billboard_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` **billboard_type** = ``1`` :ref:`🔗<class_VisualShaderNodeBillboard_property_billboard_type>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_billboard_type**\ (\ value\: :ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>`\ )
|
|
- :ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` **get_billboard_type**\ (\ )
|
|
|
|
Controls how the object faces the camera.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_VisualShaderNodeBillboard_property_keep_scale:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **keep_scale** = ``false`` :ref:`🔗<class_VisualShaderNodeBillboard_property_keep_scale>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_keep_scale_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **is_keep_scale_enabled**\ (\ )
|
|
|
|
If ``true``, the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|