X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2FTizen.NUI%2Fsrc%2Fpublic%2FVisualMaps.cs;h=2368c554b217d6a3b72ca09372c4b051b877a6d6;hb=bff9a094cf97fb687030cb65963212b7f6514b26;hp=a26b8f4ca3dc81d9649a9cf0c8cd2149ebb3c321;hpb=6db73f1fdc1ac16414dc8eed61592558bd227c33;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git diff --git a/src/Tizen.NUI/src/public/VisualMaps.cs b/src/Tizen.NUI/src/public/VisualMaps.cs index a26b8f4..2368c55 100755 --- a/src/Tizen.NUI/src/public/VisualMaps.cs +++ b/src/Tizen.NUI/src/public/VisualMaps.cs @@ -1,26 +1,30 @@ -// Copyright (c) 2017 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. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// +/* + * Copyright(c) 2017 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +using System.Text; +using System.Collections.Generic; +using Tizen.NUI.BaseComponents; +using System.ComponentModel; namespace Tizen.NUI { - using System.Collections.Generic; - using Tizen.NUI.BaseComponents; - /// - /// A class encapsulating the transform map of visual. + /// A class encapsulating the transform map of the visual. /// + /// 3 public class VisualMap { private Vector2 _visualSize = null; @@ -33,6 +37,11 @@ namespace Tizen.NUI private PropertyMap _visualTransformMap = null; private int? _depthIndex = null; + + /// + /// outputVisualMap. + /// + /// 3 protected PropertyMap _outputVisualMap = null; internal string Name @@ -53,16 +62,21 @@ namespace Tizen.NUI get; } + /// + /// Constructor. + /// + /// 3 public VisualMap() { } /// - /// Get or set size of the visual.
+ /// Gets or sets the size of the visual.
/// It can be either relative (percentage of the parent) - /// or absolute (in world units).
+ /// or absolute (in world units).
/// Optional. /// + /// 3 public Size2D Size { get @@ -74,18 +88,19 @@ namespace Tizen.NUI _visualSize = value; if (_visualSizePolicy == null) { - _visualSizePolicy = new Vector2(0.0f, 0.0f); + _visualSizePolicy = new Vector2(1.0f, 1.0f); } UpdateVisual(); } } /// - /// Get or set offset of the visual.
+ /// Gets or sets the offset of the visual.
/// It can be either relative (percentage of the parent) - /// or absolute (in world units).
+ /// or absolute (in world units).
/// Optional. /// + /// 3 public Vector2 Position { get @@ -97,17 +112,18 @@ namespace Tizen.NUI _visualOffset = value; if (_visualOffsetPolicy == null) { - _visualOffsetPolicy = new Vector2(0.0f, 0.0f); + _visualOffsetPolicy = new Vector2(1.0f, 1.0f); } UpdateVisual(); } } /// - /// Get or set relative size of the visual
- /// (percentage [0.0f to 1.0f] of the control).
+ /// Gets or sets the relative size of the visual
+ /// (percentage [0.0f to 1.0f] of the control).
/// Optional. /// + /// 3 public RelativeVector2 RelativeSize { get @@ -123,10 +139,11 @@ namespace Tizen.NUI } /// - /// Get or set relative offset of the visual
- /// (percentage [0.0f to 1.0f] of the control).
+ /// Gets or sets the relative offset of the visual
+ /// (percentage [0.0f to 1.0f] of the control).
/// Optional. /// + /// 3 public RelativeVector2 RelativePosition { get @@ -142,11 +159,12 @@ namespace Tizen.NUI } /// - /// Get or set whether the x and y offset values are relative
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
- /// Be default, both the x and the y offset is relative.
+ /// Gets or sets whether the x and y offset values are relative
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
+ /// By default, both the x and the y offset are relative.
/// Optional. /// + /// 3 public VisualTransformPolicyType PositionPolicy { get @@ -177,11 +195,12 @@ namespace Tizen.NUI } /// - /// Get or set whether the x offset values are relative
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
- /// Be default, the x offset is relative.
+ /// Gets or sets whether the x offset values are relative
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
+ /// By default, the x offset is relative.
/// Optional. /// + /// 3 public VisualTransformPolicyType PositionPolicyX { get @@ -217,11 +236,12 @@ namespace Tizen.NUI } /// - /// Get or set whether the y offset values are relative
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
- /// Be default, the y offset is relative.
+ /// Gets or sets whether the y offset values are relative
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
+ /// By default, the y offset is relative.
/// Optional. /// + /// 3 public VisualTransformPolicyType PositionPolicyY { get @@ -256,11 +276,12 @@ namespace Tizen.NUI } /// - /// Get or set whether the width or height size values are relative
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
- /// Be default, both the width and the height offset is relative to the control's size.
+ /// Gets or sets whether the size values of the width or the height are relative
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
+ /// By default, offsets of both the width and the height are relative to the control's size.
/// Optional. /// + /// 3 public VisualTransformPolicyType SizePolicy { get @@ -291,11 +312,12 @@ namespace Tizen.NUI } /// - /// Get or set whether the width size values are relative
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
- /// Be default, the width value is relative to the control's width.
+ /// Gets or sets whether size values of the width are relative.
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
+ /// By default, the value of the width is relative to the control's width.
/// Optional. /// + /// 3 public VisualTransformPolicyType SizePolicyWidth { get @@ -330,11 +352,12 @@ namespace Tizen.NUI } /// - /// Get or set whether the height size values are relative
- /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
- /// Be default, both the height value is relative to the control's height.
+ /// Gets or sets whether size values of the height are relative
+ /// (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
+ /// By default, the height value is relative to the control's height.
/// Optional. /// + /// 3 public VisualTransformPolicyType SizePolicyHeight { get @@ -369,10 +392,11 @@ namespace Tizen.NUI } /// - /// Get or set the origin of the visual within its control area.
- /// By default, the origin is Center.
+ /// Gets or sets the origin of the visual within its control area.
+ /// By default, the origin is center.
/// Optional. /// + /// 3 public Visual.AlignType Origin { get @@ -387,10 +411,11 @@ namespace Tizen.NUI } /// - /// Get or set the anchor-point of the visual.
- /// By default, the anchor point is Center.
+ /// Gets or sets the anchor point of the visual.
+ /// By default, the anchor point is center.
/// Optional. /// + /// 3 public Visual.AlignType AnchorPoint { get @@ -405,10 +430,11 @@ namespace Tizen.NUI } /// - /// Get or set the depth index of the visual.
- /// By default, the depth index is 0.
+ /// Gets or sets the depth index of the visual.
+ /// By default, the depth index is 0.
/// Optional. /// + /// 3 public int DepthIndex { get @@ -433,8 +459,9 @@ namespace Tizen.NUI } /// - /// Get the transform map used by the visual. + /// Gets the transform map used by the visual. /// + /// 3 public PropertyMap OutputTransformMap { get @@ -444,14 +471,19 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected virtual void ComposingPropertyMap() { _outputVisualMap = new PropertyMap(); } /// - /// Get the property map to create the visual. + /// Gets the property map to create the visual. /// + /// 3 public PropertyMap OutputVisualMap { get @@ -474,16 +506,41 @@ namespace Tizen.NUI } } + /// + /// The shader of the visual. + /// + /// 3 protected PropertyMap _shader = null; //private PropertyMap _transform = null; + + /// + /// The premultipliedAlpha of the visual. + /// + /// 3 protected bool? _premultipliedAlpha = null; + + /// + /// The mixColor of the Visual. + /// + /// 3 protected Color _mixColor = null; + + /// + /// The opacity of the visual. + /// + /// 3 protected float? _opacity = null; + + /// + /// The map for visual. + /// + /// 3 protected PropertyMap _commonlyUsedMap = null; /// /// The shader to use in the visual. /// + /// 3 public PropertyMap Shader { get @@ -498,9 +555,10 @@ namespace Tizen.NUI } /// - /// Enables/disables premultiplied alpha.
- /// The premultiplied alpha is false by default unless this behaviour is modified by the derived Visual type. + /// Enables or disables the premultiplied alpha.
+ /// The premultiplied alpha is false by default unless this behavior is modified by the derived visual type. /// + /// 3 public bool PremultipliedAlpha { get @@ -517,6 +575,7 @@ namespace Tizen.NUI /// /// Mix color is a blend color for any visual. /// + /// 3 public Color MixColor { get @@ -531,8 +590,9 @@ namespace Tizen.NUI } /// - /// Opacity is the alpha component of the mixColor, above. + /// Opacity is the alpha component of the mix color discussed above. /// + /// 3 public float Opacity { get @@ -549,10 +609,15 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a image visual. + /// A class encapsulating the property map of the image visual. /// + /// 3 public class ImageVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public ImageVisual() : base() { } @@ -570,12 +635,15 @@ namespace Tizen.NUI private WrapModeType? _wrapModeV = null; private float? _maskContentScale = null; private bool? _cropToMask = null; + private ReleasePolicyType? _releasePolicy = null; + private LoadPolicyType? _loadPolicy = null; + private bool? _orientationCorrection = true; /// - /// Get or set the URL of the image.
+ /// Gets or sets the URL of the image.
/// Mandatory. /// - + /// 3 public string URL { get @@ -591,9 +659,10 @@ namespace Tizen.NUI /// - /// Get or set the URL of the alpha mask.
+ /// Gets or sets the URL of the alpha mask.
/// Optional. /// + /// 3 public string AlphaMaskURL { get @@ -608,11 +677,12 @@ namespace Tizen.NUI } /// - /// Get or set fitting options, used when resizing images to fit desired dimensions.
- /// If not supplied, default is FittingModeType.ShrinkToFit.
- /// For Normal Quad images only.
+ /// Gets or sets fitting options used when resizing images to fit the desired dimensions.
+ /// If not supplied, the default is FittingModeType.ShrinkToFit.
+ /// For normal quad images only.
/// Optional. /// + /// 3 public FittingModeType FittingMode { get @@ -627,11 +697,12 @@ namespace Tizen.NUI } /// - /// Get or set filtering options, used when resizing images to sample original pixels.
- /// If not supplied, default is SamplingModeType.Box.
- /// For Normal Quad images only.
+ /// Gets or sets filtering options used when resizing images to the sample original pixels.
+ /// If not supplied, the default is SamplingModeType.Box.
+ /// For normal quad images only.
/// Optional. /// + /// 3 public SamplingModeType SamplingMode { get @@ -646,11 +717,12 @@ namespace Tizen.NUI } /// - /// Get or set the desired image width.
- /// If not specified, the actual image width is used.
- /// For Normal Quad images only.
+ /// Gets or sets the desired image width.
+ /// If not specified, the actual image width is used.
+ /// For normal quad images only.
/// Optional. /// + /// 3 public int DesiredWidth { get @@ -665,11 +737,12 @@ namespace Tizen.NUI } /// - /// Get or set the desired image height.
- /// If not specified, the actual image height is used.
- /// For Normal Quad images only.
+ /// Gets or sets the desired image height.
+ /// If not specified, the actual image height is used.
+ /// For normal quad images only.
/// Optional. /// + /// 3 public int DesiredHeight { get @@ -684,11 +757,12 @@ namespace Tizen.NUI } /// - /// Get or set whether to load the image synchronously.
- /// If not specified, the default is false, i.e. the image is loaded asynchronously.
- /// For Normal Quad images only.
+ /// Gets or sets whether to load the image synchronously.
+ /// If not specified, the default is false, i.e., the image is loaded asynchronously.
+ /// For normal quad images only.
/// Optional. /// + /// 3 public bool SynchronousLoading { get @@ -703,11 +777,12 @@ namespace Tizen.NUI } /// - /// Get or set whether to draws the borders only(If true).
- /// If not specified, the default is false.
- /// For N-Patch images only.
+ /// Gets or sets whether to draw the borders only (If true).
+ /// If not specified, the default is false.
+ /// For n-patch images only.
/// Optional. /// + /// 3 public bool BorderOnly { get @@ -722,13 +797,14 @@ namespace Tizen.NUI } /// - /// Get or set the image area to be displayed.
- /// It is a rectangular area.
- /// The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively.
- /// If not specified, the default value is Vector4(0.0, 0.0, 1.0, 1.0), i.e. the entire area of the image.
- /// For For Normal QUAD image only.
+ /// Gets or sets the image area to be displayed.
+ /// It is a rectangular area.
+ /// The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively.
+ /// If not specified, the default value is Vector4 (0.0, 0.0, 1.0, 1.0), i.e., the entire area of the image.
+ /// For normal quad images only.
/// Optional. /// + /// 3 public Vector4 PixelArea { get @@ -743,12 +819,13 @@ namespace Tizen.NUI } /// - /// Get or set the wrap mode for u coordinate.
- /// It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0.
- /// If not specified, the default is WrapModeType.Default(CLAMP).
- /// For Normal QUAD image only.
+ /// Gets or sets the wrap mode for the u coordinate.
+ /// It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0.
+ /// If not specified, the default is WrapModeType.Default(CLAMP).
+ /// For normal quad images only.
/// Optional. /// + /// 3 public WrapModeType WrapModeU { get @@ -763,13 +840,14 @@ namespace Tizen.NUI } /// - /// Get or set the wrap mode for v coordinate.
- /// It decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0.
- /// The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively.
- /// If not specified, the default is WrapModeType.Default(CLAMP).
- /// For Normal QUAD image only. + /// Gets or sets the wrap mode for the v coordinate.
+ /// It decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0.
+ /// The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively.
+ /// If not specified, the default is WrapModeType.Default(CLAMP).
+ /// For normal quad images only. /// Optional. /// + /// 3 public WrapModeType WrapModeV { get @@ -783,6 +861,10 @@ namespace Tizen.NUI } } + /// + /// Gets or sets scale factor to apply to the content image before masking. + /// + /// 4 public float MaskContentScale { get @@ -796,6 +878,10 @@ namespace Tizen.NUI } } + /// + /// Whether to crop image to mask or scale mask to fit image. + /// + /// 4 public bool CropToMask { get @@ -809,6 +895,69 @@ namespace Tizen.NUI } } + + /// + /// Get or set the Image Visual release policy
+ /// It decides if a texture should be released from the cache or kept to reduce loading time
+ /// + /// 5 + public ReleasePolicyType ReleasePolicy + { + get + { + return _releasePolicy ?? (ReleasePolicyType.Destroyed ); + } + set + { + _releasePolicy = value; + UpdateVisual(); + } + } + + + /// + /// Get or set the Image Visual image loading policy
+ /// It decides if a texture should be loaded immediately after source set or only after visual is added to window
+ /// + /// 5 + public LoadPolicyType LoadPolicy + { + get + { + return _loadPolicy ?? (LoadPolicyType.Attached); + } + set + { + _loadPolicy = value; + UpdateVisual(); + } + } + + /// + /// Get or set whether to automatically correct the orientation based on exif data.
+ /// If not specified, the default is true.
+ /// For JPEG images only.
+ /// Optional. + /// + /// 5 + public bool OrientationCorrection + { + get + { + return _orientationCorrection ?? (true); + } + set + { + _orientationCorrection = value; + UpdateVisual(); + } + } + + + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (_url != null) @@ -832,15 +981,23 @@ namespace Tizen.NUI if (_opacity != null) { _outputVisualMap.Add((int)Visual.Property.Opacity, new PropertyValue((float)_opacity)); } if (_maskContentScale != null) { _outputVisualMap.Add((int)ImageVisualProperty.MaskContentScale, new PropertyValue((float)_maskContentScale)); } if (_cropToMask != null) { _outputVisualMap.Add((int)ImageVisualProperty.CropToMask, new PropertyValue((bool)_cropToMask)); } + if (_releasePolicy != null) { _outputVisualMap.Add( ImageVisualProperty.ReleasePolicy , new PropertyValue((int)_releasePolicy)); } + if (_loadPolicy != null) { _outputVisualMap.Add( ImageVisualProperty.LoadPolicy, new PropertyValue((int)_loadPolicy)); } + if (_orientationCorrection != null) { _outputVisualMap.Add( ImageVisualProperty.OrientationCorrection, new PropertyValue((bool)_orientationCorrection)); } } } } /// - /// A class encapsulating the property map of a text visual. + /// A class encapsulating the property map of the text visual. /// + /// 3 public class TextVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public TextVisual() : base() { } @@ -856,9 +1013,10 @@ namespace Tizen.NUI private bool? _enableMarkup = null; /// - /// Get or set the text to display in UTF-8 format.
+ /// Gets or sets the text to display in the UTF-8 format.
/// Mandatory. /// + /// 3 public string Text { get @@ -873,9 +1031,10 @@ namespace Tizen.NUI } /// - /// Get or set the requested font family to use.
+ /// Gets or sets the requested font family to use.
/// Optional. /// + /// 3 public string FontFamily { get @@ -890,9 +1049,10 @@ namespace Tizen.NUI } /// - /// Get or set the requested font style to use.
+ /// Gets or sets the requested font style to use.
/// Optional. /// + /// 3 public PropertyMap FontStyle { get @@ -907,9 +1067,10 @@ namespace Tizen.NUI } /// - /// Get or set the size of font in points.
+ /// Gets or sets the size of font in points.
/// Mandatory. /// + /// 3 public float PointSize { get @@ -924,10 +1085,11 @@ namespace Tizen.NUI } /// - /// Get or set the single-line or multi-line layout option.
- /// If not specified, the default is false.
+ /// Gets or sets the single-line or multi-line layout option.
+ /// If not specified, the default is false.
/// Optional. /// + /// 3 public bool MultiLine { get @@ -942,10 +1104,11 @@ namespace Tizen.NUI } /// - /// Get or set the line horizontal alignment.
- /// If not specified, the default is Begin.
+ /// Gets or sets the line horizontal alignment.
+ /// If not specified, the default is begin.
/// Optional. /// + /// 3 public HorizontalAlignment HorizontalAlignment { get @@ -992,10 +1155,11 @@ namespace Tizen.NUI } /// - /// Get or set the line vertical alignment.
- /// If not specified, the default is Top.
+ /// Gets or sets the line vertical alignment.
+ /// If not specified, the default is top.
/// Optional. /// + /// 3 public VerticalAlignment VerticalAlignment { get @@ -1042,9 +1206,10 @@ namespace Tizen.NUI } /// - /// Get or set the color of the text.
+ /// Gets or sets the color of the text.
/// Optional. /// + /// 3 public Color TextColor { get @@ -1059,9 +1224,10 @@ namespace Tizen.NUI } /// - /// Get or set whether the mark-up processing is enabled.
+ /// Gets or sets whether the mark-up processing is enabled.
/// Optional. /// + /// 3 public bool EnableMarkup { get @@ -1075,6 +1241,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (_text != null && _pointSize != null) @@ -1099,10 +1269,15 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a border visual. + /// A class encapsulating the property map of the border visual. /// + /// 3 public class BorderVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public BorderVisual() : base() { } @@ -1112,9 +1287,10 @@ namespace Tizen.NUI private bool? _antiAliasing = null; /// - /// Get or set the color of the border.
+ /// Gets or sets the color of the border.
/// Mandatory. /// + /// 3 public Color Color { get @@ -1129,9 +1305,10 @@ namespace Tizen.NUI } /// - /// Get or set the width of the border (in pixels).
+ /// Gets or sets the width of the border (in pixels).
/// Mandatory. /// + /// 3 public float BorderSize { get @@ -1146,10 +1323,11 @@ namespace Tizen.NUI } /// - /// Get or set whether anti-aliasing of the border is required.
- /// If not supplied, default is false.
+ /// Gets or sets whether the anti-aliasing of the border is required.
+ /// If not supplied, the default is false.
/// Optional. /// + /// 3 public bool AntiAliasing { get @@ -1163,6 +1341,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (_color != null && _size != null) @@ -1181,10 +1363,15 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a color visual. + /// A class encapsulating the property map of the color visual. /// + /// 3 public class ColorVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public ColorVisual() : base() { } @@ -1192,9 +1379,10 @@ namespace Tizen.NUI private Color _mixColorForColorVisual = null; /// - /// Get or set the solid color required.
+ /// Gets or sets the solid color required.
/// Mandatory. /// + /// 3 public Color Color { get @@ -1208,6 +1396,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (_mixColorForColorVisual != null) @@ -1223,10 +1415,15 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a gradient visual. + /// A class encapsulating the property map of the gradient visual. /// + /// 3 public class GradientVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public GradientVisual() : base() { } @@ -1241,9 +1438,10 @@ namespace Tizen.NUI private GradientVisualSpreadMethodType? _spreadMethod = null; /// - /// Get or set the start position of a linear gradient.
- /// Mandatory for Linear.
+ /// Gets or sets the start position of a linear gradient.
+ /// Mandatory for linear.
/// + /// 3 public Vector2 StartPosition { get @@ -1258,9 +1456,10 @@ namespace Tizen.NUI } /// - /// Get or set the end position of a linear gradient.
- /// Mandatory for Linear.
+ /// Gets or sets the end position of a linear gradient.
+ /// Mandatory for linear.
/// + /// 3 public Vector2 EndPosition { get @@ -1275,9 +1474,10 @@ namespace Tizen.NUI } /// - /// Get or set the center point of a radial gradient.
- /// Mandatory for Radial.
+ /// Gets or sets the center point of a radial gradient.
+ /// Mandatory for radial.
/// + /// 3 public Vector2 Center { get @@ -1292,9 +1492,10 @@ namespace Tizen.NUI } /// - /// Get or set the size of the radius of a radial gradient.
- /// Mandatory for Radial.
+ /// Gets or sets the size of the radius of a radial gradient.
+ /// Mandatory for radial.
/// + /// 3 public float Radius { get @@ -1309,11 +1510,12 @@ namespace Tizen.NUI } /// - /// Get or set all the stop offsets.
- /// A PropertyArray of float.
- /// If not supplied, default is 0.0f and 1.0f.
+ /// Gets or sets all the stop offsets.
+ /// A PropertyArray of float.
+ /// If not supplied, the default is 0.0f and 1.0f.
/// Optional. /// + /// 3 public PropertyArray StopOffset { get @@ -1328,11 +1530,12 @@ namespace Tizen.NUI } /// - /// Get or set the color at the stop offsets.
- /// A PropertyArray of Color.
- /// At least 2 values required to show a gradient.
+ /// Gets or sets the color at the stop offsets.
+ /// A PropertyArray of color.
+ /// At least 2 values are required to show a gradient.
/// Mandatory. /// + /// 3 public PropertyArray StopColor { get @@ -1347,10 +1550,11 @@ namespace Tizen.NUI } /// - /// Get or set defines the coordinate system for certain attributes of the points in a gradient.
- /// If not supplied, default is GradientVisualUnitsType.ObjectBoundingBox.
+ /// Gets or sets descriptions of the coordinate system for certain attributes of the points in a gradient.
+ /// If not supplied, the default is GradientVisualUnitsType.ObjectBoundingBox.
/// Optional. /// + /// 3 public GradientVisualUnitsType Units { get @@ -1365,10 +1569,11 @@ namespace Tizen.NUI } /// - /// Get or set indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.
- /// If not supplied, default is GradientVisualSpreadMethodType.Pad.
+ /// Gets or sets indications of what happens if the gradient starts or ends inside the bounds of the target rectangle.
+ /// If not supplied, the default is GradientVisualSpreadMethodType.Pad.
/// Optional. /// + /// 3 public GradientVisualSpreadMethodType SpreadMethod { get @@ -1382,6 +1587,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (((_startPosition != null && _endPosition != null) || (_center != null && _radius != null)) && _stopColor != null) @@ -1405,10 +1614,15 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a mesh visual. + /// A class encapsulating the property map of the mesh visual. /// + /// 3 public class MeshVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public MeshVisual() : base() { } @@ -1422,9 +1636,10 @@ namespace Tizen.NUI private Vector3 _lightPosition = null; /// - /// Get or set the location of the ".obj" file.
+ /// Gets or sets the location of the ".obj" file.
/// Mandatory. /// + /// 3 public string ObjectURL { get @@ -1439,10 +1654,11 @@ namespace Tizen.NUI } /// - /// Get or set the location of the ".mtl" file.
- /// If not specified, then a textureless object is assumed.
+ /// Gets or sets the location of the ".mtl" file.
+ /// If not specified, then a textureless object is assumed.
/// Optional. /// + /// 3 public string MaterialtURL { get @@ -1457,9 +1673,10 @@ namespace Tizen.NUI } /// - /// Get or set path to the directory the textures (including gloss and normal) are stored in.
- /// Mandatory if using material.
+ /// Gets or sets the path to the directory the textures (including gloss and normal) are stored in.
+ /// Mandatory if using material.
/// + /// 3 public string TexturesPath { get @@ -1474,11 +1691,12 @@ namespace Tizen.NUI } /// - /// Get or set the type of shading mode that the mesh will use.
- /// If anything the specified shading mode requires is missing, a simpler mode that can be handled with what has been supplied will be used instead.
- /// If not specified, it will use the best it can support (will try MeshVisualShadingModeValue.TexturedWithDetailedSpecularLighting first).
+ /// Gets or sets the type of shading mode that the mesh will use.
+ /// If anything the specified shading mode requires is missing, a simpler mode that can be handled with what has been supplied will be used instead.
+ /// If not specified, it will use the best it can support (will try MeshVisualShadingModeValue.TexturedWithDetailedSpecularLighting first).
/// Optional. /// + /// 3 public MeshVisualShadingModeValue ShadingMode { get @@ -1493,10 +1711,11 @@ namespace Tizen.NUI } /// - /// Get or set whether to use mipmaps for textures or not.
- /// If not specified, the default is true.
+ /// Gets or sets whether to use mipmaps for textures or not.
+ /// If not specified, the default is true.
/// Optional. /// + /// 3 public bool UseMipmapping { get @@ -1511,10 +1730,11 @@ namespace Tizen.NUI } /// - /// Get or set whether to average normals at each point to smooth textures or not.
- /// If not specified, the default is true.
+ /// Gets or sets whether to average normals at each point to smooth textures or not.
+ /// If not specified, the default is true.
/// Optional. /// + /// 3 public bool UseSoftNormals { get @@ -1529,12 +1749,13 @@ namespace Tizen.NUI } /// - /// Get or set the position, in stage space, of the point light that applies lighting to the model.
- /// This is based off the stage's dimensions, so using the width and height of the stage halved will correspond to the center, - /// and using all zeroes will place the light at the top left corner.
- /// If not specified, the default is an offset outwards from the center of the screen.
+ /// Gets or sets the position, in the stage space, of the point light that applies lighting to the model.
+ /// This is based off the stage's dimensions, so using the width and the height of the stage halved will correspond to the center, + /// and using all zeroes will place the light at the top-left corner.
+ /// If not specified, the default is an offset outwards from the center of the screen.
/// Optional. /// + /// 3 public Vector3 LightPosition { get @@ -1548,6 +1769,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (_objectURL != null) @@ -1569,10 +1794,15 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a primetive visual. + /// A class encapsulating the property map of the primetive visual. /// + /// 3 public class PrimitiveVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public PrimitiveVisual() : base() { } @@ -1591,10 +1821,11 @@ namespace Tizen.NUI private Vector3 _lightPosition = null; /// - /// Get or set the specific shape to render.
- /// If not specified, the default is PrimitiveVisualShapeType.Sphere.
+ /// Gets or sets the specific shape to render.
+ /// If not specified, the default is PrimitiveVisualShapeType.Sphere.
/// Optional. /// + /// 3 public PrimitiveVisualShapeType Shape { get @@ -1609,12 +1840,13 @@ namespace Tizen.NUI } /// - /// Get or set the color of the shape.
- /// If not specified, the default is Color(0.5, 0.5, 0.5, 1.0).
- /// Applies to ALL shapes.
+ /// Gets or sets the color of the shape.
+ /// If not specified, the default is Color (0.5, 0.5, 0.5, 1.0).
+ /// Applies to all shapes.
/// Optional. /// - public Color MixColor + /// 3 + public new Color MixColor { get { @@ -1628,12 +1860,13 @@ namespace Tizen.NUI } /// - /// Get or set the number of slices as you go around the shape.
- /// For spheres and conical frustrums, this determines how many divisions there are as you go around the object.
- /// If not specified, the default is 128.
- /// The range is from 1 to 255.
+ /// Gets or sets the number of slices as you go around the shape.
+ /// For spheres and conical frustrums, this determines how many divisions there are as you go around the object.
+ /// If not specified, the default is 128.
+ /// The range is from 1 to 255.
/// Optional. /// + /// 3 public int Slices { get @@ -1648,12 +1881,13 @@ namespace Tizen.NUI } /// - /// Get or set the number of stacks as you go down the shape.
- /// For spheres, 'stacks' determines how many layers there are as you go down the object.
- /// If not specified, the default is 128.
- /// The range is from 1 to 255.
+ /// Gets or sets the number of stacks as you go down the shape.
+ /// For spheres, 'stacks' determines how many layers there are as you go down the object.
+ /// If not specified, the default is 128.
+ /// The range is from 1 to 255.
/// Optional. /// + /// 3 public int Stacks { get @@ -1668,12 +1902,13 @@ namespace Tizen.NUI } /// - /// Get or set the scale of the radius of the top circle of a conical frustrum.
- /// If not specified, the default is 1.0f.
- /// Applies to: - PrimitiveVisualShapeType.ConicalFrustrum
- /// Only values greater than or equal to 0.0f are accepted.
+ /// Gets or sets the scale of the radius of the top circle of a conical frustrum.
+ /// If not specified, the default is 1.0f.
+ /// Applies to: - PrimitiveVisualShapeType.ConicalFrustrum
+ /// Only values greater than or equal to 0.0f are accepted.
/// Optional. /// + /// 3 public float ScaleTopRadius { get @@ -1688,13 +1923,14 @@ namespace Tizen.NUI } /// - /// Get or set the scale of the radius of the bottom circle of a conical frustrum.
- /// If not specified, the default is 1.5f.
- /// Applies to: - PrimitiveVisualShapeType.ConicalFrustrum
- /// - PrimitiveVisualShapeType.Cone
- /// Only values greater than or equal to 0.0f are accepted.
+ /// Gets or sets the scale of the radius of the bottom circle of a conical frustrum.
+ /// If not specified, the default is 1.5f.
+ /// Applies to: - PrimitiveVisualShapeType.ConicalFrustrum
+ /// - PrimitiveVisualShapeType.Cone
+ /// Only values greater than or equal to 0.0f are accepted.
/// Optional. /// + /// 3 public float ScaleBottomRadius { get @@ -1709,15 +1945,16 @@ namespace Tizen.NUI } /// - /// Get or set the scale of the height of a conic.
- /// If not specified, the default is 3.0f.
- /// Applies to:
- /// - PrimitiveVisualShapeType.ConicalFrustrum
- /// - PrimitiveVisualShapeType.Cone
- /// - PrimitiveVisualShapeType.Cylinder
- /// Only values greater than or equal to 0.0f are accepted.
+ /// Gets or sets the scale of the height of a conic.
+ /// If not specified, the default is 3.0f.
+ /// Applies to:
+ /// - PrimitiveVisualShapeType.ConicalFrustrum
+ /// - PrimitiveVisualShapeType.Cone
+ /// - PrimitiveVisualShapeType.Cylinder
+ /// Only values greater than or equal to 0.0f are accepted.
/// Optional. /// + /// 3 public float ScaleHeight { get @@ -1732,13 +1969,14 @@ namespace Tizen.NUI } /// - /// Get or set the scale of the radius of a cylinder.
- /// If not specified, the default is 1.0f.
- /// Applies to:
- /// - PrimitiveVisualShapeType.Cylinder
- /// Only values greater than or equal to 0.0f are accepted.
+ /// Gets or sets the scale of the radius of a cylinder.
+ /// If not specified, the default is 1.0f.
+ /// Applies to:
+ /// - PrimitiveVisualShapeType.Cylinder
+ /// Only values greater than or equal to 0.0f are accepted.
/// Optional. /// + /// 3 public float ScaleRadius { get @@ -1753,15 +1991,16 @@ namespace Tizen.NUI } /// - /// Get or set the dimensions of a cuboid. Scales in the same fashion as a 9-patch image.
- /// If not specified, the default is Vector3.One.
- /// Applies to:
- /// - PrimitiveVisualShapeType.Cube
- /// - PrimitiveVisualShapeType.Octahedron
- /// - PrimitiveVisualShapeType.BevelledCube
- /// Each vector3 parameter should be greater than or equal to 0.0f.
+ /// Gets or sets the dimensions of a cuboid. Scales in the same fashion as a 9-patch image.
+ /// If not specified, the default is Vector3.One.
+ /// Applies to:
+ /// - PrimitiveVisualShapeType.Cube
+ /// - PrimitiveVisualShapeType.Octahedron
+ /// - PrimitiveVisualShapeType.BevelledCube
+ /// Each Vector3 parameter should be greater than or equal to 0.0f.
/// Optional. /// + /// 3 public Vector3 ScaleDimensions { get @@ -1776,14 +2015,15 @@ namespace Tizen.NUI } /// - /// Get or set determines how bevelled the cuboid should be, based off the smallest dimension.
- /// Bevel percentage ranges from 0.0 to 1.0. It affects the ratio of the outer face widths to the width of the overall cube.
- /// If not specified, the default is 0.0f (no bevel).
- /// Applies to:
- /// - PrimitiveVisualShapeType.BevelledCube
- /// The range is from 0.0f to 1.0f.
+ /// Gets or sets determines how bevelled the cuboid should be, based off the smallest dimension.
+ /// Bevel percentage ranges from 0.0 to 1.0. It affects the ratio of the outer face widths to the width of the overall cube.
+ /// If not specified, the default is 0.0f (no bevel).
+ /// Applies to:
+ /// - PrimitiveVisualShapeType.BevelledCube
+ /// The range is from 0.0f to 1.0f.
/// Optional. /// + /// 3 public float BevelPercentage { get @@ -1798,13 +2038,14 @@ namespace Tizen.NUI } /// - /// Get or set defines how smooth the bevelled edges should be.
- /// If not specified, the default is 0.0f (sharp edges).
- /// Applies to:
- /// - PrimitiveVisualShapeType.BevelledCube
- /// The range is from 0.0f to 1.0f.
+ /// Gets or sets descriptions of how smooth the bevelled edges should be.
+ /// If not specified, the default is 0.0f (sharp edges).
+ /// Applies to:
+ /// - PrimitiveVisualShapeType.BevelledCube
+ /// The range is from 0.0f to 1.0f.
/// Optional. /// + /// 3 public float BevelSmoothness { get @@ -1819,13 +2060,14 @@ namespace Tizen.NUI } /// - /// Get or set the position, in stage space, of the point light that applies lighting to the model.
- /// This is based off the stage's dimensions, so using the width and height of the stage halved will correspond to the center, - /// and using all zeroes will place the light at the top left corner.
- /// If not specified, the default is an offset outwards from the center of the screen.
- /// Applies to ALL shapes.
+ /// Gets or sets the position, in the stage space, of the point light that applies lighting to the model.
+ /// This is based off the stage's dimensions, so using the width and the height of the stage halved will correspond to the center, + /// and using all zeroes will place the light at the top-left corner.
+ /// If not specified, the default is an offset outwards from the center of the screen.
+ /// Applies to all shapes.
/// Optional. /// + /// 3 public Vector3 LightPosition { get @@ -1839,6 +2081,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { _outputVisualMap = new PropertyMap(); ; @@ -1862,10 +2108,15 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a n-patch image visual. + /// A class encapsulating the property map of the n-patch image visual. /// + /// 3 public class NPatchVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public NPatchVisual() : base() { } @@ -1875,9 +2126,10 @@ namespace Tizen.NUI private Rectangle _border = null; /// - /// Get or set the URL of the image.
+ /// Gets or sets the URL of the image.
/// Mandatory. /// + /// 3 public string URL { get @@ -1892,11 +2144,12 @@ namespace Tizen.NUI } /// - /// Get or set whether to draws the borders only(If true).
- /// If not specified, the default is false.
- /// For N-Patch images only.
+ /// Gets or sets whether to draw the borders only (If true).
+ /// If not specified, the default is false.
+ /// For n-patch images only.
/// Optional. /// + /// 3 public bool BorderOnly { get @@ -1911,10 +2164,11 @@ namespace Tizen.NUI } /// - /// The border of the image in the order: left, right, bottom, top.
- /// For N-Patch images only.
+ /// The border of the image is in the order: left, right, bottom, top.
+ /// For n-patch images only.
/// Optional. /// + /// 3 public Rectangle Border { get @@ -1928,6 +2182,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (_url != null) @@ -1946,16 +2204,25 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a SVG visual. + /// A class encapsulating the property map of the SVG visual. /// + /// 3 public class SVGVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public SVGVisual() : base() { } private string _url = null; + /// + /// The url of the svg resource. + /// + /// 3 public string URL { get @@ -1969,6 +2236,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (_url != null) @@ -1985,10 +2256,15 @@ namespace Tizen.NUI } /// - /// A class encapsulating the property map of a Animated Image(AGIF) visual. + /// A class encapsulating the property map of the animated image (AGIF) visual. /// + /// 3 public class AnimatedImageVisual : VisualMap { + /// + /// Constructor. + /// + /// 3 public AnimatedImageVisual() : base() { } @@ -1998,11 +2274,15 @@ namespace Tizen.NUI private int? _cacheSize = null; private float? _frameDelay = null; + /// + /// Gets and Sets the url in the AnimatedImageVisual. + /// + /// 3 public string URL { get { - if( _urls == null ) + if( _urls != null ) { return _urls[0]; } @@ -2026,6 +2306,10 @@ namespace Tizen.NUI } } + /// + /// Gets and Sets the url list in the AnimatedImageVisual. + /// + /// 4 public List URLS { get @@ -2039,6 +2323,10 @@ namespace Tizen.NUI } } + /// + /// Gets and Sets the batch size for pre-loading images in the AnimatedImageVisual. + /// + /// 4 public int BatchSize { get @@ -2052,6 +2340,10 @@ namespace Tizen.NUI } } + /// + /// Gets and Sets the cache size for loading images in the AnimatedImageVisual. + /// + /// 4 public int CacheSize { get @@ -2064,6 +2356,11 @@ namespace Tizen.NUI UpdateVisual(); } } + + /// + /// Gets and Sets The number of milliseconds between each frame in the AnimatedImageVisual. + /// + /// 4 public float FrameDelay { get @@ -2077,6 +2374,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { if (_urls != null) @@ -2108,10 +2409,17 @@ namespace Tizen.NUI } - //temporary fix for TCT + /// + /// A class encapsulating the property map of the transition data. + /// + /// 3 public class VisualAnimator : VisualMap { + /// + /// Create VisualAnimator object. + /// + /// 3 public VisualAnimator() : base() { } @@ -2123,6 +2431,10 @@ namespace Tizen.NUI private string _propertyIndex = null; private object _destinationValue = null; + /// + /// Sets and Gets the AlphaFunction of this transition. + /// + /// 3 public AlphaFunction.BuiltinFunctions AlphaFunction { get @@ -2237,6 +2549,10 @@ namespace Tizen.NUI } } + /// + /// Sets and Gets the StartTime of this transition. + /// + /// 3 public int StartTime { get @@ -2249,6 +2565,10 @@ namespace Tizen.NUI } } + /// + /// Sets and Gets the EndTime of this transition. + /// + /// 3 public int EndTime { get @@ -2261,6 +2581,10 @@ namespace Tizen.NUI } } + /// + /// Sets and Gets the Target of this transition. + /// + /// 3 public string Target { get @@ -2273,6 +2597,10 @@ namespace Tizen.NUI } } + /// + /// Sets and Gets the PropertyIndex of this transition. + /// + /// 3 public string PropertyIndex { get @@ -2285,6 +2613,10 @@ namespace Tizen.NUI } } + /// + /// Sets and Gets the DestinationValue of this transition. + /// + /// 3 public object DestinationValue { get @@ -2297,6 +2629,10 @@ namespace Tizen.NUI } } + /// + /// Compose the out visual map. + /// + /// 3 protected override void ComposingPropertyMap() { PropertyMap _animator = new PropertyMap(); @@ -2307,9 +2643,9 @@ namespace Tizen.NUI _timePeriod.Add("delay", new PropertyValue(_startTime / 1000.0f)); _animator.Add("timePeriod", new PropertyValue(_timePeriod)); - string _str1 = _propertyIndex.Substring(0, 1); - string _str2 = _propertyIndex.Substring(1); - string _str = _str1.ToLower() + _str2; + StringBuilder sb = new StringBuilder(_propertyIndex); + sb[0] = (char)(sb[0] | 0x20); + string _str = sb.ToString(); PropertyValue val = PropertyValue.CreateFromObject(_destinationValue);