Skip to content
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

Add documentation for VoxelModifier classes #667

Merged
merged 2 commits into from
Jun 16, 2024

Conversation

Piratux
Copy link
Contributor

@Piratux Piratux commented Jun 15, 2024

Add documentation for VoxelModifier, VoxelModifierSphere and VoxelModifierMesh classes.

</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="isolevel" type="float" setter="set_isolevel" getter="get_isolevel" default="0.0">
Offsets isolevel of SDF mesh. Increasing this value makes object appear thicker and vice versa.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Increasing makes the object thinner actually

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what you mean by that.
Positive isolevel makes mesh bigger (thus thicker).
Negative isolevel makes mesh smaller (thinner).

Positive isolevel:
image

Negative isolevel:
image

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, sorry, indeed raising isolevel means there is more under the surface so it gets bigger.

</description>
<tutorials>
</tutorials>
<members>
<member name="operation" type="int" setter="set_operation" getter="get_operation" enum="VoxelModifier.Operation" default="0">
An operation modifier performs on the terrain or to other modifiers.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*the

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@Zylann Zylann merged commit f687c6f into Zylann:master Jun 16, 2024
22 of 23 checks passed
@Piratux Piratux deleted the doc-contribution-voxel-modifier branch June 16, 2024 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants