1 #ifndef DALI_SCENE3D_LOADER_UTILS_H_
2 #define DALI_SCENE3D_LOADER_UTILS_H_
4 * Copyright (c) 2022 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-scene3d/public-api/api.h"
26 #include "dali/public-api/actors/actor.h"
27 #include "dali/public-api/common/dali-common.h"
28 #include "dali/public-api/rendering/renderer.h"
37 * @brief Fixed size backing buffer to use with std::ostreams where control over
38 * allocations (which this does not make), is required.
39 * @note All stream insertions that would overflow the buffer that StreamBuffer
40 * was created with, will fail.
42 class DALI_SCENE3D_API StreamBuffer : public std::basic_streambuf<char>
45 StreamBuffer(char* buffer, size_t size) noexcept(true);
49 * @brief Wraps an ostream with a pre-allocated, fixed size backing buffer
50 * which a message can be formatted into. Upon destruction, it throws a
51 * DaliException with the message.
53 class DALI_SCENE3D_API ExceptionFlinger
58 MESSAGE_BUFFER_SIZE = 512
61 ExceptionFlinger(const char* location) noexcept(true);
63 [[noreturn]] ~ExceptionFlinger() noexcept(false);
66 ExceptionFlinger& operator<<(const T& rhs) noexcept(true)
75 const char* mLocation;
77 [[noreturn]] ~Impl() noexcept(false);
80 static char* GetMessageBuffer() noexcept(true);
83 StreamBuffer mStreamBuffer;
88 * @brief Formats the given printf-style varargs into a std::string.
90 DALI_SCENE3D_API std::string FormatString(const char* format, ...);
93 * @return The @n th bit in a bitmask.
95 DALI_SCENE3D_API constexpr size_t NthBit(size_t n)
101 * @return Whether all of @a mask 's bits are set on @a value.
103 inline DALI_SCENE3D_API bool MaskMatch(uint32_t value, uint32_t mask)
105 return (value & mask) == mask;
109 * @brief Convert a four-letter(, null-terminated) string literal into a uint32_t.
111 inline DALI_SCENE3D_API constexpr uint32_t FourCC(const char (&fourCC)[5])
113 return (fourCC[3] << 24) | (fourCC[2] << 16) | (fourCC[1] << 8) | fourCC[0];
117 * @brief Insensitive case compare function.
118 * @param[in] a, compare string
119 * @param[in] b, compare string
120 * @return true if strings are equal
122 inline DALI_SCENE3D_API bool CaseInsensitiveCharacterCompare(unsigned char a, unsigned char b)
124 // Converts to lower case in the current locale.
125 return std::tolower(a) == std::tolower(b);
129 * @return true if the lower cased ASCII strings are equal.
130 * @param[in] a, compare string
131 * @param[in] b, compare string
133 inline DALI_SCENE3D_API bool CaseInsensitiveStringCompare(const std::string& a, const std::string& b)
136 if(a.length() == b.length())
138 result = std::equal(a.begin(), a.end(), b.begin(), &CaseInsensitiveCharacterCompare);
144 * @brief Attempts to load the contents of a text file; returns empty string on
145 * failure. A pointer to a boolean may be passed in @a fail; this will be set
146 * to true in case of failure (should only be checked if the returned string
149 DALI_SCENE3D_API std::string LoadTextFile(const char* path, bool* fail = nullptr);
152 * @brief Makes a number of calls to @a fn, passing to each one the given
153 * @a actor then each of its children, in depth-first traversal.
154 * @note @a fn must not change the actor hierarchy during traversal.
155 * @note Use of a @a fn that is itself recursing in @a is also discouraged
156 * for performance and stability reasons.
158 template<typename Func>
159 inline DALI_SCENE3D_API void VisitActor(Actor a, Func fn)
163 unsigned int numChildren = a.GetChildCount();
164 for(unsigned int i = 0; i < numChildren; ++i)
166 VisitActor(a.GetChildAt(i), fn);
171 * @brief Convenience function to set the given actor @a 's anchor point
172 * and parent origin to center.
174 inline DALI_SCENE3D_API void SetActorCentered(Actor a)
176 a.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
177 a.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
180 namespace TexturedQuadOptions
182 using Type = uint32_t;
184 enum DALI_SCENE3D_API Values : Type
187 FLIP_VERTICAL = 0x01,
189 } // namespace TexturedQuadOptions
192 * @brief Makes... geometry for a textured quad.
194 DALI_SCENE3D_API Geometry MakeTexturedQuadGeometry(TexturedQuadOptions::Type options = TexturedQuadOptions::NONE);
197 * @brief Fixes the path of a file. Replaces the '\\' separator by the '/' one.
198 * @param[in,out] path The path to be fixed.
200 DALI_SCENE3D_API void ToUnixFileSeparators(std::string& path);
202 } // namespace Loader
203 } // namespace Scene3D
206 #endif /* DALI_SCENE3D_LOADER_UTILS_H_ */