Overhauled OpenVDB Clip SOP camera frustum padding + misc QOL changes #1818
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Clip SOPs handling of frustum clipping was odd in several ways, and this caused confusion among users. Padding in particular was opaque and unintuitive. This change implements more consistent and explainable padding for the camera clipping mode. Padding is specified and applied in normalized device coordinates. Rather than reading the same float3 padding parm used by the other modes, this new implementation adds float2 parms 'padwinx' and 'padwiny', specifying the amount of padding to add on the left/right and top/bottom sides of the camera frustum. These are enabled only in camera mode. Padding is applied symmetrically by default, similar to the old method, but can be made asymmetric by unlinking the parameters. There is no Z-axis padding value, as the near/far plane override parameters make this functionality redundant. A `legacycamclip` toggle was added to optionally revert back to the original implementation for compatibility reasons. To implement this change, it was necessary to make minor modifications to the clipping implementation in the OpenVDB library. A padding arg was added for the camera frustum signature of `clip`. A similar change was made to the `hvdb::drawFrustum()` function. All other changes were made just to the SOP itself. **Additional Changes:** + Tooltips and documentation for the node's parameters have been updated and expanded. + Some parameters that were previously non-animatable can now be animated. There was no documented reason given for them being fixed, and I've observed no issues with their being animated. It is the padding (old and new) and near/far clipping plane parameters which have been changed. + The `xVoxelCount` argument of `hvdb::frustumTransformFromCamera()` is now set to the cameras x-resolution, avoiding the rounding error that previously made the resulting frustum slightly inaccurate. + Mask clipping mode now disables the y and z components of the 'padding' parm, to indicate that only uniform padding is supported in that mode. + When clipping in mask mode, the warning regarding nonuniform not being supported previously triggered whenever the three 'padding' values were not equal. This caused it to be raised for valid non-zero values as well. I've fixed it to trigger only when the y or z components are non-zero. Signed-off-by: Kolton Yager <[email protected]>
|
|
|
/easycla |
1 similar comment
|
/easycla |
kjyager
commented
May 16, 2024
| .setDocumentation( | ||
| "Enables legacy camera clipping implementation and controls.\n\n" | ||
|
|
||
| "Implementation used prior to (OpenVDB version - / Houdini -). Overestimates " |
There was a problem hiding this comment.
I've bookmarked the doc-string here so that version numbers can be added when they are known later.
| @@ -454,24 +517,36 @@ SOP_OpenVDB_Clip::Cache::getFrustum(OP_Context& context) | |||
| } | |||
|
|
|||
| const bool pad = (0 != evalInt("setpadding", 0, time)); | |||
| const auto padding = pad ? evalVec3f("padding", time) : openvdb::Vec3f{0}; | |||
| const bool useLegacyPadding = evalInt("legacycamclip", 0, 0.0f); | |||
There was a problem hiding this comment.
Legacy clipping toggle is non-animatable, so evaluating at t = 0 is correct.
|
Suggesting that Jeff Lait also review |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Clip SOPs handling of frustum clipping was odd in several ways, and this caused confusion among users. Padding in particular was opaque and unintuitive.
This change implements more consistent and explainable padding for the camera clipping mode. Padding is specified and applied in normalized device coordinates. Rather than reading the same float3 padding parm used by the other modes, this new implementation adds float2 parms 'padwinx' and 'padwiny', specifying the amount of padding to add on the left/right and top/bottom sides of the camera frustum. These are enabled only in camera mode. Padding is applied symmetrically by default, similar to the old method, but can be made asymmetric by unlinking the parameters. There is no Z-axis padding value, as the near/far plane override parameters make this functionality redundant.
A
legacycamcliptoggle was added to optionally revert back to the original implementation for compatibility reasons.To implement this change, it was necessary to make minor modifications to the clipping implementation in the OpenVDB library. A padding arg was added for the camera frustum signature of
clip. A similar change was made to thehvdb::drawFrustum()function. All other changes were made just to the SOP itself.Additional Changes:
xVoxelCountargument ofhvdb::frustumTransformFromCamera()is now set to the cameras x-resolution, avoiding the rounding error that previously made the resulting frustum slightly inaccurate.