Project load: use kOfxChangePluginEdited, not kOfxChangeUserEdited, for the clip instanceChanged

Abierto Apto para principiantes
#294 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
80/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
c, cpp

Línea de trabajo

Abre include/ofxCore.h alrededor de L362-L365, el bloque de documentación de kOfxActionCreateInstance, y cambia el motivo del clip instanceChanged a kOfxChangePluginEdited. Contrasta los dos lugares que el issue dice que ya coinciden: la documentación de kOfxActionInstanceChanged en L449-L454 del mismo archivo y release-notes-next.md L25. Está terminado cuando los tres nombren kOfxChangePluginEdited y un grep de kOfxChangeUserEdited en los docs no encuentre nada relevante.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Problem

At project load, a plug-in must be able to tell whether a clip connection comes from a user connecting a clip for the first time (when it may change some values) or simply from loading a saved state. With kOfxChangeUserEdited it can't.

Many plug-ins set parameters from an input when the user connects it, on kOfxChangeUserEdited. Examples: setting a filter's premultiplication, or a writer's output premultiplication and frame rate, from the connected input. At project load these values are already restored, so a kOfxChangeUserEdited clip change overwrites them.

Timeline in #184 (implemented by PR #191):

  • 2025-05-06, @fxtech: Silhouette sends kOfxChangePluginEdited.
  • 2025-05-06, @Guido-assim: asked for kOfxChangeUserEdited, which Scratch uses: "the user/host attached the clips".
  • 2025-05-07, @fxtech: argued for kOfxChangePluginEdited, because kOfxChangeUserEdited "implies that the user directly fiddled with something": a preset menu would otherwise trigger again on project load and override values.
  • 2025-05-07, @fxtech: for clips, "I don't think it would matter" which reason.
  • 2025-05-08, @garyo: "let's go with kOfxChangeUserEdited since it's already out there in at least one host. I'll make that update in the PR." That update is ae64194, the same day.
  • 2025-06-03, @fxtech: "I switched Silhouette to pass kOfxChangeUserEdited for clip hookups."

As shown above, and as in @fxtech's preset example, the reason does matter for clips too. The kOfxActionInstanceChanged doc (ofxCore.h L449-L454) and the release notes (release-notes-next.md L25, written later in #254) still say kOfxChangePluginEdited.

Proposal: change the kOfxActionCreateInstance doc (ofxCore.h L364) back to kOfxChangePluginEdited, so all three agree.

Lenguaje dominante
C++
Estrellas
590
Forks
160
Merge medio
2 d 22 h
PR fusionados (30 d)
3

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de AcademySoftwareFoundation/openfx

Todos los issues de AcademySoftwareFoundation/openfx

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.