Skip to content

Commit 1456d06

Browse files
sammy-SCfacebook-github-bot
authored andcommitted
add comment explaining why addListener and removeListeners are not needed (#52062)
Summary: Pull Request resolved: #52062 changelog: [internal] - update comments to be more descriptive. - use `#pragma mark -` to better group methods in `NativeAnimatedNodesManager`. It is nicely formatted in VSCode. {F1979345410} Reviewed By: mdvacca Differential Revision: D76737257 fbshipit-source-id: c4b22ca45cd5dec2c72e7931bfec4466cda3070c
1 parent 7bfadb4 commit 1456d06

File tree

3 files changed

+18
-10
lines changed

3 files changed

+18
-10
lines changed

packages/react-native/ReactCxxPlatform/react/renderer/animated/AnimatedModule.cpp

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ void AnimatedModule::updateAnimatedNodeConfig(
5656
jsi::Runtime& rt,
5757
Tag tag,
5858
jsi::Object config) {
59-
// TODO(T196513045): missing implementation
59+
// TODO(T196513045): missing implementation. This API is only used by Animated
60+
// when PlatformColor API is used and animation is updated with a new value
61+
// through AnimatedColor.setValue.
6062
}
6163

6264
void AnimatedModule::getValue(
@@ -191,11 +193,15 @@ void AnimatedModule::removeAnimatedEventFromView(
191193
void AnimatedModule::addListener(
192194
jsi::Runtime& /*rt*/,
193195
const std::string& /*eventName*/) {
194-
// TODO(T225953415): missing implementation
196+
// Not needed in C++ Animated. addListener is used to synchronise event
197+
// animations like onScroll with React and Fabric. However C++ Animated
198+
// synchronises with Fabric directly.
195199
}
196200

197201
void AnimatedModule::removeListeners(jsi::Runtime& /*rt*/, int /*count*/) {
198-
// TODO(T225953457): missing implementation
202+
// Not needed in C++ Animated. removeListeners is used to synchronise event
203+
// animations like onScroll with React and Fabric. However C++ Animated
204+
// synchronises with Fabric directly.
199205
}
200206

201207
void AnimatedModule::queueAndExecuteBatchedOperations(

packages/react-native/ReactCxxPlatform/react/renderer/animated/NativeAnimatedNodesManager.cpp

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ std::optional<double> NativeAnimatedNodesManager::getValue(Tag tag) noexcept {
8787
}
8888
}
8989

90-
// graph
90+
#pragma mark - Graph
9191

9292
std::unique_ptr<AnimatedNode> NativeAnimatedNodesManager::animatedNode(
9393
Tag tag,
@@ -235,7 +235,7 @@ void NativeAnimatedNodesManager::dropAnimatedNode(Tag tag) noexcept {
235235
animatedNodes_.erase(tag);
236236
}
237237

238-
// mutations
238+
#pragma mark - Mutations
239239

240240
void NativeAnimatedNodesManager::setAnimatedNodeValue(Tag tag, double value) {
241241
if (auto node = getAnimatedNode<ValueAnimatedNode>(tag)) {
@@ -280,7 +280,7 @@ void NativeAnimatedNodesManager::stopAnimationsForNode(Tag nodeTag) {
280280
}
281281
}
282282

283-
// drivers
283+
#pragma mark - Drivers
284284

285285
void NativeAnimatedNodesManager::startAnimatingNode(
286286
int animationId,
@@ -701,7 +701,8 @@ bool NativeAnimatedNodesManager::isOnRenderThread() const noexcept {
701701
return isOnRenderThread_;
702702
}
703703

704-
// listeners
704+
#pragma mark - Listeners
705+
705706
void NativeAnimatedNodesManager::startListeningToAnimatedNodeValue(
706707
Tag tag,
707708
ValueListenerCallback&& callback) noexcept {

packages/react-native/ReactCxxPlatform/react/renderer/animated/NativeAnimatedNodesManager.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ class NativeAnimatedNodesManager {
7878

7979
std::optional<double> getValue(Tag tag) noexcept;
8080

81-
// graph
81+
#pragma mark - Graph
8282

8383
void createAnimatedNode(Tag tag, const folly::dynamic& config) noexcept;
8484

@@ -102,7 +102,7 @@ class NativeAnimatedNodesManager {
102102

103103
void setAnimatedNodeOffset(Tag tag, double offset);
104104

105-
// drivers
105+
#pragma mark - Drivers
106106

107107
void startAnimatingNode(
108108
int animationId,
@@ -127,7 +127,8 @@ class NativeAnimatedNodesManager {
127127
std::shared_ptr<EventEmitterListener> getEventEmitterListener() noexcept {
128128
return ensureEventEmitterListener();
129129
}
130-
// listeners
130+
131+
#pragma mark - Listeners
131132

132133
void startListeningToAnimatedNodeValue(
133134
Tag tag,

0 commit comments

Comments
 (0)