From d61b6fbf4c9cae32469bbcf6d8db68691438039c Mon Sep 17 00:00:00 2001 From: Heeyong Song Date: Tue, 11 Apr 2017 17:45:41 +0900 Subject: [PATCH] Update comments Change-Id: If79a7a5a5a0dcaedcafc000648b1c6e3e109bda5 --- src/Tizen.NUI/src/public/Actor.cs | 254 +++++++++++++++------- src/Tizen.NUI/src/public/AlphaFunction.cs | 50 ++++- src/Tizen.NUI/src/public/Animation.cs | 65 +++--- src/Tizen.NUI/src/public/CameraActor.cs | 2 +- src/Tizen.NUI/src/public/CustomView.cs | 2 +- src/Tizen.NUI/src/public/CustomView/VisualView.cs | 28 ++- src/Tizen.NUI/src/public/View.cs | 2 +- 7 files changed, 276 insertions(+), 127 deletions(-) diff --git a/src/Tizen.NUI/src/public/Actor.cs b/src/Tizen.NUI/src/public/Actor.cs index c93e093..4633f98 100755 --- a/src/Tizen.NUI/src/public/Actor.cs +++ b/src/Tizen.NUI/src/public/Actor.cs @@ -86,7 +86,7 @@ namespace Tizen.NUI } /// - /// Retrieve the position of the Actor.
+ /// Retrieves the position of the Actor.
/// The coordinates are relative to the Actor's parent.
/// public Position CurrentPosition @@ -98,7 +98,7 @@ namespace Tizen.NUI } /// - /// Retrieve the size of the Actor.
+ /// Retrieves the size of the Actor.
/// The coordinates are relative to the Actor's parent.
/// public Size CurrentSize @@ -151,11 +151,12 @@ namespace Tizen.NUI } /// - /// Determines whether the anchor point should be used to determine the position of the actor.
- /// This is true by default.
- /// Note: If false, then the top-left of the actor is used for the position.
- /// Setting this to false will allow scaling or rotation around the anchor-point without affecting the actor's position.
+ /// Determines whether the anchor point should be used to determine the position of the actor. + /// This is true by default. /// + /// If false, then the top-left of the actor is used for the position. + /// Setting this to false will allow scaling or rotation around the anchor-point without affecting the actor's position. + /// protected bool PositionUsesAnchorPoint { get @@ -194,11 +195,13 @@ namespace Tizen.NUI } /// - /// Sets the sibling order of the actor so depth position can be defined within the same parent.
- /// Note The initial value is 0.
- /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the sibling order.
- /// The values set by this Property will likely change.
+ /// Sets the sibling order of the actor so depth position can be defined within the same parent. /// + /// + /// Note The initial value is 0. + /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the sibling order. + /// The values set by this Property will likely change. + /// public int SiblingOrder { get @@ -214,10 +217,10 @@ namespace Tizen.NUI } /// - /// Sets the size of an actor for Width and Height.
+ /// Sets the size of an actor for width and height.
/// Geometry can be scaled to fit within this area.
/// This does not interfere with the actors scale factor.
- /// The actors default depth is the minimum of Width & Height.
+ /// The actors default depth is the minimum of width & height.
/// public Size2D Size2D { @@ -253,31 +256,38 @@ namespace Tizen.NUI } /// - /// Sets the visibility flag of an actor as true to be shown.
- /// Note This is an asynchronous method; the value written may not match a value subsequently read with Visible.
- /// If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
- /// This is regardless of the individual visibility values of the children i.e.an actor will only be rendered if all of its parents have visibility set to true.
+ /// Shows the Actor. /// + /// + /// This is an asynchronous method. + /// public void Show() { SetVisible(true); } /// - /// Sets the visibility flag of an actor as false to be hidden. + /// Hides the Actor. /// + /// + /// This is an asynchronous method. + /// If an actor is hidden, then the actor and its children will not be rendered. + /// This is regardless of the individual visibility of the children i.e.an actor will only be rendered if all of its parents are shown. + /// public void Hide() { SetVisible(false); } /// - /// Raise actor above the next highest level of actor(s).
- /// Note Sibling order of actors within the parent will be updated automatically.
- /// Initially actors added to a parent will have the same sibling order and shown in relation to insertion order.
- /// Raising this actor above actors with the same sibling order as each other will raise this actor above them.
- /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
+ /// Raise actor above the next highest level of actor(s). /// + /// + /// Sibling order of actors within the parent will be updated automatically. + /// Initially actors added to a parent will have the same sibling order and shown in relation to insertion order. + /// Raising this actor above actors with the same sibling order as each other will raise this actor above them. + /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// public void Raise() { NDalicPINVOKE.Raise(swigCPtr); @@ -285,11 +295,13 @@ namespace Tizen.NUI } /// - /// Lower the actor to underneath the level below actor(s).
- /// Note Sibling order of actors within the parent will be updated automatically.
- /// Lowering this actor below actors with the same sibling order as each other will lower this actor above them.
- /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
+ /// Lower the actor to underneath the level below actor(s). /// + /// + /// Sibling order of actors within the parent will be updated automatically. + /// Lowering this actor below actors with the same sibling order as each other will lower this actor above them. + /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// public void Lower() { NDalicPINVOKE.Lower(swigCPtr); @@ -297,10 +309,12 @@ namespace Tizen.NUI } /// - /// Raise actor above all other actors.
- /// Note Sibling order of actors within the parent will be updated automatically.
- /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
+ /// Raise actor above all other actors. /// + /// + /// Sibling order of actors within the parent will be updated automatically. + /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// public void RaiseToTop() { NDalicPINVOKE.RaiseToTop(swigCPtr); @@ -308,10 +322,12 @@ namespace Tizen.NUI } /// - /// Lower actor to the bottom of all actors.
- /// Note Sibling order of actors within the parent will be updated automatically.
- /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
+ /// Lower actor to the bottom of all actors. /// + /// + /// Sibling order of actors within the parent will be updated automatically. + /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// public void LowerToBottom() { NDalicPINVOKE.LowerToBottom(swigCPtr); @@ -319,12 +335,13 @@ namespace Tizen.NUI } /// - /// Raise the actor to above the target actor.
- /// Note Sibling order of actors within the parent will be updated automatically.
- /// Actors on the level above the target actor will still be shown above this actor.
- /// Raising this actor above actors with the same sibling order as each other will raise this actor above them.
- /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
+ /// Raise the actor to above the target actor. /// + /// Sibling order of actors within the parent will be updated automatically. + /// Actors on the level above the target actor will still be shown above this actor. + /// Raising this actor above actors with the same sibling order as each other will raise this actor above them. + /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// /// Will be raised above this actor public void RaiseAbove(Actor target) { @@ -333,11 +350,12 @@ namespace Tizen.NUI } /// - /// Lower the actor to below the target actor.
- /// Note Sibling order of actors within the parent will be updated automatically.
- /// Lowering this actor below actors with the same sibling order as each other will lower this actor above them.
- /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion.
+ /// Lower the actor to below the target actor. /// + /// Sibling order of actors within the parent will be updated automatically. + /// Lowering this actor below actors with the same sibling order as each other will lower this actor above them. + /// Once a raise or lower API is used that actor will then have an exclusive sibling order independent of insertion. + /// /// Will be lowered below this actor public void LowerBelow(Actor target) { @@ -466,7 +484,7 @@ namespace Tizen.NUI /// If not, the returned handle is left uninitialized.
/// /// handle to An object - /// handle to a Actor object or an uninitialized handle + /// handle to an Actor object or an uninitialized handle public new static Actor DownCast(BaseHandle handle) { Actor ret = new Actor(NDalicPINVOKE.Actor_DownCast(BaseHandle.getCPtr(handle)), true); @@ -535,11 +553,11 @@ namespace Tizen.NUI } /// - /// Adds a child Actor to this Actor.
- /// Precondition : This Actor(the parent) has been initialized. The child actor has been initialized. The child actor is not the same as the parent actor.
- /// PostCondition : The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed.
- /// Note : If the child already has a parent, it will be removed from old parent and reparented to this actor. This may change child's position, color, scale etc as it now inherits them from this actor.
+ /// Adds a child Actor to this Actor. /// + /// 
This Actor(the parent) has been initialized. The child actor has been initialized. The child actor is not the same as the parent actor.
+ /// The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed. + /// If the child already has a parent, it will be removed from old parent and reparented to this actor. This may change child's position, color, scale etc as it now inherits them from this actor. /// The child public void Add(Actor child) { @@ -548,9 +566,9 @@ namespace Tizen.NUI } /// - /// Removes a child Actor from this Actor. If the actor was not a child of this actor, this is a no-op.
- /// Precondition : This Actor(the parent) has been initialized. The child actor is not the same as the parent actor.
+ /// Removes a child Actor from this Actor. If the actor was not a child of this actor, this is a no-op. /// + /// 
This Actor(the parent) has been initialized. The child actor is not the same as the parent actor.
/// The child public void Remove(Actor child) { @@ -565,9 +583,9 @@ namespace Tizen.NUI } /// - /// Retrieves the number of children held by the actor.
- /// Precondition : The Actor has been initialized.
+ /// Retrieves the number of children held by the actor. /// + /// 
The Actor has been initialized.
/// The number of children public uint GetChildCount() { @@ -577,9 +595,9 @@ namespace Tizen.NUI } /// - /// Retrieve and child actor by index.
- /// Precondition : The Actor has been initialized.
+ /// Retrieves child actor by index. /// + /// 
The Actor has been initialized.
/// The index of the child to retrieve /// The actor for the given index or empty handle if children not initialized public Actor GetChildAt(uint index) @@ -590,10 +608,10 @@ namespace Tizen.NUI } /// - /// Search through this actor's hierarchy for an actor with the given name.
- /// The actor itself is also considered in the search.
- ///Precondition : The Actor has been initialized.
+ /// Search through this actor's hierarchy for an actor with the given name. + /// The actor itself is also considered in the search. /// + /// 
The Actor has been initialized.
/// The name of the actor to find /// A handle to the actor if found, or an empty handle if not public Actor FindChildByName(string actorName) @@ -976,10 +994,10 @@ namespace Tizen.NUI } /// - /// Converts screen coordinates into the actor's coordinate system using the default camera.
- /// Precondition : The Actor has been initialized.
- /// Note : The actor coordinates are relative to the top-left(0.0, 0.0, 0.5).
+ /// Converts screen coordinates into the actor's coordinate system using the default camera. /// + /// 
The Actor has been initialized.
+ /// The actor coordinates are relative to the top-left(0.0, 0.0, 0.5) /// On return, the X-coordinate relative to the actor /// On return, the Y-coordinate relative to the actor /// The screen X-coordinate @@ -1046,10 +1064,11 @@ namespace Tizen.NUI /// /// Sets the relative to parent size factor of the actor.
- /// This factor is only used when ResizePolicy is set to either.
+ /// This factor is only used when ResizePolicy is set to either: + /// ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
/// This actor's size is set to the actor's size multiplied by or added to this factor, depending on ResizePolicy.
- /// Precondition : The Actor has been initialized.
/// + /// 
The Actor has been initialized.
/// A Vector3 representing the relative factor to be applied to each axis public void SetSizeModeFactor(Vector3 factor) { @@ -1070,7 +1089,7 @@ namespace Tizen.NUI /// size 0 is treated as aspect ratio 1:1.
/// /// Width to use - /// the height based on the width + /// The height based on the width public float GetHeightForWidth(float width) { float ret = NDalicPINVOKE.Actor_GetHeightForWidth(swigCPtr, width); @@ -1084,7 +1103,7 @@ namespace Tizen.NUI /// size 0 is treated as aspect ratio 1:1.
/// /// Height to use - /// the width based on the height + /// The width based on the height public float GetWidthForHeight(float height) { float ret = NDalicPINVOKE.Actor_GetWidthForHeight(swigCPtr, height); @@ -1102,7 +1121,7 @@ namespace Tizen.NUI /// /// Sets the padding for use in layout.
/// - /// padding Padding for the actor + /// Padding for the actor public void SetPadding(PaddingType padding) { NDalicPINVOKE.Actor_SetPadding(swigCPtr, PaddingType.getCPtr(padding)); @@ -1236,11 +1255,11 @@ namespace Tizen.NUI /// /// Gets/Sets the origin of an actor, within its parent's area.
- /// This is expressed in unit coordinates, such that(0.0, 0.0, 0.5) is the top-left corner of the parent, and(1.0, 1.0, 0.5) is the bottom-right corner.
+ /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent, and(1.0, 1.0, 0.5) is the bottom-right corner.
/// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).
/// An actor's position is the distance between this origin, and the actor's anchor-point.
- /// Precondition : The Actor has been initialized.
/// + /// 
The Actor has been initialized.
public Position ParentOrigin { get @@ -1257,11 +1276,11 @@ namespace Tizen.NUI /// /// Gets/Sets the anchor-point of an actor.
- /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the actor, and(1.0, 1.0, 0.5) is the bottom-right corner.
+ /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the bottom-right corner.
/// The default anchor point is AnchorPoint.Center (0.5, 0.5, 0.5).
/// An actor position is the distance between its parent-origin and this anchor-point.
/// An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
- /// Precondition : The Actor has been initialized. + /// 
The Actor has been initialized.
/// public Position AnchorPoint { @@ -1435,8 +1454,8 @@ namespace Tizen.NUI /// /// Gets/Sets the orientation of the Actor.
/// An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
- /// Note: This is an asynchronous method.
/// + /// This is an asynchronous method. public Rotation Orientation { get @@ -1466,7 +1485,6 @@ namespace Tizen.NUI /// /// Gets/Sets the scale factor applied to an actor.
- /// Note : This is an asynchronous method.
/// public Vector3 Scale { @@ -1547,10 +1565,12 @@ namespace Tizen.NUI } /// - /// Retrieves the visibility flag of an actor.
- /// Note : If an actor is not visible, then the actor and its children will not be rendered.
- /// This is regardless of the individual visibility values of the children i.e.an actor will only be rendered if all of its parents have visibility set to true.
+ /// Retrieves the visibility flag of an actor. /// + /// + /// If an actor is not visible, then the actor and its children will not be rendered. + /// This is regardless of the individual visibility values of the children i.e.an actor will only be rendered if all of its parents have visibility set to true. + /// public bool Visible { get @@ -1839,7 +1859,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets the width resize policy to be used for the given dimension(s). + /// Gets/Sets the width resize policy to be used. /// public ResizePolicyType WidthResizePolicy { @@ -1879,7 +1899,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets the height resize policy to be used for the given dimension(s). + /// Gets/Sets the height resize policy to be used. /// public ResizePolicyType HeightResizePolicy { @@ -2110,17 +2130,25 @@ namespace Tizen.NUI } /// - /// This specifies whether the Actor uses its own color, or inherits.
- /// ColorMode.UseOwnColor : Actor will use its own color.
- /// ColorMode.UseParentColor : Actor will use its parent color.
- /// ColorMode.UseOwnMultiplyParentColor : Actor will blend its color with its parents color.
- /// ColorMode.UseOwnMultiplyParentAlpha : Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default.
+ /// This specifies whether the Actor uses its own color, or inherits. /// public enum ColorMode { + /// + /// Actor will use its own color. + /// UseOwnColor, + /// + /// Actor will use its parent color. + /// UseParentColor, + /// + /// Actor will blend its color with its parents color. + /// UseOwnMultiplyParentColor, + /// + /// Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default. + /// UseOwnMultiplyParentAlpha } @@ -2129,52 +2157,110 @@ namespace Tizen.NUI /// public enum DimensionType { + /// + /// Width dimension + /// Width = 0x1, + /// + /// Height dimension + /// Height = 0x2, + /// + /// Mask to cover all flags + /// AllDimensions = 0x3 } /// - /// This specifies draw mode types + /// Enumeration for the instance of how the actor and it's children will be drawn. /// public enum DrawModeType { + /// + /// The default draw-mode + /// Normal = 0, + /// + /// Draw the actor and its children as an overlay + /// Overlay2D = 1, + /// + /// Will be replaced by separate ClippingMode enum. Draw the actor and its children into the stencil buffer + /// Stencil = 3 } /// - /// This specifies resize policy types + /// Enumeration for size negotiation resize policies. /// public enum ResizePolicyType { + /// + /// Size is fixed as set by SetSize + /// Fixed, + /// + /// Size is to use the actor's natural size + /// + /// UseNaturalSize, + /// + /// Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. + /// FillToParent, + /// + /// The actors size will be ( ParentSize * SizeRelativeToParentFactor ). + /// SizeRelativeToParent, + /// + /// The actors size will be ( ParentSize + SizeRelativeToParentFactor ). + /// SizeFixedOffsetFromParent, + /// + /// Size will adjust to wrap around all children + /// FitToChildren, + /// + /// One dimension is dependent on the other + /// DimensionDependency, + /// + /// The size will be assigned to the actor + /// UseAssignedSize } /// - /// This specifies size scale policy types + /// Enumeration for policies to determine how an actor should resize itself when having its size set in size negotiation. /// public enum SizeScalePolicyType { + /// + /// Use the size that was set + /// UseSizeSet, + /// + /// Fit within the size set maintaining natural size aspect ratio + /// FitWithAspectRatio, - FillWithAspectRatio + /// + /// Fit within the size set maintaining natural size aspect ratio + /// + FillWithAspectRatiox } /// - /// This specifies clipping mode types + /// Enumeration for ClippingMode describing how this Actor's children will be clipped against it. /// public enum ClippingModeType { + /// + /// This Actor will not clip its children. + /// Disabled, + /// + /// This Actor will clip all children to within its boundaries (the actor will also be visible itself). + /// ClipChildren } diff --git a/src/Tizen.NUI/src/public/AlphaFunction.cs b/src/Tizen.NUI/src/public/AlphaFunction.cs index 342a3ad..6289aa7 100755 --- a/src/Tizen.NUI/src/public/AlphaFunction.cs +++ b/src/Tizen.NUI/src/public/AlphaFunction.cs @@ -108,8 +108,8 @@ namespace Tizen.NUI /// /// Constructor.
/// Creates a bezier alpha function.The bezier will have the first point at(0,0) and the end point at(1,1).
- /// Note : The x components of the control points will be clamped to the range[0, 1] to prevent non monotonic curves.
/// + /// The x components of the control points will be clamped to the range[0, 1] to prevent non monotonic curves. /// A Vector2 which will be used as the first control point of the curve /// A Vector2 which will be used as the second control point of the curve public AlphaFunction(Vector2 controlPoint0, Vector2 controlPoint1) : this(NDalicPINVOKE.new_AlphaFunction__SWIG_3(Vector2.getCPtr(controlPoint0), Vector2.getCPtr(controlPoint1)), true) @@ -167,19 +167,61 @@ namespace Tizen.NUI /// public enum BuiltinFunctions { + /// + /// Linear + /// Default, + /// + /// No transformation + /// Linear, + /// + /// Reverse linear + /// Reverse, + /// + /// Speeds up and comes to a sudden stop (Square) + /// EaseInSquare, + /// + /// Sudden start and slows to a gradual stop (Square) + /// EaseOutSquare, + /// + /// Speeds up and comes to a sudden stop (Cubic) + /// EaseIn, + /// + /// Sudden start and slows to a gradual stop (Cubic) + /// EaseOut, + /// + /// Speeds up and slows to a gradual stop (Cubic) + /// EaseInOut, + /// + /// Speeds up and comes to a sudden stop (sinusoidal) + /// EaseInSine, + /// + /// Sudden start and slows to a gradual stop (sinusoidal) + /// EaseOutSine, + /// + /// Speeds up and slows to a gradual stop (sinusoidal) + /// EaseInOutSine, + /// + /// Sudden start, loses momentum and returns to start position + /// Bounce, + /// + /// Single revolution + /// Sin, + /// + /// Sudden start, exceed end position and return to a gradual stop + /// EaseOutBack, Count } @@ -189,7 +231,13 @@ namespace Tizen.NUI /// public enum Modes { + /// + /// The user has provided a custom function + /// CustomFunction = 1, + /// + /// The user has provided the control points of a bezier curve + /// Bezier } diff --git a/src/Tizen.NUI/src/public/Animation.cs b/src/Tizen.NUI/src/public/Animation.cs index cf631a1..9405668 100755 --- a/src/Tizen.NUI/src/public/Animation.cs +++ b/src/Tizen.NUI/src/public/Animation.cs @@ -26,7 +26,7 @@ namespace Tizen.NUI /// Animation can be used to animate the properties of any number of objects, typically Actors.
/// If the "Finished" event is connected to a member function of an object, it must be disconnected before the object is destroyed.
/// This is typically done in the object destructor, and requires either the Animation handle to be stored.
- /// The overall animation time is superseded by the values given in the Duration property used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods.
+ /// The overall animation time is superseded by the values given in the animation time used when calling the AnimateTo(), AnimateBy(), AnimateBetween() and AnimatePath() methods.
/// If any of the individual calls to those functions exceeds the overall animation time(Duration), then the overall animation time is automatically extended.
/// public class Animation : BaseHandle @@ -80,9 +80,9 @@ namespace Tizen.NUI /// The animation will not loop.
/// The default end action is "Cancel".
/// The default Alpha function is linear.
- /// Precodition : DurationmSeconds must be greater than zero.
/// - /// The duration in milli seconds (int). + /// DurationmSeconds must be greater than zero. + /// The duration in milli seconds. public Animation(int durationMilliSeconds) : this(NDalicPINVOKE.Animation_New((float)durationMilliSeconds / 1000.0f), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -163,7 +163,7 @@ namespace Tizen.NUI /// - /// Gets/Sets the duration of animation. + /// Gets/Sets the duration in milli seconds of the animation. /// public int Duration { @@ -178,7 +178,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets the default alpha function for an animation. + /// Gets/Sets the default alpha function for the animation. /// public AlphaFunction DefaultAlphaFunction { @@ -274,7 +274,7 @@ namespace Tizen.NUI /// /// Gets the current loop count.
- /// A value 0 to CurrentLoop indicating the current loop count when looping.
+ /// A value 0 indicating the current loop count when looping.
/// public int CurrentLoop { @@ -369,8 +369,6 @@ namespace Tizen.NUI /// /// Animates a property value by a relative amount.
- /// The default alpha function will be used.
- /// The effect will start & end when the animation begins & ends.
/// /// The target object to animate /// The target property to animate @@ -403,8 +401,6 @@ namespace Tizen.NUI /// /// Animates a property value by a relative amount.
- /// The default alpha function will be used.
- /// The effect will start & end when the animation begins & ends.
/// /// The target object to animate /// The target property to animate @@ -441,8 +437,6 @@ namespace Tizen.NUI /// /// Animates a property to a destination value.
- /// The default alpha function will be used.
- /// The effect will start & end when the animation begins & ends.
/// /// The target object to animate /// The target property to animate @@ -475,8 +469,6 @@ namespace Tizen.NUI /// /// Animates a property to a destination value.
- /// The default alpha function will be used.
- /// The effect will start & end when the animation begins & ends.
/// /// The target object to animate /// The target property to animate @@ -484,7 +476,7 @@ namespace Tizen.NUI /// The alpha function to apply /// Start time of animation /// End time of animation - /// + /// The alpha function to apply public void AnimateTo(Actor target, string property, object destinationValue, int startTime, int endTime, AlphaFunction alphaFunction = null) { string _str1 = property.Substring(0, 1); @@ -549,8 +541,8 @@ namespace Tizen.NUI /// The target object to animate /// The target property to animate /// The set of time/value pairs between which to animate - /// Start time of animation - /// End time of animation + /// Start time of animation in milli seconds + /// End time of animation in milli seconds /// The method used to interpolate between values /// The alpha function to apply public void AnimateBetween(Actor target, string property, KeyFrames keyFrames, int startTime, int endTime, Interpolation interpolation = Interpolation.Linear, AlphaFunction alphaFunction = null) @@ -789,7 +781,7 @@ namespace Tizen.NUI } /// - /// Play the animation. + /// Plays the animation. /// public void Play() { @@ -984,37 +976,56 @@ namespace Tizen.NUI } /// - /// Enumeration for what to do when the animation ends, is stopped, or is destroyed.
- /// Cancel : When the animation ends, the animated property values are saved.
- /// Discard : When the animation ends, the animated property values are forgotten.
- /// StopFinal : If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like Cancel.
+ /// Enumeration for what to do when the animation ends, is stopped, or is destroyed. /// public enum EndActions { + /// + /// When the animation ends, the animated property values are saved. + /// Cancel, + /// + /// When the animation ends, the animated property values are forgotten. + /// Discard, + /// + /// If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like Cancel. + /// StopFinal } /// - /// Enumeration for what interpolation method to use on key-frame animations.
- /// Linear : Values in between key frames are interpolated using a linear polynomial. (Default).
- /// Cubic : Values in between key frames are interpolated using a cubic polynomial.
+ /// Enumeration for what interpolation method to use on key-frame animations. /// public enum Interpolation { + /// + /// Values in between key frames are interpolated using a linear polynomial. (Default) + /// Linear, + /// + /// Values in between key frames are interpolated using a cubic polynomial. + /// Cubic } /// - /// Enumeration for what state the animation is in.
- /// Note: Calling Reset() on this class will NOT reset the animation. It will call BaseHandle.Reset() which drops the object handle.
+ /// Enumeration for what state the animation is in. /// + /// Calling Reset() on this class will NOT reset the animation. It will call BaseHandle.Reset() which drops the object handle. public enum States { + /// + /// Animation has stopped + /// Stopped, + /// + /// The animation is playing + /// Playing, + /// + /// The animation is paused + /// Paused } diff --git a/src/Tizen.NUI/src/public/CameraActor.cs b/src/Tizen.NUI/src/public/CameraActor.cs index 57f1af9..1ee4661 100755 --- a/src/Tizen.NUI/src/public/CameraActor.cs +++ b/src/Tizen.NUI/src/public/CameraActor.cs @@ -29,7 +29,7 @@ namespace Tizen.NUI /// (configured to have the origin of the coordinate system at the top-left corner of the screen, and unit 1 as 1 pixel of the screen). This is a typical way.
/// - For 3D applications, you can change the view by manipulating the camera.You can translate or rotate the camera in this case.
/// Note that the top-left corner of the screen and unit 1 no longer are (0,0,0) and 1 pixel after manipulating the camera.
- /// There are two types of camera actor, FreeLook and LookAtTarget By default, the camera actor will be FreeLook.
+ /// There are two types of camera actor, FreeLook and LookAtTarget. By default, the camera actor will be FreeLook.
/// - A FreeLook camera uses actor's orientation to control where the camera is looking.
/// If no additional rotations are specified, the camera looks in the negative Z direction.
/// - For LookAtTarget, the actor's orientation is ignored, instead the camera looks at TargetPosition in world coordinates.
diff --git a/src/Tizen.NUI/src/public/CustomView.cs b/src/Tizen.NUI/src/public/CustomView.cs index f5b11f6..33f503f 100755 --- a/src/Tizen.NUI/src/public/CustomView.cs +++ b/src/Tizen.NUI/src/public/CustomView.cs @@ -494,7 +494,7 @@ namespace Tizen.NUI /// /// The child actor to calculate the size for /// The dimension to calculate the size for. E.g. width or height - /// Return the calculated size for the given dimension + /// Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found. public virtual float CalculateChildSize(Actor child, DimensionType dimension) { return viewWrapperImpl.CalculateChildSizeBase(child, dimension); diff --git a/src/Tizen.NUI/src/public/CustomView/VisualView.cs b/src/Tizen.NUI/src/public/CustomView/VisualView.cs index 82684a7..4037b00 100755 --- a/src/Tizen.NUI/src/public/CustomView/VisualView.cs +++ b/src/Tizen.NUI/src/public/CustomView/VisualView.cs @@ -21,18 +21,22 @@ namespace Tizen.NUI using System.Linq; /// - /// A visual view control for user add any visual to it.
- /// Example:
- /// VisualView _visualView = new VisualView();
- /// ImageVisualMap imageVisualMap1 = new ImageVisualMap();
- /// imageVisualMap1.URL = "./NUISample/res/images/image-1.jpg";
- /// imageVisualMap1.VisualSize = new Vector2( 300.0f, 300.0f );
- /// imageVisualMap1.Offset = new Vector2( 50.0f, 50.0f );
- /// imageVisualMap1.OffsetSizeMode = new Vector4( 1.0f, 1.0f, 1.0f, 1.0f );
- /// imageVisualMap1.Origin = AlignType.TOP_BEGIN;
- /// imageVisualMap1.AnchorPoint = AlignType.TOP_BEGIN;
- /// _visualView.AddVisual("imageVisual1", imageVisualMap1);
+ /// A visual view control for user add any visual to it. /// + /// + /// Example: + /// + /// VisualView _visualView = new VisualView(); + /// ImageVisualMap imageVisualMap1 = new ImageVisualMap(); + /// imageVisualMap1.URL = "./NUISample/res/images/image-1.jpg"; + /// imageVisualMap1.VisualSize = new Vector2( 300.0f, 300.0f ); + /// imageVisualMap1.Offset = new Vector2( 50.0f, 50.0f ); + /// imageVisualMap1.OffsetSizeMode = new Vector4( 1.0f, 1.0f, 1.0f, 1.0f ); + /// imageVisualMap1.Origin = AlignType.TOP_BEGIN; + /// imageVisualMap1.AnchorPoint = AlignType.TOP_BEGIN; + /// _visualView.AddVisual("imageVisual1", imageVisualMap1); + /// + /// public class VisualView : CustomView { //private LinkedList _visualList = null; @@ -157,8 +161,8 @@ namespace Tizen.NUI /// Called after the size negotiation has been finished for this control.
/// The control is expected to assign this given size to itself/its children.
/// Should be overridden by derived classes if they need to layout actors differently after certain operations like add or remove actors, resize or after changing specific properties.
- /// Note! As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).
/// + /// As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored) /// The allocated size /// The control should add actors to this container that it is not able to allocate a size for. public override void OnRelayout(Vector2 size, RelayoutContainer container) diff --git a/src/Tizen.NUI/src/public/View.cs b/src/Tizen.NUI/src/public/View.cs index 42bd8da..2b64c8f 100755 --- a/src/Tizen.NUI/src/public/View.cs +++ b/src/Tizen.NUI/src/public/View.cs @@ -648,7 +648,7 @@ namespace Tizen.NUI /// - /// Describes the direction to move the keyboard focus towards. + /// Describes the direction to move the focus towards. /// public enum FocusDirection { -- 2.7.4