Skip to content

Document mesh map node and add short/long desc. #890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions addons/material_maker/engine/nodes/gen_meshmap.gd
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,13 @@ func get_type() -> String:
func get_type_name() -> String:
return "Mesh Map"

func get_description() -> String:
var desc_list : PackedStringArray = PackedStringArray()
desc_list.push_back(TranslationServer.translate("Mesh Map"))
var longdesc = "Generates mesh maps for the current custom mesh"
desc_list.push_back(TranslationServer.translate(longdesc))
return "\n".join(desc_list)

func get_parameter_defs() -> Array:
return [
{ name="map", type="enum", values=MESH_MAPS, label="Map", default=0 },
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions material_maker/doc/node_miscellaneous_mesh_map.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Mesh Map node
~~~~~~~~~~~~~

**Mesh Map** node bakes maps for the current custom mesh and recalculates
automatically when a new mesh is selected in the 3D preview.

.. image:: images/node_miscellaneous_mesh_map.png
:align: center

Inputs
++++++

The **Mesh Map** node does not accept any input.

Outputs
+++++++

The **Mesh Map** node outputs the selected generated map, which can be the following:

* Position, Normal, Tangent, Minimum/Maximum Curvature, Cavity, Pointiness, Ambient Occulusion, Bent Normals, Thickness, Adjacency

Example Images
++++++++++++++
.. image:: images/screenshot_mesh_map.jpg
:align: center
1 change: 1 addition & 0 deletions material_maker/doc/nodes_miscellaneous.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Miscellaneous nodes
node_miscellaneous_debug
node_miscellaneous_variations
node_miscellaneous_randomize
node_miscellaneous_mesh_map