-#ifndef __DALI_PAGE_TURN_EFFECT_H_
-#define __DALI_PAGE_TURN_EFFECT_H_
+#ifndef DALI_PAGE_TURN_EFFECT_H
+#define DALI_PAGE_TURN_EFFECT_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
namespace Dali
{
-
namespace Toolkit
{
-
namespace Internal
{
-
-
/**
* @brief Re-applies PageTurnEffect internal constraints
* The internal constraint uses the OriginalCenter property and the CURRENT_CENTER Property
* @param[in] actor The page turn actor to which internal constraints should be re-applied
* @param[in] pageHeight The page height.
*/
-void PageTurnApplyInternalConstraint( Actor& actor, float pageHeight );
+void PageTurnApplyInternalConstraint(Actor& actor, float pageHeight);
/**
* @brief Create a new PageTurnEffect
- * PageTurnEffect is a custom shader effect to achieve page turn effect for Image actors.
+ * PageTurnEffect is a custom shader to achieve page turn effect for image views.
*
* Usage example:-
*
* Property::Map pageTurnEffect = CreatePageTurnEffect();
*
* // set image view custom shader to the page-turn one\n
- * // for portrait view, one image actor for each page\n
- * // for landscape view, the page turned over is still visible, so back image is needed \n
- * // in this case, create another image Actor using the back image and added to the page actor \n
+ * // for portrait view, the image is rendered as the front side of page\n
+ * // for landscape view, the back side becomes visible when the page is turned over. \n
+ * // in this case, the left and right half of the image are renderer as the front and back side separately. \n
* ImageView page = ImageView::New(....); \n
* page.SetProperty ( ImageView::Property::IMAGE, pageTurnEffect ); \n
*
} // namespace Dali
-#endif /* __DALI_TOOLKIT_SC_CURVE_EFFECT_H_ */
+#endif // DALI_PAGE_TURN_EFFECT_H