X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2FTizen.NUI%2Fsrc%2Fpublic%2FVisualMaps.cs;h=2368c554b217d6a3b72ca09372c4b051b877a6d6;hb=bff9a094cf97fb687030cb65963212b7f6514b26;hp=fde3f815143328c39a3c60e14c50158786b0b849;hpb=686b0686bc22f304158721738c329d70fd4195d0;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 fde3f81..2368c55 100755
--- a/src/Tizen.NUI/src/public/VisualMaps.cs
+++ b/src/Tizen.NUI/src/public/VisualMaps.cs
@@ -1,27 +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.Text;
- using System.Collections.Generic;
- using Tizen.NUI.BaseComponents;
-
///
/// A class encapsulating the transform map of the visual.
///
+ /// 3
public class VisualMap
{
private Vector2 _visualSize = null;
@@ -34,6 +37,11 @@ namespace Tizen.NUI
private PropertyMap _visualTransformMap = null;
private int? _depthIndex = null;
+
+ ///
+ /// outputVisualMap.
+ ///
+ /// 3
protected PropertyMap _outputVisualMap = null;
internal string Name
@@ -54,14 +62,18 @@ namespace Tizen.NUI
get;
}
+ ///
+ /// Constructor.
+ ///
+ /// 3
public VisualMap()
{
}
///
- /// Gets or sets the 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
@@ -83,9 +95,9 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the 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
@@ -107,8 +119,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the 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
@@ -127,8 +139,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the 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
@@ -147,9 +159,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -183,9 +195,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -224,9 +236,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -264,9 +276,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -300,9 +312,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -340,9 +352,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -380,8 +392,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -399,8 +411,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -418,8 +430,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -459,6 +471,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected virtual void ComposingPropertyMap()
{
_outputVisualMap = new PropertyMap();
@@ -490,11 +506,35 @@ 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;
///
@@ -515,7 +555,7 @@ namespace Tizen.NUI
}
///
- /// Enables or disables the premultiplied alpha.
+ /// Enables or disables the premultiplied alpha.
/// The premultiplied alpha is false by default unless this behavior is modified by the derived visual type.
///
/// 3
@@ -571,8 +611,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the image visual.
///
+ /// 3
public class ImageVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public ImageVisual() : base()
{
}
@@ -590,12 +635,14 @@ 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;
///
- /// Gets or sets the URL of the image.
+ /// Gets or sets the URL of the image.
/// Mandatory.
///
-
/// 3
public string URL
{
@@ -612,7 +659,7 @@ namespace Tizen.NUI
///
- /// Gets or sets the URL of the alpha mask.
+ /// Gets or sets the URL of the alpha mask.
/// Optional.
///
/// 3
@@ -630,9 +677,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -650,9 +697,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -670,9 +717,9 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -690,9 +737,9 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -710,9 +757,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -730,9 +777,9 @@ namespace Tizen.NUI
}
///
- /// Gets or sets whether to draw 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
@@ -750,11 +797,11 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -772,10 +819,10 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -793,10 +840,10 @@ namespace Tizen.NUI
}
///
- /// 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).
+ /// 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.
///
@@ -848,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)
@@ -871,6 +981,9 @@ 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)); }
}
}
}
@@ -878,8 +991,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the text visual.
///
+ /// 3
public class TextVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public TextVisual() : base()
{
}
@@ -895,7 +1013,7 @@ namespace Tizen.NUI
private bool? _enableMarkup = null;
///
- /// Gets or sets the text to display in the UTF-8 format.
+ /// Gets or sets the text to display in the UTF-8 format.
/// Mandatory.
///
/// 3
@@ -913,7 +1031,7 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the requested font family to use.
+ /// Gets or sets the requested font family to use.
/// Optional.
///
/// 3
@@ -931,7 +1049,7 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the requested font style to use.
+ /// Gets or sets the requested font style to use.
/// Optional.
///
/// 3
@@ -949,7 +1067,7 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the size of font in points.
+ /// Gets or sets the size of font in points.
/// Mandatory.
///
/// 3
@@ -967,8 +1085,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -986,8 +1104,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -1037,8 +1155,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -1088,7 +1206,7 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the color of the text.
+ /// Gets or sets the color of the text.
/// Optional.
///
/// 3
@@ -1106,7 +1224,7 @@ namespace Tizen.NUI
}
///
- /// Gets or sets whether the mark-up processing is enabled.
+ /// Gets or sets whether the mark-up processing is enabled.
/// Optional.
///
/// 3
@@ -1123,6 +1241,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
if (_text != null && _pointSize != null)
@@ -1149,8 +1271,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the border visual.
///
+ /// 3
public class BorderVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public BorderVisual() : base()
{
}
@@ -1160,7 +1287,7 @@ namespace Tizen.NUI
private bool? _antiAliasing = null;
///
- /// Gets or sets the color of the border.
+ /// Gets or sets the color of the border.
/// Mandatory.
///
/// 3
@@ -1178,7 +1305,7 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the width of the border (in pixels).
+ /// Gets or sets the width of the border (in pixels).
/// Mandatory.
///
/// 3
@@ -1196,8 +1323,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets whether the anti-aliasing of the border is required.
- /// If not supplied, the default is false.
+ /// Gets or sets whether the anti-aliasing of the border is required.
+ /// If not supplied, the default is false.
/// Optional.
///
/// 3
@@ -1214,6 +1341,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
if (_color != null && _size != null)
@@ -1234,8 +1365,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the color visual.
///
+ /// 3
public class ColorVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public ColorVisual() : base()
{
}
@@ -1243,7 +1379,7 @@ namespace Tizen.NUI
private Color _mixColorForColorVisual = null;
///
- /// Gets or sets the solid color required.
+ /// Gets or sets the solid color required.
/// Mandatory.
///
/// 3
@@ -1260,6 +1396,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
if (_mixColorForColorVisual != null)
@@ -1277,8 +1417,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the gradient visual.
///
+ /// 3
public class GradientVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public GradientVisual() : base()
{
}
@@ -1293,8 +1438,8 @@ namespace Tizen.NUI
private GradientVisualSpreadMethodType? _spreadMethod = null;
///
- /// Gets or sets 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
@@ -1311,8 +1456,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -1329,8 +1474,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -1347,8 +1492,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -1365,9 +1510,9 @@ namespace Tizen.NUI
}
///
- /// Gets or sets all the stop offsets.
- /// A PropertyArray of float.
- /// If not supplied, the 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
@@ -1385,9 +1530,9 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the color at the stop offsets.
- /// A PropertyArray of color.
- /// At least 2 values are 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
@@ -1405,8 +1550,8 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1424,8 +1569,8 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1442,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)
@@ -1467,8 +1616,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the mesh visual.
///
+ /// 3
public class MeshVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public MeshVisual() : base()
{
}
@@ -1482,7 +1636,7 @@ namespace Tizen.NUI
private Vector3 _lightPosition = null;
///
- /// Gets or sets the location of the ".obj" file.
+ /// Gets or sets the location of the ".obj" file.
/// Mandatory.
///
/// 3
@@ -1500,8 +1654,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -1519,8 +1673,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the 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
@@ -1537,9 +1691,9 @@ namespace Tizen.NUI
}
///
- /// 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).
+ /// 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
@@ -1557,8 +1711,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -1576,8 +1730,8 @@ namespace Tizen.NUI
}
///
- /// Gets or sets 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
@@ -1595,10 +1749,10 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the position, in the stage space, of the point light that applies lighting to the model.
+ /// 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.
+ /// 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
@@ -1615,6 +1769,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
if (_objectURL != null)
@@ -1638,8 +1796,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the primetive visual.
///
+ /// 3
public class PrimitiveVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public PrimitiveVisual() : base()
{
}
@@ -1658,8 +1821,8 @@ namespace Tizen.NUI
private Vector3 _lightPosition = null;
///
- /// Gets or sets 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
@@ -1677,9 +1840,9 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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.
///
/// 3
@@ -1697,10 +1860,10 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1718,10 +1881,10 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1739,10 +1902,10 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1760,11 +1923,11 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1782,13 +1945,13 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1806,11 +1969,11 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1828,13 +1991,13 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1852,12 +2015,12 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1875,11 +2038,11 @@ namespace Tizen.NUI
}
///
- /// 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.
+ /// 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
@@ -1897,11 +2060,11 @@ namespace Tizen.NUI
}
///
- /// Gets or sets the position, in the stage space, of the point light that applies lighting to the model.
+ /// 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.
+ /// 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
@@ -1918,6 +2081,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
_outputVisualMap = new PropertyMap(); ;
@@ -1943,8 +2110,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the n-patch image visual.
///
+ /// 3
public class NPatchVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public NPatchVisual() : base()
{
}
@@ -1954,7 +2126,7 @@ namespace Tizen.NUI
private Rectangle _border = null;
///
- /// Gets or sets the URL of the image.
+ /// Gets or sets the URL of the image.
/// Mandatory.
///
/// 3
@@ -1972,9 +2144,9 @@ namespace Tizen.NUI
}
///
- /// Gets or sets whether to draw 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
@@ -1992,8 +2164,8 @@ namespace Tizen.NUI
}
///
- /// The border of the image is 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
@@ -2010,6 +2182,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
if (_url != null)
@@ -2030,14 +2206,23 @@ namespace Tizen.NUI
///
/// 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
@@ -2051,6 +2236,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
if (_url != null)
@@ -2069,8 +2258,13 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the animated image (AGIF) visual.
///
+ /// 3
public class AnimatedImageVisual : VisualMap
{
+ ///
+ /// Constructor.
+ ///
+ /// 3
public AnimatedImageVisual() : base()
{
}
@@ -2083,7 +2277,7 @@ namespace Tizen.NUI
///
/// Gets and Sets the url in the AnimatedImageVisual.
///
- /// 4
+ /// 3
public string URL
{
get
@@ -2180,6 +2374,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
if (_urls != null)
@@ -2215,6 +2413,7 @@ namespace Tizen.NUI
///
/// A class encapsulating the property map of the transition data.
///
+ /// 3
public class VisualAnimator : VisualMap
{
///
@@ -2430,6 +2629,10 @@ namespace Tizen.NUI
}
}
+ ///
+ /// Compose the out visual map.
+ ///
+ /// 3
protected override void ComposingPropertyMap()
{
PropertyMap _animator = new PropertyMap();
@@ -2459,4 +2662,4 @@ namespace Tizen.NUI
-}
\ No newline at end of file
+}