VisualShaderNodeBillboard.xml 1.7 KB

123456789101112131415161718192021222324252627282930313233343536
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualShaderNodeBillboard" inherits="VisualShaderNode" version="4.0">
  3. <brief_description>
  4. A node that controls how the object faces the camera to be used within the visual shader graph.
  5. </brief_description>
  6. <description>
  7. The output port of this node needs to be connected to [code]Model View Matrix[/code] port of [VisualShaderNodeOutput].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <members>
  12. <member name="billboard_type" type="int" setter="set_billboard_type" getter="get_billboard_type" enum="VisualShaderNodeBillboard.BillboardType" default="1">
  13. Controls how the object faces the camera. See [enum BillboardType].
  14. </member>
  15. <member name="keep_scale" type="bool" setter="set_keep_scale_enabled" getter="is_keep_scale_enabled" default="false">
  16. If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding.
  17. </member>
  18. </members>
  19. <constants>
  20. <constant name="BILLBOARD_TYPE_DISABLED" value="0" enum="BillboardType">
  21. Billboarding is disabled and the node does nothing.
  22. </constant>
  23. <constant name="BILLBOARD_TYPE_ENABLED" value="1" enum="BillboardType">
  24. A standard billboarding algorithm is enabled.
  25. </constant>
  26. <constant name="BILLBOARD_TYPE_FIXED_Y" value="2" enum="BillboardType">
  27. A billboarding algorithm to rotate around Y-axis is enabled.
  28. </constant>
  29. <constant name="BILLBOARD_TYPE_PARTICLES" value="3" enum="BillboardType">
  30. A billboarding algorithm designed to use on particles is enabled.
  31. </constant>
  32. <constant name="BILLBOARD_TYPE_MAX" value="4" enum="BillboardType">
  33. Represents the size of the [enum BillboardType] enum.
  34. </constant>
  35. </constants>
  36. </class>