| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the VisualShaderNodeBillboard.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _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.
- Description
- -----------
- The output port of this node needs to be connected to ``Model View Matrix`` port of :ref:`VisualShaderNodeOutput<class_VisualShaderNodeOutput>`.
- Properties
- ----------
- +--------------------------------------------------------------------+--------------------------------------------------------------------------------+-----------+
- | :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`` |
- +--------------------------------------------------------------------+--------------------------------------------------------------------------------+-----------+
- Enumerations
- ------------
- .. _enum_VisualShaderNodeBillboard_BillboardType:
- .. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_DISABLED:
- .. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_ENABLED:
- .. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_FIXED_Y:
- .. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_PARTICLES:
- .. _class_VisualShaderNodeBillboard_constant_BILLBOARD_TYPE_MAX:
- enum **BillboardType**:
- - **BILLBOARD_TYPE_DISABLED** = **0** --- Billboarding is disabled and the node does nothing.
- - **BILLBOARD_TYPE_ENABLED** = **1** --- A standard billboarding algorithm is enabled.
- - **BILLBOARD_TYPE_FIXED_Y** = **2** --- A billboarding algorithm to rotate around Y-axis is enabled.
- - **BILLBOARD_TYPE_PARTICLES** = **3** --- A billboarding algorithm designed to use on particles is enabled.
- - **BILLBOARD_TYPE_MAX** = **4** --- Represents the size of the :ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` enum.
- Property Descriptions
- ---------------------
- .. _class_VisualShaderNodeBillboard_property_billboard_type:
- - :ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>` **billboard_type**
- +-----------+---------------------------+
- | *Default* | ``1`` |
- +-----------+---------------------------+
- | *Setter* | set_billboard_type(value) |
- +-----------+---------------------------+
- | *Getter* | get_billboard_type() |
- +-----------+---------------------------+
- Controls how the object faces the camera. See :ref:`BillboardType<enum_VisualShaderNodeBillboard_BillboardType>`.
- ----
- .. _class_VisualShaderNodeBillboard_property_keep_scale:
- - :ref:`bool<class_bool>` **keep_scale**
- +-----------+-------------------------------+
- | *Default* | ``false`` |
- +-----------+-------------------------------+
- | *Setter* | set_keep_scale_enabled(value) |
- +-----------+-------------------------------+
- | *Getter* | 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.)`
- .. |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.)`
|
