class_visualshadernodevectorbase.rst 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVectorBase.xml.
  6. .. _class_VisualShaderNodeVectorBase:
  7. VisualShaderNodeVectorBase
  8. ==========================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`VisualShaderNodeFaceForward<class_VisualShaderNodeFaceForward>`, :ref:`VisualShaderNodeVectorCompose<class_VisualShaderNodeVectorCompose>`, :ref:`VisualShaderNodeVectorDecompose<class_VisualShaderNodeVectorDecompose>`, :ref:`VisualShaderNodeVectorDistance<class_VisualShaderNodeVectorDistance>`, :ref:`VisualShaderNodeVectorFunc<class_VisualShaderNodeVectorFunc>`, :ref:`VisualShaderNodeVectorLen<class_VisualShaderNodeVectorLen>`, :ref:`VisualShaderNodeVectorOp<class_VisualShaderNodeVectorOp>`
  11. A base type for the nodes using different vector types within the visual shader graph.
  12. Properties
  13. ----------
  14. +-------------------------------------------------------+-------------------------------------------------------------------+-------+
  15. | :ref:`OpType<enum_VisualShaderNodeVectorBase_OpType>` | :ref:`op_type<class_VisualShaderNodeVectorBase_property_op_type>` | ``1`` |
  16. +-------------------------------------------------------+-------------------------------------------------------------------+-------+
  17. Enumerations
  18. ------------
  19. .. _enum_VisualShaderNodeVectorBase_OpType:
  20. .. _class_VisualShaderNodeVectorBase_constant_OP_TYPE_VECTOR_2D:
  21. .. _class_VisualShaderNodeVectorBase_constant_OP_TYPE_VECTOR_3D:
  22. .. _class_VisualShaderNodeVectorBase_constant_OP_TYPE_VECTOR_4D:
  23. .. _class_VisualShaderNodeVectorBase_constant_OP_TYPE_MAX:
  24. enum **OpType**:
  25. - **OP_TYPE_VECTOR_2D** = **0** --- A 2D vector type.
  26. - **OP_TYPE_VECTOR_3D** = **1** --- A 3D vector type.
  27. - **OP_TYPE_VECTOR_4D** = **2** --- A 4D vector type.
  28. - **OP_TYPE_MAX** = **3** --- Represents the size of the :ref:`OpType<enum_VisualShaderNodeVectorBase_OpType>` enum.
  29. Property Descriptions
  30. ---------------------
  31. .. _class_VisualShaderNodeVectorBase_property_op_type:
  32. - :ref:`OpType<enum_VisualShaderNodeVectorBase_OpType>` **op_type**
  33. +-----------+--------------------+
  34. | *Default* | ``1`` |
  35. +-----------+--------------------+
  36. | *Setter* | set_op_type(value) |
  37. +-----------+--------------------+
  38. | *Getter* | get_op_type() |
  39. +-----------+--------------------+
  40. A base type.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  43. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  44. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  45. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  46. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`