AcademySoftwareFoundation/openvdb

Migrate VDB version check to SOP_NodeVDB

Open

#614 opened on Jan 23, 2020

View on GitHub
 (15 comments) (0 reactions) (0 assignees)C++ (762 forks)auto 404
good first issue

Repository metrics

Stars
 (3,343 stars)
PR merge metrics
 (PR metrics pending)

Description

SOP_OpenVDB_Scatter overrides the syncNodeVersion() with a check for the version of VDB the SOP was placed in:

https://github.com/AcademySoftwareFoundation/openvdb/blob/master/openvdb_houdini/SOP_OpenVDB_Scatter.cc#L256

We'd like to move the portion that does the version comparison up into SOP_NodeVDB, something like:

int SOP_NodeVDB::compareVersionString(const char* oldVersion, const char* nodeVersion);

and then change the SOP_OpenVDB_Scatter implementation to use this method so that other SOPs don't need to encode this version logic.

This needs to take account of the fact that the version string has only changed recently:

VDB 6.0.0 - "17.5.204" VDB 6.1.0 - "17.5.204" VDB 6.2.0 - "vdb6.2.0 houdini17.5.204" VDB 6.2.1 - "vdb6.2.1 houdini17.5.204" VDB 7.0.0 - "vdb7.0.0 houdini17.5.204"

Houdini version can be ignored for now, it's only the VDB version we care about.

Contributor guide

Research direction
Familiarize yourself with the existing syncNodeVersion() implementation in SOP OpenVDB Scatter.cc. Understand the version string format as listed. Then design a compareVersionString method that parses the VDB version and compares it. Move the logic to SOP NodeVDB and refactor the scatter SOP to call the new method. Also check if other SOPs have similar version checks that could be updated.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75