1 #ifndef DALI_SCENE3D_LOADER_UTILS_H_
2 #define DALI_SCENE3D_LOADER_UTILS_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/actors/actor.h>
22 #include <dali/public-api/common/dali-common.h>
23 #include <dali/public-api/rendering/renderer.h>
28 #include <dali-scene3d/public-api/api.h>
30 namespace Dali::Scene3D::Loader
33 * @brief Fixed size backing buffer to use with std::ostreams where control over allocations (which this does not make), is required.
35 * @note All stream insertions that would overflow the buffer that StreamBuffer was created with, will fail.
37 class DALI_SCENE3D_API StreamBuffer : public std::basic_streambuf<char>
40 StreamBuffer(char* buffer, size_t size) noexcept(true);
44 * @brief Wraps an ostream with a pre-allocated, fixed size backing buffer which a message can be formatted into.
46 * Upon destruction, it throws a DaliException with the message.
49 class DALI_SCENE3D_API ExceptionFlinger
54 MESSAGE_BUFFER_SIZE = 512
57 ExceptionFlinger(const char* location) noexcept(true);
59 [[noreturn]] ~ExceptionFlinger() noexcept(false);
62 ExceptionFlinger& operator<<(const T& rhs) noexcept(true)
71 const char* mLocation;
73 [[noreturn]] ~Impl() noexcept(false);
76 static char* GetMessageBuffer() noexcept(true);
79 StreamBuffer mStreamBuffer;
84 * @brief Formats the given printf-style varargs into a std::string.
87 DALI_SCENE3D_API std::string FormatString(const char* format, ...);
90 * @brief The @n th bit in a bitmask.
92 * @return The @n th bit in a bitmask
94 DALI_SCENE3D_API constexpr size_t NthBit(size_t n)
100 * @brief Whether all of @a mask 's bits are set on @a value.
102 * @return Whether all of @a mask 's bits are set on @a value
104 inline DALI_SCENE3D_API bool MaskMatch(uint32_t value, uint32_t mask)
106 return (value & mask) == mask;
110 * @brief Convert a four-letter(, null-terminated) string literal into a uint32_t.
113 inline DALI_SCENE3D_API constexpr uint32_t FourCC(const char (&fourCC)[5])
115 return (fourCC[3] << 24) | (fourCC[2] << 16) | (fourCC[1] << 8) | fourCC[0];
119 * @brief Insensitive case compare function.
121 * @param[in] a compare string
122 * @param[in] b compare string
123 * @return true if strings are equal
125 inline DALI_SCENE3D_API bool CaseInsensitiveCharacterCompare(unsigned char a, unsigned char b)
127 // Converts to lower case in the current locale.
128 return std::tolower(a) == std::tolower(b);
132 * @return true if the lower cased ASCII strings are equal.
134 * @param[in] a compare string
135 * @param[in] b compare string
137 inline DALI_SCENE3D_API bool CaseInsensitiveStringCompare(const std::string& a, const std::string& b)
140 if(a.length() == b.length())
142 result = std::equal(a.begin(), a.end(), b.begin(), &CaseInsensitiveCharacterCompare);
148 * @brief Attempts to load the contents of a text file; returns empty string on failure.
150 * A pointer to a boolean may be passed in @a fail; this will be set to true in case of failure
151 * (should only be checked if the returned string was empty()).
154 DALI_SCENE3D_API std::string LoadTextFile(const char* path, bool* fail = nullptr);
157 * @brief Makes a number of calls to @a fn, passing to each one the given @a actor then each of its children, in depth-first traversal.
160 * @note @a fn must not change the actor hierarchy during traversal.
161 * @note Use of a @a fn that is itself recursing in @a is also discouraged
162 * for performance and stability reasons.
164 template<typename Func>
165 inline DALI_SCENE3D_API void VisitActor(Actor a, Func fn)
169 unsigned int numChildren = a.GetChildCount();
170 for(unsigned int i = 0; i < numChildren; ++i)
172 VisitActor(a.GetChildAt(i), fn);
177 * @brief Convenience function to set the given actor @a 's anchor point and parent origin to center.
180 inline DALI_SCENE3D_API void SetActorCentered(Actor a)
182 a.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
183 a.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
186 namespace TexturedQuadOptions
188 using Type = uint32_t;
190 enum DALI_SCENE3D_API Values : Type
193 FLIP_VERTICAL = 0x01,
195 } // namespace TexturedQuadOptions
198 * @brief Makes... geometry for a textured quad.
201 DALI_SCENE3D_API Geometry MakeTexturedQuadGeometry(TexturedQuadOptions::Type options = TexturedQuadOptions::NONE);
204 * @brief Fixes the path of a file. Replaces the '\\' separator by the '/' one.
206 * @param[in,out] path The path to be fixed.
208 DALI_SCENE3D_API void ToUnixFileSeparators(std::string& path);
210 } // namespace Dali::Scene3D::Loader
212 #endif /* DALI_SCENE3D_LOADER_UTILS_H_ */