This is an automated email from the ASF dual-hosted git repository. harbs pushed a commit to branch develop in repository https://gitbox.apache.org/repos/asf/royale-asjs.git
commit c14f6a8f3d8c696469a00ed51099707d75f21617 Author: DESKTOP-RH4S838\Yishay <[email protected]> AuthorDate: Tue Jul 3 09:13:37 2018 +0300 Add some documentation to filter elements --- .../org/apache/royale/svg/BlendFilterElement.as | 8 +++ .../org/apache/royale/svg/BlurFilterElement.as | 17 +++++++ .../org/apache/royale/svg/DropShadowFilter.as | 57 +++++++++++++++------- .../main/royale/org/apache/royale/svg/Filter.as | 17 ++++--- .../org/apache/royale/svg/OffsetFilterElement.as | 25 ++++++++++ 5 files changed, 98 insertions(+), 26 deletions(-) diff --git a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/BlendFilterElement.as b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/BlendFilterElement.as index ab6a41b..5d44242 100644 --- a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/BlendFilterElement.as +++ b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/BlendFilterElement.as @@ -74,6 +74,14 @@ package org.apache.royale.svg } } + /** + * The filter element result which is blended with the source graphic. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get in2():String { return _in2; diff --git a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/BlurFilterElement.as b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/BlurFilterElement.as index 8269828..836e6c3 100644 --- a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/BlurFilterElement.as +++ b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/BlurFilterElement.as @@ -75,6 +75,14 @@ package org.apache.royale.svg } } + /** + * The Gaussian blur standard deviation + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get stdDeviation():Number { return _stdDeviation; @@ -85,6 +93,15 @@ package org.apache.royale.svg _stdDeviation = value; } + /** + * Where to write the result of this filter. + * This is useful for using the result as a source for another filter element. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get blurResult():String { return _blurResult; diff --git a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/DropShadowFilter.as b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/DropShadowFilter.as index f3a0b32..449c2eb 100644 --- a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/DropShadowFilter.as +++ b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/DropShadowFilter.as @@ -68,30 +68,35 @@ package org.apache.royale.svg value.removeBead(this); } - public function loadBeadFromValuesManager(classOrInterface:Class, classOrInterfaceName:String, strand:IStrand):IBead + private function loadBeadFromValuesManager(classOrInterface:Class, classOrInterfaceName:String, strand:IStrand):IBead { - var result:IBead = strand.getBeadByType(classOrInterface); - if (!result) + var result:IBead; + var c:Class = ValuesManager.valuesImpl.getValue(this, classOrInterfaceName) as Class; + if (c) { - var c:Class = ValuesManager.valuesImpl.getValue(this, classOrInterfaceName) as Class; - if (c) - { - COMPILE::JS - { - var f:Function = c as Function; - result = new f() as IBead; - } - COMPILE::SWF - { - result = new c() as IBead; - } - if (result) - strand.addBead(result); - } + COMPILE::JS + { + var f:Function = c as Function; + result = new f() as IBead; + } + COMPILE::SWF + { + result = new c() as IBead; + } + if (result) + strand.addBead(result); } return result; } + /** + * The drop shadow x offset + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get dx():Number { return _dx; @@ -102,6 +107,14 @@ package org.apache.royale.svg _dx = value; } + /** + * The drop shadow y offset + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get dy():Number { return _dy; @@ -112,6 +125,14 @@ package org.apache.royale.svg _dy = value; } + /** + * The Gaussian blur standard deviation for the drop shadow + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get stdDeviation():Number { return _stdDeviation; diff --git a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/Filter.as b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/Filter.as index bd5caf5..4e303e9 100644 --- a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/Filter.as +++ b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/Filter.as @@ -103,7 +103,7 @@ package org.apache.royale.svg { var svgElement:Node = host.element as Element; var defs:Element = getChildNode(svgElement, "defs") as Element; - filterElement = getChildNode(defs, "filter") as Element; + _filterElement = getChildNode(defs, "filter") as Element; filterElement.id = "myDropShadow" + UIDUtil.createUID(); filterElement.setAttribute("width", _width); filterElement.setAttribute("height", _height); @@ -150,17 +150,18 @@ package org.apache.royale.svg } COMPILE::JS + /** + * This is the DOM element where filter elements get added + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get filterElement():Element { return _filterElement; } - - COMPILE::JS - public function set filterElement(value:Element):void - { - _filterElement = value; - } - } } diff --git a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/OffsetFilterElement.as b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/OffsetFilterElement.as index d45dcf8..35e1fcf 100644 --- a/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/OffsetFilterElement.as +++ b/frameworks/projects/Graphics/src/main/royale/org/apache/royale/svg/OffsetFilterElement.as @@ -78,6 +78,14 @@ package org.apache.royale.svg } } + /** + * The x offset + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get dx():Number { return _dx; @@ -88,6 +96,14 @@ package org.apache.royale.svg _dx = value; } + /** + * The y offset + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get dy():Number { return _dy; @@ -98,6 +114,15 @@ package org.apache.royale.svg _dy = value; } + /** + * Where to write the result of this filter. + * This is useful for using the result as a source for another filter element. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion Royale 0.9.3 + */ public function get offsetResult():String { return _offsetResult;
