SG-39445: Enable participants to broadcast annotations in Collaborative mode for OTIO-based Live Review sessions #960
Conversation
eloisebrosseau
requested review from
bernie-laberge and
cedrik-fuoco-adsk
as code owners
eloisebrosseau
force-pushed
the
annotation-muc
branch
2 times, most recently
from
e2a253a to
297f71d
Compare
| setCurrentAnnotateModeNode """ | ||
| Set the Paint node to use for the _currentNode in the annotate mode. | ||
| If the node is not a valid Paint node or if it is set to an empty string | ||
| (i.e. ""), the _currentNode value will not be overridden. |
There was a problem hiding this comment.
To make it more explicit how to undo this setCurrentAnnotateModeNode(), should we add ?
Therefore, you can reset its action by specifying an empty string to setCurrentAnnotateModeNode().
(I know that the text is legally correct. But when I first read it I was wondering how to reset it and double checked in the code).
Totally optional comment. Feel free to ignore.
There was a problem hiding this comment.
I think your first sentence might be missing some words. What are you suggesting to add? I am using the empty string to make sure the current node is reset at the end of a Live Review session in my Commercial RV. I could add a sentence explicitly stating that calling setCurrentAnnotateModeNode() with an empty string will reset its behaviour to make it clearer
There was a problem hiding this comment.
Yes that's what I meant:
calling setCurrentAnnotateModeNode() with an empty string will reset its behaviour.
src/lib/ip/IPMu/CommandsModule.cpp
Outdated
| NODE_RETURN(int(s->getSessionType())); | ||
| } | ||
|
|
||
| NODE_IMPLEMENTATION(setCurrentAnnotateModeNode, void) |
There was a problem hiding this comment.
I am wondering, should we really add an RV command for this ?
Why couldn't Live Review simply issue the following Annotation package specific event ?
commands.sendInternalEvent("set-current-annotate-mode-node", nodeName)
There was a problem hiding this comment.
That's a philosophical question: Since that annotate_mode.mu is a package that could potentially be replaced by some other package in the future, does it make sense to add an rv command that communicates with the annotation_mode.mu package ? while Live Review could interact directly with the annotation_mode.mu package via commands.sendInternalEvent() ?
There was a problem hiding this comment.
I thought it would be documented more clearly this way, but since I'm already validating the input inside the annotate-mode package, I agree that I should have simply sent the event with the nodeName. I'll make the change and add the documentation in the internal events page instead of commands.mud
|
|
||
| method: activate (void;) | ||
| { | ||
| sendInternalEvent("annotate-mode-activated"); |
There was a problem hiding this comment.
Shouldn't we set the event after it has actually been activated ? (After setTags()) ?
There was a problem hiding this comment.
Sure, I'll change it!
Signed-off-by: Éloïse Brosseau <[email protected]>
Signed-off-by: Éloïse Brosseau <[email protected]>
Signed-off-by: Éloïse Brosseau <[email protected]>
Signed-off-by: Éloïse Brosseau <[email protected]>
Signed-off-by: Éloïse Brosseau <[email protected]>
… command Signed-off-by: Éloïse Brosseau <[email protected]>
Signed-off-by: Éloïse Brosseau <[email protected]>
eloisebrosseau
force-pushed
the
annotation-muc
branch
from
64559da to
d2164c0
Compare
3 participants
SG-39445: Enable participants to broadcast annotations in Collaborative mode for OTIO-based Live Review sessions
Summarize your change.
setCurrentAnnotateModeNodein rv.commands to manually set the Paint node to use when manipulating stokes in annotate_modeRenderOverModeto prevent the code from throwing an exception when trying to get the value. This is necessary to know if the user is erasing or painting before sending an annotations payload.Describe the reason for the change.
All the changes mentioned above are needed to properly enable participants to broadcast annotations in Collaborative mode for OTIO-based Live Review sessions.
Describe what you have tested and on which operating system.
Drawing strokes with the pen and the eraser tools while being a participant of an OTIO-based Live Review session with Collaborative mode enable. The tests were done on macOS 15.6.1