1 #ifndef DALI_SCENE3D_LOADER_CUSTOMIZATION_STATE_H_
2 #define DALI_SCENE3D_LOADER_CUSTOMIZATION_STATE_H_
4 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 #include <dali/public-api/common/vector-wrapper.h>
26 #include <dali-scene3d/public-api/api.h>
28 namespace Dali::Scene3D::Loader
31 * @brief Offers a description of an aspect of the scene that can be customized:
32 * the number of options, and the name of the nodes that are registered
33 * for the tag, whose children will be shown / hidden based on selection.
36 struct DALI_SCENE3D_API Customization
38 using Tag = std::string;
39 using OptionType = uint32_t;
42 * @brief A mapping of customizations to tags.
45 struct DALI_SCENE3D_API Map
51 * @brief Maps the given @a customization to the given @a tag, overwriting any previous mapping to the same tag.
53 * @return Pointer to the inserted (or pre-existing) Customization instance.
55 Customization* Set(Tag tag, Customization&& customization);
58 * @brief Attempts to retrieve a const Customization based on the given @a tag.
61 const Customization* Get(Tag tag) const;
64 * @brief Attempts to retrieve a Customization based on the given @a tag.
67 Customization* Get(Tag tag);
70 * @brief Returns the number of elements.
73 uint32_t Size() const;
76 * @brief Removes every element from the Map.
83 const std::unique_ptr<Impl> mImpl;
87 * @brief A mapping of choices - indices of children of customization nodes to use - to tags.
90 struct DALI_SCENE3D_API Choices
96 * @brief Maps the given @a option to the given @a tag, overwriting any previous mapping to the same tag.
99 void Set(Tag tag, OptionType option);
102 * @brief Attempts to retrieve a Customization based on the given @a tag.
104 * @return A Customization based on the given @a tag.
105 * @note Returns NONE if @a tag is not known.
107 OptionType Get(Tag tag) const;
110 * @brief Returns the number of elements.
112 * @return The number of elements.
114 uint32_t Size() const;
117 * @brief Removes every element from the underlying map.
124 const std::unique_ptr<Impl> mImpl;
127 static const OptionType NONE = OptionType(-1);
129 OptionType numOptions = 0;
130 std::vector<std::string> nodes; // to apply option to.
133 } // namespace Dali::Scene3D::Loader
135 #endif //DALI_SCENE3D_LOADER_CUSTOMIZATION_STATE_H_