1 #ifndef DALI_INTERNAL_UPDATE_PROXY_IMPL_H
2 #define DALI_INTERNAL_UPDATE_PROXY_IMPL_H
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
26 #include <dali/public-api/common/vector-wrapper.h>
27 #include <dali/public-api/math/matrix.h>
28 #include <dali/public-api/math/vector3.h>
29 #include <dali/internal/common/buffer-index.h>
30 #include <dali/internal/update/manager/transform-manager.h>
31 #include <dali/internal/update/nodes/node.h>
45 * @brief The implementation of Dali::UpdateProxy.
47 * Ref-counting is not required for this object.
49 * @see Dali::UpdateProxy
57 * @param[in] updateManager Ref to the UpdateManager in order to add property resetters
58 * @param[in] transformManager Ref to the TransformManager in order to set/get transform properties of nodes
59 * @param[in] rootNode The root node for this proxy
61 UpdateProxy( SceneGraph::UpdateManager& updateManager, SceneGraph::TransformManager& transformManager, SceneGraph::Node& rootNode );
68 // Movable but not copyable
70 UpdateProxy( const UpdateProxy& ) = delete; ///< Deleted copy constructor.
71 UpdateProxy( UpdateProxy&& ) = default; ///< Default move constructor.
72 UpdateProxy& operator=( const UpdateProxy& ) = delete; ///< Deleted copy assignment operator.
73 UpdateProxy& operator=( UpdateProxy&& ) = default; ///< Default move assignment operator.
76 * @copydoc Dali::UpdateProxy::GetPosition()
78 bool GetPosition( uint32_t id, Vector3& position) const;
81 * @copydoc Dali::UpdateProxy::SetPosition()
83 bool SetPosition( uint32_t id, const Vector3& position );
86 * @copydoc Dali::UpdateProxy::BakePosition()
88 bool BakePosition( uint32_t id, const Vector3& position );
91 * @copydoc Dali::UpdateProxy::GetSize()
93 bool GetSize( uint32_t id, Vector3& size ) const;
96 * @copydoc Dali::UpdateProxy::SetSize()
98 bool SetSize( uint32_t id, const Vector3& size );
101 * @copydoc Dali::UpdateProxy::BakeSize()
103 bool BakeSize( uint32_t id, const Vector3& size );
106 * @copydoc Dali::UpdateProxy::GetPositionAndSize()
108 bool GetPositionAndSize( uint32_t id, Vector3& position, Vector3& size ) const;
111 * @copydoc Dali::UpdateProxy::GetScale()
113 bool GetScale( uint32_t id, Vector3& scale ) const;
116 * @copydoc Dali::UpdateProxy::SetScale()
118 bool SetScale( uint32_t id, const Vector3& scale );
121 * @copydoc Dali::UpdateProxy::BakeScale()
123 bool BakeScale( uint32_t id, const Vector3& scale );
126 * @copydoc Dali::UpdateProxy::GetColor()
128 bool GetColor( uint32_t id, Vector4& color ) const;
131 * @copydoc Dali::UpdateProxy::SetColor()
133 bool SetColor( uint32_t id, const Vector4& color );
136 * @copydoc Dali::UpdateProxy::BakeColor()
138 bool BakeColor( uint32_t id, const Vector4& color );
141 * @brief Retrieves the root-node used by this class
142 * @return The root node used by this class.
144 SceneGraph::Node& GetRootNode() const
150 * @brief Sets the buffer index to use when processing the next callback.
151 * @param[in] bufferIndex The current buffer index
153 void SetCurrentBufferIndex( BufferIndex bufferIndex )
155 mCurrentBufferIndex = bufferIndex;
159 * @brief Informs the update-proxy that the node hierarchy has changed.
161 void NodeHierarchyChanged();
166 * @brief Retrieves the node with the specified ID.
167 * @param[in] id The ID of the node required
168 * @return A pointer to the required node if found.
169 * @note This caches the last accessed node.
171 SceneGraph::Node* GetNodeWithId( uint32_t id ) const;
174 * @brief Adds a property-resetter for non-transform properties so that they can be reset to their base value every frame.
175 * @param[in] node The node the property belongs to
176 * @param[in] propertyBase The property itself
178 void AddResetter( SceneGraph::Node& node, SceneGraph::PropertyBase& propertyBase );
183 * Structure to store the ID & Node pair
187 uint32_t id; ///< The ID of the node
188 SceneGraph::Node* node; ///< The node itself
191 class PropertyModifier;
192 using PropertyModifierPtr = std::unique_ptr< PropertyModifier >;
194 mutable std::vector< IdNodePair > mNodeContainer; ///< Used to store cached pointers to already searched for Nodes.
195 mutable IdNodePair mLastCachedIdNodePair; ///< Used to cache the last retrieved id-node pair.
196 BufferIndex mCurrentBufferIndex;
198 SceneGraph::UpdateManager& mUpdateManager; ///< Reference to the Update Manager.
199 SceneGraph::TransformManager& mTransformManager; ///< Reference to the Transform Manager.
200 SceneGraph::Node& mRootNode; ///< The root node of this update proxy.
202 PropertyModifierPtr mPropertyModifier; ///< To ensure non-transform property modifications reset to base values.
205 } // namespace Internal
209 #endif // DALI_INTERNAL_UPDATE_PROXY_IMPL_H