[NUI] Re-structuring NUI by classifying modules
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / Visuals / VisualConstants.cs
1 // Copyright (c) 2019 Samsung Electronics Co., Ltd.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 using System.ComponentModel;
16
17 namespace Tizen.NUI
18 {
19     /// <summary>
20     /// Specifies the release policy types.<br />
21     /// Decides if the image should be cached in different conditions.
22     /// </summary>
23     /// <since_tizen> 5 </since_tizen>
24     public enum ReleasePolicyType
25     {
26         /// <summary>
27         /// Image is released when visual detached from scene.
28         /// </summary>
29         Detached = 0,
30         /// <summary>
31         /// Image is only released when visual is destroyed.
32         /// </summary>
33         Destroyed,
34         /// <summary>
35         /// Image is not released.
36         /// </summary>
37         Never
38     }
39
40     /// <summary>
41     /// Specifies the load policy types.<br />
42     /// Decides when the image texture should be loaded.
43     /// </summary>
44     /// <since_tizen> 5 </since_tizen>
45     public enum LoadPolicyType
46     {
47         /// <summary>
48         /// Load texture once the image source has been provided. Even if not being used yet.
49         /// </summary>
50         Immediate = 0,
51         /// <summary>
52         /// Only load texture once the visual is attached, when the image needs to be shown.
53         /// </summary>
54         Attached
55     }
56
57     /// <summary>
58     /// Enumeration for the text horizontal aligning.
59     /// </summary>
60     /// <since_tizen> 3 </since_tizen>
61     public enum HorizontalAlignment
62     {
63         /// <summary>
64         /// Texts place at the begin of horizontal direction.
65         /// </summary>
66         [Description("BEGIN")]
67         Begin,
68         /// <summary>
69         /// Texts place at the center of horizontal direction.
70         /// </summary>
71         [Description("CENTER")]
72         Center,
73         /// <summary>
74         /// Texts place at the end of horizontal direction.
75         /// </summary>
76         [Description("END")]
77         End
78     }
79
80     /// <summary>
81     /// Enumeration for the text horizontal aligning.
82     /// </summary>
83     /// <since_tizen> 3 </since_tizen>
84     public enum VerticalAlignment
85     {
86         /// <summary>
87         /// Texts place at the top of vertical direction.
88         /// </summary>
89         [Description("TOP")]
90         Top,
91         /// <summary>
92         /// Texts place at the center of vertical direction.
93         /// </summary>
94         [Description("CENTER")]
95         Center,
96         /// <summary>
97         /// Texts place at the bottom of vertical direction.
98         /// </summary>
99         [Description("BOTTOM")]
100         Bottom
101     }
102
103     /// <summary>
104     /// This specifies wrap mode types.<br />
105     /// WrapModeU and WrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0.
106     /// </summary>
107     /// <since_tizen> 3 </since_tizen>
108     public enum WrapModeType
109     {
110         /// <summary>
111         /// The default value.
112         /// </summary>
113         Default = 0,
114         /// <summary>
115         /// Clamp to edge.
116         /// </summary>
117         ClampToEdge,
118         /// <summary>
119         /// Repeat.
120         /// </summary>
121         Repeat,
122         /// <summary>
123         /// Mirrored repeat.
124         /// </summary>
125         MirroredRepeat
126     }
127
128     /// <summary>
129     /// This specifies fitting mode types. Fitting options, used when resizing images to fit desired dimensions.<br />
130     /// A fitting mode controls the region of a loaded image to be mapped to the desired image rectangle.<br />
131     /// All fitting modes preserve the aspect ratio of the image contents.<br />
132     /// </summary>
133     /// <since_tizen> 3 </since_tizen>
134     public enum FittingModeType
135     {
136         /// <summary>
137         /// Full-screen image display: Limit loaded image resolution to device resolution using the ShrinkToFit mode.
138         /// </summary>
139         ShrinkToFit,
140         /// <summary>
141         /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using the ScaleToFill mode.
142         /// </summary>
143         ScaleToFill,
144         /// <summary>
145         /// Image columns: Limit loaded image resolution to column width using the FitWidth mode.
146         /// </summary>
147         FitWidth,
148         /// <summary>
149         /// Image rows: Limit loaded image resolution to row height using the FitHeight mode.
150         /// </summary>
151         FitHeight,
152         /// <summary>
153         /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using the Center mode.
154         /// </summary>
155         [EditorBrowsable(EditorBrowsableState.Never)]
156         Center,
157         /// <summary>
158         /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using the ScaleToFill mode.
159         /// </summary>
160         [EditorBrowsable(EditorBrowsableState.Never)]
161         Fill
162     }
163
164     /// <summary>
165     /// This specifies sampling mode types. Filtering options are used when resizing images to sample original pixels.<br />
166     /// A SamplingMode controls how pixels in an input image are sampled and combined to generate each pixel of a destination image during scaling.<br />
167     /// NoFilter and Box modes do not guarantee that the output pixel array exactly matches the rectangle specified by the desired dimensions and the FittingMode,<br />
168     /// but all other filter modes do if the desired dimensions are not more than the raw dimensions of the input image file.<br />
169     /// </summary>
170     /// <since_tizen> 3 </since_tizen>
171     public enum SamplingModeType
172     {
173         /// <summary>
174         /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size. <br />
175         /// This is the default.
176         /// </summary>
177         Box,
178         /// <summary>
179         /// For each output pixel, read one input pixel.
180         /// </summary>
181         Nearest,
182         /// <summary>
183         /// For each output pixel, read a quad of four input pixels and write a weighted average of them.
184         /// </summary>
185         Linear,
186         /// <summary>
187         /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size, <br />
188         /// then for each output pixel, read one pixel from the last level of box filtering.<br />
189         /// </summary>
190         BoxThenNearest,
191         /// <summary>
192         /// Iteratively box filter to almost the right size, then for each output pixel, read four pixels from the last level of box filtering and write their weighted average.
193         /// </summary>
194         BoxThenLinear,
195         /// <summary>
196         /// No filtering is performed. If the SCALE_TO_FILL scaling mode is enabled, the borders of the image may be trimmed to match the aspect ratio of the desired dimensions.
197         /// </summary>
198         NoFilter,
199         /// <summary>
200         /// For caching algorithms where a client strongly prefers a cache-hit to reuse a cached image.
201         /// </summary>
202         DontCare
203     }
204
205     /// <summary>
206     /// The type of coordinate system for certain attributes of the points in a gradient.
207     /// </summary>
208     /// <since_tizen> 3 </since_tizen>
209     public enum GradientVisualUnitsType
210     {
211         /// <summary>
212         /// Uses the normals for the start, end, and center points, i.e., top-left is (-0.5, -0.5) and bottom-right is (0.5, 0.5).
213         /// </summary>
214         ObjectBoundingBox,
215         /// <summary>
216         /// Uses the user coordinates for the start, end, and center points, i.e., in a 200 by 200 control, top-left is (0, 0) and bottom-right is (200, 200).
217         /// </summary>
218         UserSpace
219     }
220
221     /// <summary>
222     /// This specifies SpreadMethod types.<br />
223     /// SpreadMethod defines what happens if the gradient starts or ends inside the bounds of the target rectangle.<br />
224     /// </summary>
225     /// <since_tizen> 3 </since_tizen>
226     public enum GradientVisualSpreadMethodType
227     {
228         /// <summary>
229         /// Uses the terminal colors of the gradient to fill the remainder of the quad.
230         /// </summary>
231         Pad,
232         /// <summary>
233         /// Reflects the gradient pattern start-to-end, end-to-start, start-to-end, etc. until the quad is filled.
234         /// </summary>
235         Reflect,
236         /// <summary>
237         /// Repeats the gradient pattern start-to-end, start-to-end, start-to-end, etc. until the quad is filled.
238         /// </summary>
239         Repeat
240     }
241
242     /// <summary>
243     /// The shading mode used by the mesh visual.
244     /// </summary>
245     /// <since_tizen> 3 </since_tizen>
246     public enum MeshVisualShadingModeValue
247     {
248         /// <summary>
249         /// *Simplest*. One color that is lit by ambient and diffuse lighting.
250         /// </summary>
251         TexturelessWithDiffuseLighting,
252         /// <summary>
253         /// Uses only the visual image textures provided with specular lighting in addition to ambient and diffuse lighting.
254         /// </summary>
255         TexturedWithSpecularLighting,
256         /// <summary>
257         /// Uses all textures provided including gloss, normal, and texture map along with specular, ambient, and diffuse lighting.
258         /// </summary>
259         TexturedWithDetailedSpecularLighting
260     }
261
262     /// <summary>
263     /// The primitive shape to render as a primitive visual.
264     /// </summary>
265     /// <since_tizen> 3 </since_tizen>
266     public enum PrimitiveVisualShapeType
267     {
268         /// <summary>
269         /// A perfectly round geometrical object in the three-dimensional space.
270         /// </summary>
271         Sphere,
272         /// <summary>
273         /// The area bound between two circles, i.e., a cone with the tip removed.
274         /// </summary>
275         ConicalFrustrum,
276         /// <summary>
277         /// Equivalent to a conical frustrum with the top radius of zero.
278         /// </summary>Equivalent to a conical frustrum with the top radius of zero.
279         Cone,
280         /// <summary>
281         /// Equivalent to a conical frustrum with the top radius of zero.
282         /// </summary>
283         Cylinder,
284         /// <summary>
285         /// Equivalent to a conical frustrum with equal radii for the top and bottom circles.
286         /// </summary>
287         Cube,
288         /// <summary>
289         /// Equivalent to a bevelled cube with a bevel percentage of zero.
290         /// </summary>
291         Octahedron,
292         /// <summary>
293         /// Equivalent to a bevelled cube with a bevel percentage of one.
294         /// </summary>
295         BevelledCube
296     }
297
298     /// <summary>
299     /// The values of this enum determine how the visual should fit into the view.
300     /// </summary>
301     /// <since_tizen> 5 </since_tizen>
302     public enum VisualFittingModeType
303     {
304         /// <summary>
305         /// The visual should be scaled to fit, preserving aspect ratio.
306         /// </summary>
307         FitKeepAspectRatio,
308         /// <summary>
309         /// The visual should be stretched to fill, not preserving aspect ratio.
310         /// </summary>
311         Fill,
312         /// <summary>
313         /// The visual should be scaled to fit, preserving aspect ratio. The visual will be fillled without empty area, and outside is cropped away.
314         /// </summary>
315         [EditorBrowsable(EditorBrowsableState.Never)]
316         OverFitKeepAspectRatio,
317         /// <summary>
318         /// The visual should keep original size of image. it is not scaled and not strecthed.
319         /// </summary>
320         [EditorBrowsable(EditorBrowsableState.Never)]
321         Center,
322         /// <summary>
323         /// The visual should be scaled to fit, preserving aspect ratio. Height is scaled proportionately to maintain aspect ratio.
324         /// </summary>
325         [EditorBrowsable(EditorBrowsableState.Never)]
326         FitHeight,
327         /// <summary>
328         /// The visual should be scaled to fit, preserving aspect ratio. WIDTH is scaled proportionately to maintain aspect ratio.
329         /// </summary>
330         [EditorBrowsable(EditorBrowsableState.Never)]
331         FitWidth,
332     }
333
334     /// <summary>
335     /// This specifies policy types that could be used by the transform for the offset or size.
336     /// </summary>
337     /// <since_tizen> 3 </since_tizen>
338     public enum VisualTransformPolicyType
339     {
340         /// <summary>
341         /// Relative to the control (percentage [0.0f to 1.0f] of the control).
342         /// </summary>
343         Relative = 0,
344         /// <summary>
345         /// Absolute value in world units.
346         /// </summary>
347         Absolute = 1
348     }
349
350     /// <summary>
351     /// This specifies all the transform property types.
352     /// </summary>
353     /// <since_tizen> 3 </since_tizen>
354     public enum VisualTransformPropertyType
355     {
356         /// <summary>
357         /// Offset of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units).
358         /// </summary>
359         Offset,
360         /// <summary>
361         /// Size of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units).
362         /// </summary>
363         Size,
364         /// <summary>
365         /// The origin of the visual within its control area.
366         /// </summary>
367         Origin,
368         /// <summary>
369         /// The anchor-point of the visual.
370         /// </summary>
371         AnchorPoint,
372         /// <summary>
373         /// Whether the x or y offset values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
374         /// </summary>
375         OffsetPolicy,
376         /// <summary>
377         /// Whether the width or the height size values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
378         /// </summary>
379         SizePolicy,
380         /// <summary>
381         /// Extra size value that will be added to the computed visual size.
382         /// </summary>
383         [EditorBrowsable(EditorBrowsableState.Never)]
384         ExtraSize,
385     }
386
387     /// <summary>
388     /// This specifies visual types.
389     /// </summary>
390     /// <since_tizen> 3 </since_tizen>
391     public struct Visual
392     {
393         /// <summary>
394         /// The index for the visual type.
395         /// </summary>
396         /// <since_tizen> 3 </since_tizen>
397         public enum Type
398         {
399             /// <summary>
400             /// Renders a solid color as an internal border to the control's quad.
401             /// </summary>
402             Border,
403             /// <summary>
404             /// Renders a solid color to the control's quad.
405             /// </summary>
406             Color,
407             /// <summary>
408             /// Renders a smooth transition of colors to the control's quad.
409             /// </summary>
410             Gradient,
411             /// <summary>
412             /// Renders an image into the control's quad.
413             /// </summary>
414             Image,
415             /// <summary>
416             /// Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file.
417             /// </summary>
418             Mesh,
419             /// <summary>
420             /// Renders a simple 3D shape, such as a cube or a sphere.
421             /// </summary>
422             Primitive,
423             /// <summary>
424             /// Renders a simple wire-frame outlining a quad.
425             /// </summary>
426             Wireframe,
427             /// <summary>
428             /// Renders text.
429             /// </summary>
430             Text,
431             /// <summary>
432             /// Renders an NPatch image.
433             /// </summary>
434             NPatch,
435             /// <summary>
436             /// Renders an SVG image.
437             /// </summary>
438             SVG,
439             /// <summary>
440             /// Renders a animated image (animated GIF).
441             /// </summary>
442             AnimatedImage,
443             /// <summary>
444             /// Renders an arc.
445             /// </summary>
446             [EditorBrowsable(EditorBrowsableState.Never)]
447             Arc = AnimatedImage + 3,
448         }
449
450         /// <summary>
451         /// This specifies visual properties.
452         /// </summary>
453         /// <since_tizen> 3 </since_tizen>
454         [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1716: Identifiers should not match keywords")]
455         public struct Property
456         {
457             /// <summary>
458             /// Type.
459             /// </summary>
460             /// <since_tizen> 3 </since_tizen>
461             public static readonly int Type = NDalic.VisualPropertyType;
462             /// <summary>
463             /// Shader.
464             /// </summary>
465             /// <since_tizen> 3 </since_tizen>
466             public static readonly int Shader = NDalic.VisualPropertyShader;
467             /// <summary>
468             /// Transform.
469             /// </summary>
470             /// <since_tizen> 3 </since_tizen>
471             public static readonly int Transform = NDalic.VisualPropertyTransform;
472             /// <summary>
473             /// PremultipliedAlpha.
474             /// </summary>
475             /// <since_tizen> 3 </since_tizen>
476             public static readonly int PremultipliedAlpha = NDalic.VisualPropertyPremultipliedAlpha;
477             /// <summary>
478             /// MixColor.
479             /// </summary>
480             /// <since_tizen> 3 </since_tizen>
481             public static readonly int MixColor = NDalic.VisualPropertyMixColor;
482             /// <summary>
483             /// Opacity.
484             /// </summary>
485             /// <since_tizen> 3 </since_tizen>
486             public static readonly int Opacity = NDalic.VisualPropertyMixColor + 1;
487             /// <summary>
488             /// The fitting mode of the visual.
489             /// </summary>
490             /// <since_tizen> 5 </since_tizen>
491             public static readonly int VisualFittingMode = NDalic.VisualPropertyMixColor + 2;
492             /// <summary>
493             /// The corner radius of the visual.
494             /// </summary>
495             [EditorBrowsable(EditorBrowsableState.Never)]
496             public static readonly int CornerRadius = NDalic.VisualPropertyMixColor + 3;
497             /// <summary>
498             /// The corner radius policy of the visual.
499             /// Whether the corner radius value is relative (percentage [0.0f to 1.0f] of the visual size) or absolute (in world units).
500             /// </summary>
501             [EditorBrowsable(EditorBrowsableState.Never)]
502             public static readonly int CornerRadiusPolicy = NDalic.VisualPropertyMixColor + 4;
503         }
504
505         /// <summary>
506         /// This specifies shader properties.
507         /// </summary>
508         /// <since_tizen> 3 </since_tizen>
509         public struct ShaderProperty
510         {
511             /// <summary>
512             /// Vertex shader code
513             /// </summary>
514             /// <since_tizen> 3 </since_tizen>
515             public static readonly int VertexShader = NDalic.VisualShaderVertex;
516             /// <summary>
517             /// Fragment shader code
518             /// </summary>
519             /// <since_tizen> 3 </since_tizen>
520             public static readonly int FragmentShader = NDalic.VisualShaderFragment;
521             /// <summary>
522             /// How to subdivide the grid along X
523             /// </summary>
524             /// <since_tizen> 3 </since_tizen>
525             public static readonly int ShaderSubdivideGridX = NDalic.VisualShaderSubdivideGridX;
526             /// <summary>
527             /// How to subdivide the grid along Y
528             /// </summary>
529             /// <since_tizen> 3 </since_tizen>
530             public static readonly int ShaderSubdivideGridY = NDalic.VisualShaderSubdivideGridY;
531             /// <summary>
532             /// Bitmask of hints
533             /// </summary>
534             /// <since_tizen> 3 </since_tizen>
535             public static readonly int ShaderHints = NDalic.VisualShaderHints;
536         }
537
538         /// <summary>
539         /// This specifies visaul align types.
540         /// </summary>
541         /// <since_tizen> 3 </since_tizen>
542         public enum AlignType
543         {
544             /// <summary>
545             /// TopBegin
546             /// </summary>
547             /// <since_tizen> 3 </since_tizen>
548             TopBegin = 0,
549             /// <summary>
550             /// TopCenter
551             /// </summary>
552             /// <since_tizen> 3 </since_tizen>
553             TopCenter,
554             /// <summary>
555             /// TopEnd
556             /// </summary>
557             /// <since_tizen> 3 </since_tizen>
558             TopEnd,
559             /// <summary>
560             /// CenterBegin
561             /// </summary>
562             /// <since_tizen> 3 </since_tizen>
563             CenterBegin,
564             /// <summary>
565             /// Center
566             /// </summary>
567             /// <since_tizen> 3 </since_tizen>
568             Center,
569             /// <summary>
570             /// CenterEnd
571             /// </summary>
572             /// <since_tizen> 3 </since_tizen>
573             CenterEnd,
574             /// <summary>
575             /// BottomBegin
576             /// </summary>
577             /// <since_tizen> 3 </since_tizen>
578             BottomBegin,
579             /// <summary>
580             /// BottomCenter
581             /// </summary>
582             /// <since_tizen> 3 </since_tizen>
583             BottomCenter,
584             /// <summary>
585             /// BottomEnd
586             /// </summary>
587             /// <since_tizen> 3 </since_tizen>
588             BottomEnd
589         }
590     }
591
592     /// <summary>
593     /// This specifies properties of the BorderVisual.
594     /// </summary>
595     /// <since_tizen> 3 </since_tizen>
596     public struct BorderVisualProperty
597     {
598         /// <summary>
599         /// The color of the border.
600         /// </summary>
601         /// <since_tizen> 3 </since_tizen>
602         public static readonly int Color = NDalic.BorderVisualColor;
603         /// <summary>
604         /// The width of the border (in pixels).
605         /// </summary>
606         /// <since_tizen> 3 </since_tizen>
607         public static readonly int Size = NDalic.BorderVisualSize;
608         /// <summary>
609         /// Whether anti-aliasing of the border is required.
610         /// </summary>
611         /// <since_tizen> 3 </since_tizen>
612         public static readonly int AntiAliasing = NDalic.BorderVisualAntiAliasing;
613     }
614
615     /// <summary>
616     /// This specifies properties of the ColorVisual.
617     /// </summary>
618     /// <since_tizen> 3 </since_tizen>
619     public struct ColorVisualProperty
620     {
621         /// <summary>
622         /// The solid color required.
623         /// </summary>
624         /// <since_tizen> 3 </since_tizen>
625         public static readonly int MixColor = NDalic.ColorVisualMixColor;
626         /// <summary>
627         /// Whether to render if the MixColor is transparent.
628         /// </summary>
629         /// <since_tizen> 5 </since_tizen>
630         public static readonly int RenderIfTransparent = NDalic.ColorVisualMixColor + 1;
631         /// <summary>
632         /// Then radius value for the area to blur.
633         /// </summary>
634         [EditorBrowsable(EditorBrowsableState.Never)]
635         public static readonly int BlurRadius = NDalic.ColorVisualMixColor + 2;
636     }
637
638     /// <summary>
639     /// This specifies properties of the GradientVisual.
640     /// </summary>
641     /// <since_tizen> 3 </since_tizen>
642     public struct GradientVisualProperty
643     {
644         /// <summary>
645         /// The start position of a linear gradient.
646         /// </summary>
647         /// <since_tizen> 3 </since_tizen>
648         public static readonly int StartPosition = NDalic.GradientVisualStartPosition;
649         /// <summary>
650         /// The end position of a linear gradient.
651         /// </summary>
652         /// <since_tizen> 3 </since_tizen>
653         public static readonly int EndPosition = NDalic.GradientVisualEndPosition;
654         /// <summary>
655         /// The center point of a radial gradient.
656         /// </summary>
657         /// <since_tizen> 3 </since_tizen>
658         public static readonly int Center = NDalic.GradientVisualCenter;
659         /// <summary>
660         /// The size of the radius of a radial gradient.
661         /// </summary>
662         /// <since_tizen> 3 </since_tizen>
663         public static readonly int Radius = NDalic.GradientVisualRadius;
664         /// <summary>
665         /// All the stop offsets.
666         /// </summary>
667         /// <since_tizen> 3 </since_tizen>
668         public static readonly int StopOffset = NDalic.GradientVisualStopOffset;
669         /// <summary>
670         /// The color at the stop offsets.
671         /// </summary>
672         /// <since_tizen> 3 </since_tizen>
673         public static readonly int StopColor = NDalic.GradientVisualStopColor;
674         /// <summary>
675         /// Defines the coordinate system for certain attributes of the points in a gradient.
676         /// </summary>
677         /// <since_tizen> 3 </since_tizen>
678         public static readonly int Units = NDalic.GradientVisualUnits;
679         /// <summary>
680         /// Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.
681         /// </summary>
682         /// <since_tizen> 3 </since_tizen>
683         public static readonly int SpreadMethod = NDalic.GradientVisualSpreadMethod;
684     }
685
686     /// <summary>
687     /// This specifies properties of the ImageVisual.
688     /// </summary>
689     /// <since_tizen> 3 </since_tizen>
690     public struct ImageVisualProperty
691     {
692         /// <summary>
693         /// The URL of the image.
694         /// </summary>
695         /// <since_tizen> 3 </since_tizen>
696         public static readonly int URL = NDalic.ImageVisualUrl;
697
698         /// <summary>
699         /// Fitting options, used when resizing images to fit desired dimensions.
700         /// </summary>
701         /// <since_tizen> 3 </since_tizen>
702         public static readonly int FittingMode = NDalic.ImageVisualFittingMode;
703
704         /// <summary>
705         /// Filtering options, used when resizing images to sample original pixels.
706         /// </summary>
707         /// <since_tizen> 3 </since_tizen>
708         public static readonly int SamplingMode = NDalic.ImageVisualSamplingMode;
709
710         /// <summary>
711         /// The desired image width.
712         /// </summary>
713         /// <since_tizen> 3 </since_tizen>
714         public static readonly int DesiredWidth = NDalic.ImageVisualDesiredWidth;
715
716         /// <summary>
717         /// The desired image height.
718         /// </summary>
719         /// <since_tizen> 3 </since_tizen>
720         public static readonly int DesiredHeight = NDalic.ImageVisualDesiredHeight;
721
722         /// <summary>
723         /// Whether to load the image synchronously.
724         /// </summary>
725         /// <since_tizen> 3 </since_tizen>
726         public static readonly int SynchronousLoading = NDalic.ImageVisualSynchronousLoading;
727
728         /// <summary>
729         /// If true, only draws the borders.
730         /// </summary>
731         /// <since_tizen> 3 </since_tizen>
732         public static readonly int BorderOnly = NDalic.ImageVisualBorderOnly;
733
734         /// <summary>
735         /// The image area to be displayed.
736         /// </summary>
737         /// <since_tizen> 3 </since_tizen>
738         public static readonly int PixelArea = NDalic.ImageVisualPixelArea;
739
740         /// <summary>
741         /// The wrap mode for u coordinate.
742         /// </summary>
743         /// <since_tizen> 3 </since_tizen>
744         public static readonly int WrapModeU = NDalic.ImageVisualWrapModeU;
745
746         /// <summary>
747         /// The wrap mode for v coordinate.
748         /// </summary>
749         /// <since_tizen> 3 </since_tizen>
750         public static readonly int WrapModeV = NDalic.ImageVisualWrapModeV;
751
752         /// <summary>
753         /// The border of the image.
754         /// </summary>
755         /// <since_tizen> 3 </since_tizen>
756         public static readonly int Border = NDalic.ImageVisualBorder;
757
758         /// <summary>
759         /// Whether to use the texture atlas.
760         /// </summary>
761         /// <since_tizen> 5 </since_tizen>
762         public static readonly int Atlasing = NDalic.ImageVisualBorder + 1;
763
764         /// <summary>
765         /// The URL of the alpha mask image.
766         /// </summary>
767         /// <since_tizen> 3 </since_tizen>
768         public static readonly int AlphaMaskURL = NDalic.ImageVisualAlphaMaskUrl;
769
770         /// <summary>
771         /// Defines the batch size for pre-loading images in the AnimatedImageVisual
772         /// </summary>
773         /// <since_tizen> 4 </since_tizen>
774         public static readonly int BatchSize = NDalic.ImageVisualBatchSize;
775
776         /// <summary>
777         /// Defines the cache size for loading images in the AnimatedImageVisual
778         /// </summary>
779         /// <since_tizen> 4 </since_tizen>
780         public static readonly int CacheSize = NDalic.ImageVisualCacheSize;
781
782         /// <summary>
783         /// The number of milliseconds between each frame in the AnimatedImageVisual
784         /// </summary>
785         /// <since_tizen> 4 </since_tizen>
786         public static readonly int FrameDelay = NDalic.ImageVisualFrameDelay;
787
788         /// <summary>
789         /// The scale factor to apply to the content image before masking.
790         /// </summary>
791         /// <since_tizen> 4 </since_tizen>
792         public static readonly int MaskContentScale = NDalic.ImageVisualMaskContentScale;
793
794         /// <summary>
795         /// Whether to crop image to mask or scale mask to fit image
796         /// </summary>
797         /// <since_tizen> 4 </since_tizen>
798         public static readonly int CropToMask = NDalic.ImageVisualCropToMask;
799
800         /// <summary>
801         /// The policy to determine when an image should be loaded.
802         /// </summary>
803         /// <since_tizen> 5 </since_tizen>
804         public static readonly int LoadPolicy = NDalic.ImageVisualLoadPolicy;
805
806         /// <summary>
807         /// The policy to determine when an image should no longer be cached.
808         /// </summary>
809         /// <since_tizen> 5 </since_tizen>
810         public static readonly int ReleasePolicy = NDalic.ImageVisualReleasePolicy;
811
812         /// <summary>
813         /// Determines if image orientation should be corrected so that the image displays as it was intended.
814         /// </summary>
815         /// <since_tizen> 5 </since_tizen>
816         public static readonly int OrientationCorrection = NDalic.ImageVisualOrientationCorrection;
817
818         /// <summary>
819         /// Overlays the auxiliary image on top of an NPatch image.
820         /// </summary>
821         /// <since_tizen> 5 </since_tizen>
822         public static readonly int AuxiliaryImageURL = NDalic.ImageVisualAuxiliaryImageUrl;
823
824         /// <summary>
825         /// Alpha value for the auxiliary image, without affecting the underlying NPatch image
826         /// </summary>
827         /// <since_tizen> 5 </since_tizen>
828         public static readonly int AuxiliaryImageAlpha = NDalic.ImageVisualAuxiliaryImageAlpha;
829
830         /// <summary>
831         /// The number of times the AnimatedImageVisual will be looped.
832         /// The default is -1. If the value is less than 0, loop unlimited. Otherwise, loop loopCount times.
833         /// </summary>
834         /// <since_tizen> 5 </since_tizen>
835         public static readonly int LoopCount = NDalic.ImageVisualLoopCount;
836
837         /// <summary>
838         /// @brief The playing range the AnimatedVectorImageVisual will use.
839         /// Animation will play between the values specified.The array can only have two values, and more will be ignored.
840         /// Both values should be between 0 and the total frame number, otherwise they will be ignored.
841         /// If the range provided is not in proper order (minimum, maximum), it will be reordered.
842         /// @details Name "playRange", Type Property::ARRAY of Property::INTEGER
843         /// @note Default 0 and the total frame number.
844         /// </summary>
845         /// <remarks>
846         /// Hidden API (Inhouse API)
847         /// </remarks>
848         [EditorBrowsable(EditorBrowsableState.Never)]
849         public static readonly int PlayRange = NDalic.ImageVisualOrientationCorrection + 4;
850
851         /// <summary>
852         /// @brief The playing state the AnimatedVectorImageVisual will use.
853         /// @details Name "playState", type PlayState (Property::INTEGER)
854         /// @note This property is read-only.
855         /// </summary>
856         /// <remarks>
857         /// Hidden API (Inhouse API)
858         /// </remarks>
859         [EditorBrowsable(EditorBrowsableState.Never)]
860         public static readonly int PlayState = NDalic.ImageVisualOrientationCorrection + 5;
861
862         /// <summary>
863         /// @brief The current frame number the AnimatedVectorImageVisual will use.
864         /// @details Name "currentFrameNumber", Type Property::INTEGER, between[0, the maximum frame number] or between the play range if specified
865         /// @note This property is read-only.
866         /// </summary>
867         /// <remarks>
868         /// Inhouse API
869         /// </remarks>
870         [EditorBrowsable(EditorBrowsableState.Never)]
871         public static readonly int CurrentFrameNumber = NDalic.ImageVisualOrientationCorrection + 6;
872
873         /// <summary>
874         /// @brief The total frame number the AnimatedVectorImageVisual will use.
875         /// @details Name "totalFrameNumber", Type Property::INTEGER.
876         /// @note This property is read-only.
877         /// </summary>
878         /// <remarks>
879         /// Inhouse API
880         /// </remarks>
881         [EditorBrowsable(EditorBrowsableState.Never)]
882         public static readonly int TotalFrameNumber = NDalic.ImageVisualOrientationCorrection + 7;
883
884         /// <summary>
885         /// @brief  The stop behavior the AnimatedVectorImageVisual will use.
886         /// @details Name "stopBehavior", Type StopBehavior::Type (Property::INTEGER)
887         /// @note Default value is StopBehavior::CURRENT_FRAME.
888         /// </summary>
889         /// <remarks>
890         /// Inhouse API
891         /// </remarks>
892         [EditorBrowsable(EditorBrowsableState.Never)]
893         public static readonly int StopBehavior = NDalic.ImageVisualOrientationCorrection + 8;
894
895         /// <summary>
896         /// @brief  The looping mode the AnimatedVectorImageVisual will use.
897         /// @details Name "loopingMode", Type LoopingMode::Type (Property::INTEGER)
898         /// @note Default value is LoopingMode::RESTART.
899         /// </summary>
900         /// <remarks>
901         /// Inhouse API
902         /// </remarks>
903         [EditorBrowsable(EditorBrowsableState.Never)]
904         public static readonly int LoopingMode = NDalic.ImageVisualOrientationCorrection + 9;
905
906         /// <summary>
907         /// @brief The content information the AnimatedVectorImageVisual will use.
908         /// @details Name "contentInfo", Type Property::MAP.
909         /// The map contains the layer name as a key and Property::Array as a value.
910         /// And the array contains 2 integer values which are the frame numbers, the start frame number and the end frame number of the layer.
911         /// @note This property is read-only.
912         /// </summary>
913         /// <remarks>
914         /// Inhouse API
915         /// </remarks>
916         [EditorBrowsable(EditorBrowsableState.Never)]
917         public static readonly int ContentInfo = NDalic.ImageVisualOrientationCorrection + 10;
918
919         /// <summary>
920         /// @brief Whether to redraw the image when the visual is scaled down.
921         /// @details Name "redrawInScalingDown", type Property::BOOLEAN.
922         /// @note It is used in the AnimatedVectorImageVisual.The default is true.
923         /// </summary>
924         /// <remarks>
925         /// Inhouse API
926         /// </remarks>
927         [EditorBrowsable(EditorBrowsableState.Never)]
928         public static readonly int RedrawInScalingDown = NDalic.ImageVisualOrientationCorrection + 11;
929     }
930
931     /// <summary>
932     /// This specifies properties of the MeshVisual.
933     /// </summary>
934     /// <since_tizen> 3 </since_tizen>
935     public struct MeshVisualProperty
936     {
937         /// <summary>
938         /// The location of the ".obj" file.
939         /// </summary>
940         /// <since_tizen> 3 </since_tizen>
941         public static readonly int ObjectURL = NDalic.MeshVisualObjectUrl;
942         /// <summary>
943         /// The location of the ".mtl" file.
944         /// </summary>
945         /// <since_tizen> 3 </since_tizen>
946         public static readonly int MaterialtURL = NDalic.MeshVisualMaterialUrl;
947         /// <summary>
948         /// Path to the directory the textures (including gloss and normal) are stored in.
949         /// </summary>
950         /// <since_tizen> 3 </since_tizen>
951         public static readonly int TexturesPath = NDalic.MeshVisualTexturesPath;
952         /// <summary>
953         /// Sets the type of shading mode that the mesh will use.
954         /// </summary>
955         /// <since_tizen> 3 </since_tizen>
956         public static readonly int ShadingMode = NDalic.MeshVisualShadingMode;
957         /// <summary>
958         /// Whether to use mipmaps for textures or not.
959         /// </summary>
960         /// <since_tizen> 3 </since_tizen>
961         public static readonly int UseMipmapping = NDalic.MeshVisualUseMipmapping;
962         /// <summary>
963         /// Whether to average normals at each point to smooth textures or not.
964         /// </summary>
965         /// <since_tizen> 3 </since_tizen>
966         public static readonly int UseSoftNormals = NDalic.MeshVisualUseSoftNormals;
967         /// <summary>
968         /// The position, in stage space, of the point light that applies lighting to the model.
969         /// </summary>
970         /// <since_tizen> 3 </since_tizen>
971         public static readonly int LightPosition = NDalic.MeshVisualLightPosition;
972     }
973
974     /// <summary>
975     /// This specifies properties of the PrimitiveVisual.
976     /// </summary>
977     /// <since_tizen> 3 </since_tizen>
978     public struct PrimitiveVisualProperty
979     {
980         /// <summary>
981         /// The specific shape to render.
982         /// </summary>
983         /// <since_tizen> 3 </since_tizen>
984         public static readonly int Shape = NDalic.PrimitiveVisualShape;
985         /// <summary>
986         /// The color of the shape.
987         /// </summary>
988         /// <since_tizen> 3 </since_tizen>
989         public static readonly int MixColor = NDalic.PrimitiveVisualMixColor;
990         /// <summary>
991         /// The number of slices as you go around the shape.
992         /// </summary>
993         /// <since_tizen> 3 </since_tizen>
994         public static readonly int Slices = NDalic.PrimitiveVisualSlices;
995         /// <summary>
996         /// The number of stacks as you go down the shape.
997         /// </summary>
998         /// <since_tizen> 3 </since_tizen>
999         public static readonly int Stacks = NDalic.PrimitiveVisualStacks;
1000         /// <summary>
1001         /// The scale of the radius of the top circle of a conical frustrum.
1002         /// </summary>
1003         /// <since_tizen> 3 </since_tizen>
1004         public static readonly int ScaleTopRadius = NDalic.PrimitiveVisualScaleTopRadius;
1005         /// <summary>
1006         /// The scale of the radius of the bottom circle of a conical frustrum.
1007         /// </summary>
1008         /// <since_tizen> 3 </since_tizen>
1009         public static readonly int ScaleBottomRadius = NDalic.PrimitiveVisualScaleBottomRadius;
1010         /// <summary>
1011         /// The scale of the height of a conic.
1012         /// </summary>
1013         /// <since_tizen> 3 </since_tizen>
1014         public static readonly int ScaleHeight = NDalic.PrimitiveVisualScaleHeight;
1015         /// <summary>
1016         /// The scale of the radius of a cylinder.
1017         /// </summary>
1018         /// <since_tizen> 3 </since_tizen>
1019         public static readonly int ScaleRadius = NDalic.PrimitiveVisualScaleRadius;
1020         /// <summary>
1021         /// The dimensions of a cuboid. Scales in the same fashion as a 9-patch image.
1022         /// </summary>
1023         /// <since_tizen> 3 </since_tizen>
1024         public static readonly int ScaleDimensions = NDalic.PrimitiveVisualScaleDimensions;
1025         /// <summary>
1026         /// Determines how bevelled the cuboid should be, based off the smallest dimension.
1027         /// </summary>
1028         /// <since_tizen> 3 </since_tizen>
1029         public static readonly int BevelPercentage = NDalic.PrimitiveVisualBevelPercentage;
1030         /// <summary>
1031         /// Defines how smooth the bevelled edges should be.
1032         /// </summary>
1033         /// <since_tizen> 3 </since_tizen>
1034         public static readonly int BevelSmoothness = NDalic.PrimitiveVisualBevelSmoothness;
1035         /// <summary>
1036         /// The position, in stage space, of the point light that applies lighting to the model.
1037         /// </summary>
1038         /// <since_tizen> 3 </since_tizen>
1039         public static readonly int LightPosition = NDalic.PrimitiveVisualLightPosition;
1040     }
1041
1042     /// <summary>
1043     /// This specifies properties of the TextVisual.
1044     /// </summary>
1045     /// <since_tizen> 3 </since_tizen>
1046     public struct TextVisualProperty
1047     {
1048         /// <summary>
1049         /// The text to display in UTF-8 format.
1050         /// </summary>
1051         /// <since_tizen> 3 </since_tizen>
1052         public static readonly int Text = NDalic.TextVisualText;
1053         /// <summary>
1054         /// The requested font family to use.
1055         /// </summary>
1056         /// <since_tizen> 3 </since_tizen>
1057         public static readonly int FontFamily = NDalic.TextVisualFontFamily;
1058         /// <summary>
1059         /// The requested font style to use.
1060         /// </summary>
1061         /// <since_tizen> 3 </since_tizen>
1062         public static readonly int FontStyle = NDalic.TextVisualFontStyle;
1063         /// <summary>
1064         /// The size of font in points.
1065         /// </summary>
1066         /// <since_tizen> 3 </since_tizen>
1067         public static readonly int PointSize = NDalic.TextVisualPointSize;
1068         /// <summary>
1069         /// The single-line or multi-line layout option.
1070         /// </summary>
1071         /// <since_tizen> 3 </since_tizen>
1072         public static readonly int MultiLine = NDalic.TextVisualMultiLine;
1073         /// <summary>
1074         /// The line horizontal alignment.
1075         /// </summary>
1076         /// <since_tizen> 3 </since_tizen>
1077         public static readonly int HorizontalAlignment = NDalic.TextVisualHorizontalAlignment;
1078         /// <summary>
1079         /// The line vertical alignment.
1080         /// </summary>
1081         /// <since_tizen> 3 </since_tizen>
1082         public static readonly int VerticalAlignment = NDalic.TextVisualVerticalAlignment;
1083         /// <summary>
1084         /// The color of the text.
1085         /// </summary>
1086         /// <since_tizen> 3 </since_tizen>
1087         public static readonly int TextColor = NDalic.TextVisualTextColor;
1088         /// <summary>
1089         /// Whether the mark-up processing is enabled.
1090         /// </summary>
1091         /// <since_tizen> 3 </since_tizen>
1092         public static readonly int EnableMarkup = NDalic.TextVisualEnableMarkup;
1093         /// <summary>
1094         /// The shadow parameters.
1095         /// </summary>
1096         /// <since_tizen> 5 </since_tizen>
1097         public static readonly int Shadow = NDalic.TextVisualEnableMarkup + 1;
1098         /// <summary>
1099         /// The default underline parameters.
1100         /// </summary>
1101         /// <since_tizen> 5 </since_tizen>
1102         public static readonly int Underline = NDalic.TextVisualEnableMarkup + 2;
1103         /// <summary>
1104         /// The default outline parameters.
1105         /// </summary>
1106         /// <since_tizen> 5 </since_tizen>
1107         public static readonly int Outline = NDalic.TextVisualEnableMarkup + 3;
1108         /// <summary>
1109         /// The default text background parameters.
1110         /// </summary>
1111         /// <since_tizen> 5 </since_tizen>
1112         public static readonly int Background = NDalic.TextVisualEnableMarkup + 4;
1113     }
1114
1115     /// <summary>
1116     /// This specifies properties of the NpatchImageVisual.
1117     /// </summary>
1118     /// <since_tizen> 3 </since_tizen>
1119     public struct NpatchImageVisualProperty
1120     {
1121         /// <summary>
1122         /// The URL of the image.
1123         /// </summary>
1124         /// <since_tizen> 3 </since_tizen>
1125         public static readonly int URL = NDalic.ImageVisualUrl;
1126         /// <summary>
1127         /// Fitting options, used when resizing images to fit desired dimensions.
1128         /// </summary>
1129         /// <since_tizen> 3 </since_tizen>
1130         public static readonly int FittingMode = NDalic.ImageVisualFittingMode;
1131         /// <summary>
1132         /// Filtering options, used when resizing images to sample original pixels.
1133         /// </summary>
1134         /// <since_tizen> 3 </since_tizen>
1135         public static readonly int SamplingMode = NDalic.ImageVisualSamplingMode;
1136         /// <summary>
1137         /// The desired image width.
1138         /// </summary>
1139         /// <since_tizen> 3 </since_tizen>
1140         public static readonly int DesiredWidth = NDalic.ImageVisualDesiredWidth;
1141         /// <summary>
1142         /// The desired image height.
1143         /// </summary>
1144         /// <since_tizen> 3 </since_tizen>
1145         public static readonly int DesiredHeight = NDalic.ImageVisualDesiredHeight;
1146         /// <summary>
1147         /// Whether to load the image synchronously.
1148         /// </summary>
1149         /// <since_tizen> 3 </since_tizen>
1150         public static readonly int SynchronousLoading = NDalic.ImageVisualSynchronousLoading;
1151         /// <summary>
1152         /// If true, only draws the borders.
1153         /// </summary>
1154         /// <since_tizen> 3 </since_tizen>
1155         public static readonly int BorderOnly = NDalic.ImageVisualBorderOnly;
1156         /// <summary>
1157         /// The image area to be displayed.
1158         /// </summary>
1159         /// <since_tizen> 3 </since_tizen>
1160         public static readonly int PixelArea = NDalic.ImageVisualPixelArea;
1161         /// <summary>
1162         /// The wrap mode for u coordinate.
1163         /// </summary>
1164         /// <since_tizen> 3 </since_tizen>
1165         public static readonly int WrapModeU = NDalic.ImageVisualWrapModeU;
1166         /// <summary>
1167         /// The wrap mode for v coordinate.
1168         /// </summary>
1169         /// <since_tizen> 3 </since_tizen>
1170         public static readonly int WrapModeV = NDalic.ImageVisualWrapModeV;
1171         /// <summary>
1172         /// The border of the image.
1173         /// </summary>
1174         /// <since_tizen> 3 </since_tizen>
1175         public static readonly int Border = NDalic.ImageVisualWrapModeV + 1;
1176     }
1177
1178     /// <summary>
1179     /// This specifies properties of the ArcVisual.
1180     /// </summary>
1181     internal struct ArcVisualProperty
1182     {
1183         /// <summary>
1184         /// The thickness of the arc.
1185         /// </summary>
1186         /// <remarks>The value is float type.</remarks>
1187         /// <remarks>This is mandatory property.</remarks>
1188         internal static readonly int Thickness = NDalic.ImageVisualUrl;
1189
1190         /// <summary>
1191         /// The start angle where the arc begins in degrees.
1192         /// </summary>
1193         /// <remarks>The value is float type.</remarks>
1194         /// <remarks>The property of optional. The default value is 0.</remarks>
1195         internal static readonly int StartAngle = Thickness + 1;
1196
1197         /// <summary>
1198         /// The sweep angle of the arc in degrees.
1199         /// </summary>
1200         /// <remarks>The value is float type.</remarks>
1201         /// <remarks>The property of optional. The default value is 360.</remarks>
1202         internal static readonly int SweepAngle = Thickness + 2;
1203
1204         /// <summary>
1205         /// The cap style of the arc.
1206         /// </summary>
1207         /// <remarks>
1208         /// The value is integer type.
1209         /// The value 0 means butt, the arc does not extend beyond its two endpoints.
1210         /// The value 1 means round, the arc will be extended by a half circle with the center at the end.
1211         /// </remarks>
1212         /// <remarks>The property of optional. The default value is 0 (butt).</remarks>
1213         internal static readonly int Cap = Thickness + 3;
1214     }
1215
1216     /// <summary>
1217     /// Enumeration for Circular alignment.
1218     /// The @p horizontalAlignment and @p verticalAlignment can be used to align the text within the text area.
1219     /// </summary>
1220     [EditorBrowsable(EditorBrowsableState.Never)]
1221     public enum CircularAlignment
1222     {
1223         /// <summary>
1224         /// Texts place at the begin of Circular direction.
1225         /// </summary>
1226         [Description("BEGIN")]
1227         Begin,
1228         /// <summary>
1229         /// Texts place at the center of Circular direction.
1230         /// </summary>
1231         [Description("CENTER")]
1232         Center,
1233         /// <summary>
1234         /// Texts place at the end of Circular direction.
1235         /// </summary>
1236         [Description("END")]
1237         End
1238     }
1239
1240     /// <summary>
1241     /// Enumeration for Text Layout.
1242     /// </summary>
1243     [EditorBrowsable(EditorBrowsableState.Never)]
1244     public enum TextLayout
1245     {
1246         /// <summary>
1247         /// SingleLine.
1248         /// </summary>
1249         [Description("singleLine")]
1250         SingleLine,
1251         /// <summary>
1252         /// MultiLine.
1253         /// </summary>
1254         [Description("multiLine")]
1255         MultiLine,
1256         /// <summary>
1257         /// Circular.
1258         /// </summary>
1259         [Description("circular")]
1260         Circular
1261     }
1262
1263     /// <summary>
1264     /// Defines how a color is blended.
1265     /// </summary>
1266     /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API.
1267     [EditorBrowsable(EditorBrowsableState.Never)]
1268     public enum ColorBlendingMode
1269     {
1270         /// <summary>
1271         ///  No blend.
1272         /// </summary>
1273         None,
1274         /// <summary>
1275         ///  The color is multiplied by another one.
1276         /// </summary>
1277         Multiply
1278     };
1279 }