DropShadowFilter

パッケージ	spark.filters
クラス	public class DropShadowFilter
継承	DropShadowFilter BaseDimensionFilter BaseFilter EventDispatcher Object
実装	IBitmapFilter

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

DropShadowFilter クラスは、ドロップシャドウを表示オブジェクトに追加します。シャドウアルゴリズムは、ぼかしフィルターで使用するのと同じボックスフィルターに基づいています。ドロップシャドウのスタイルには複数のオプションがあり、内側シャドウ、外側シャドウ、ノックアウトモードなどがあります。このフィルターは、MovieClip、SimpleButton、TextField、Video オブジェクトなどの DisplayObject クラスから継承した表示オブジェクト、および BitmapData オブジェクトに適用できます。

フィルターの使用方法は、フィルターの適用先オブジェクトによって異なります。

表示オブジェクトにフィルターを適用する場合は、DisplayObject から継承した filters プロパティを使用します。オブジェクトの filters プロパティを設定しても、オブジェクトは変更されません。filters プロパティをクリアすることにより、フィルターを取り消すことができます。
BitmapData オブジェクトにフィルターを適用するには、BitmapData.applyFilter() メソッドを使用します。BitmapData オブジェクトで applyFilter() を呼び出すことによって、ソース BitmapData オブジェクトとフィルターオブジェクトが取得され、フィルターを適用したイメージが生成されます。

表示オブジェクトにフィルターを適用すると、表示オブジェクトの cacheAsBitmap プロパティの値が true に設定されます。すべてのフィルターをクリアすると、cacheAsBitmap の元の値が復元されます。

このフィルターはステージの拡大 / 縮小に対応していますが、通常の拡大 / 縮小、回転、傾斜には対応していません。オブジェクト自体が拡大 / 縮小される場合（scaleX と scaleY プロパティの値が 1.0 以外に設定されている場合）、フィルターは拡大 / 縮小されません。フィルターが拡大 / 縮小されるのは、ユーザーがステージをズームインする場合のみです。

結果として得られるイメージが最大サイズを超えると、フィルターは適用されません。AIR 1.5 および Flash Player 10 における最大サイズは、幅または高さが 8,191 ピクセルで、合計のピクセル数は 16,777,215 ピクセルを超えないようにしてください（つまり、幅が 8,191 ピクセルのイメージでは、高さが 2,048 ピクセルになります）。例えば、フィルターが適用されたサイズの大きいムービークリップをズームインするとき、結果として得られるイメージが最大サイズを超える場合は、フィルターがオフになります。

MXML シンタックス expanded

MXML シンタックスを隠す

The <s:DropShadowFilter> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:DropShadowFilter 
    Properties
    alpha="1"
    angle="45"
    color="0xFF0000"
    distance="4"
    hideObject="false"
    inner="false"
  />

例を表示

さらに例を参照

Filters

関連する API エレメント

flash.filters.DropShadowFilter

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		alpha : Number カラーのアルファ透明度の値です。	DropShadowFilter
		angle : Number ベベルの角度です。	DropShadowFilter
		blurX : Number 水平方向のぼかし量。	BaseDimensionFilter
		blurY : Number 垂直方向のぼかし量。	BaseDimensionFilter
		color : uint グローのカラーを表します。	DropShadowFilter
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		distance : Number ベベルのオフセット距離です。	DropShadowFilter
		hideObject : Boolean オブジェクトが非表示であるかどうかを示します。	DropShadowFilter
		inner : Boolean グローが内側グローであるかどうかを示します。	DropShadowFilter
		knockout : Boolean オブジェクトにノックアウト効果を適用するかどうかを指定します。	BaseDimensionFilter
		quality : int フィルターを適用する回数。	BaseDimensionFilter
		strength : Number インプリントの強さまたは広がりです。	BaseDimensionFilter

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		DropShadowFilter(distance:Number = 4.0, angle:Number = 45, color:uint = 0, alpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1.0, quality:int = 1, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false) コンストラクターです。	DropShadowFilter
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		clone():BitmapFilter このフィルターオブジェクトのコピーを返します。	DropShadowFilter
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		notifyFilterChanged():void フィルターの変更時に変更イベントを伝播します。	BaseFilter
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	イベント		概要	定義元
		activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
		deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher

パブリック定数

継承されるパブリック定数を隠す

継承されるパブリック定数を表示

	定数		定義元

プロパティの詳細

alpha

プロパティ

alpha:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

カラーのアルファ透明度の値です。指定できる値は 0 ～ 1 です。例えば、.25 を指定すると、透明度の値として 25% が設定されます。

デフォルト値： 1。

実装
public function get alpha():Number
public function set alpha(value:Number):void

angle

プロパティ

angle:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

ベベルの角度です。有効な値の範囲は 0 ～ 360°です。角度の値は、オブジェクトに対する架空の光源の角度を表し、オブジェクトに対する効果の相対位置を決定します。distance プロパティが 0 に設定された場合、効果がオブジェクトからオフセットされないため、angle プロパティは適用されません。

デフォルト値： 45。

実装
public function get angle():Number
public function set angle(value:Number):void

color

プロパティ

color:uint

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

グローのカラーを表します。有効な値は、16 進数形式（0xRRGGBB）です。

デフォルト値： 0xFF0000。

実装
public function get color():uint
public function set color(value:uint):void

distance

プロパティ

distance:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

ベベルのオフセット距離です。この値はピクセル単位で指定します（浮動小数値）。

デフォルト値： 4。

実装
public function get distance():Number
public function set distance(value:Number):void

hideObject

プロパティ

hideObject:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

オブジェクトが非表示であるかどうかを示します。true を指定すると、オブジェクト自体は描画されず、シャドウだけが表示されます。デフォルトは false で、オブジェクトが表示されます。

デフォルト値： false。

実装
public function get hideObject():Boolean
public function set hideObject(value:Boolean):void

inner

プロパティ

inner:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

グローが内側グローであるかどうかを示します。true の場合は、内側グローであることを示します。デフォルトは false (外側グロー) で、オブジェクトの外側のエッジにあるグローが作成されます。

デフォルト値： false。

実装
public function get inner():Boolean
public function set inner(value:Boolean):void

コンストラクターの詳細

()

コンストラクター

public function DropShadowFilter(distance:Number = 4.0, angle:Number = 45, color:uint = 0, alpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1.0, quality:int = 1, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

コンストラクターです。

パラメーター

	`distance:Number` (default = `4.0`) — シャドウのオフセット距離（ピクセル単位）です。

	`angle:Number` (default = `45`) — 0 ～ 360 度で表されるシャドウの角度（浮動小数）です。

	`color:uint` (default = `0`) — シャドウのカラーです。16 進数形式（0xRRGGBB）で指定します。デフォルト値は 0x000000 です。

	`alpha:Number` (default = `1.0`) — シャドウカラーのアルファ透明度値です。0.0 ～ 1.0 の値を指定できます。例えば .25 と指定すると、透明度は 25% になります。

	`blurX:Number` (default = `4.0`) — 水平方向のぼかし量。指定できる値は 0 ～ 255.0（浮動小数）です。

	`blurY:Number` (default = `4.0`) — 垂直方向のぼかし量。指定できる値は 0 ～ 255.0（浮動小数）です。

	`strength:Number` (default = `1.0`) — インプリントの強さまたは広がりです。値が大きいほど、濃い色がインプリントされるので、シャドウと背景との間のコントラストが強くなります。指定できる値は 0 ～ 255.0 です。

	`quality:int` (default = `1`) — フィルターを適用する回数。BitmapFilterQuality 定数を使用します。 `BitmapFilterQuality.LOW` `BitmapFilterQuality.MEDIUM` `BitmapFilterQuality.HIGH` これらの値については、`quality` プロパティの説明を参照してください。

	`inner:Boolean` (default = `false`) — シャドウが内側のシャドウであるかどうかを指定します。`true` の場合は、内側シャドウを示します。値 `false` は外側シャドウ（オブジェクトの外側のエッジにあるシャドウ）を示します。

	`knockout:Boolean` (default = `false`) — `true` の場合は、ノックアウト効果を適用します。その結果、オブジェクトの塗りが透明になり、ドキュメントの背景色が表示されます。

	`hideObject:Boolean` (default = `false`) — オブジェクトが非表示であるかどうかを示します。`true` を指定すると、オブジェクト自体は描画されず、シャドウだけが表示されます。

clone

()

メソッド

public function clone():BitmapFilter

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

このフィルターオブジェクトのコピーを返します。

戻り値

BitmapFilter — 元の DropShadowFilter インスタンスのプロパティをすべて備えた新しい DropShadowFilter インスタンスです。

例この例の使用方法

DropShadowFilterExample.mxml

<?xml version="1.0"?>
<!-- filters/examples/DropShadowFilterExample.mxml -->
<s:Application 
    xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:mx="library://ns.adobe.com/flex/mx" 
    xmlns:s="library://ns.adobe.com/flex/spark" 
    creationComplete="createFilters()">
    
  <fx:Script><![CDATA[ 
     import spark.filters.*;
     import flash.filters.BitmapFilterQuality;
     import flash.filters.BitmapFilterType;
  
     private var myDropShadowFilter:DropShadowFilter;  
     private var color:Number = 0xFF33FF;
  
     public function createFilters():void {        
        myDropShadowFilter = new DropShadowFilter(15, 45, 
            color, 0.8, 8, 8, 0.65, BitmapFilterQuality.MEDIUM, false, false);
        b1.filters = [myDropShadowFilter];
     }
  
  ]]></fx:Script>

    <s:VGroup>
        <!-- This button has a filter applied in ActionScript. -->
        <s:Button id="b1" label="Click me"/>
        
        <!-- This button has a filter applied in MXML. -->
        <s:Button id="b2" label="Click me">
            <s:filters>
                <s:DropShadowFilter 
                    distance="15" 
                    angle="45" 
                    color="0xFF33FF" 
                    alpha=".8" 
                    blurX="8" 
                    blurY="8" 
                    strength=".65" 
                    quality="{BitmapFilterQuality.MEDIUM}"
                    inner="false" 
                    knockout="false"/>
            </s:filters>
        </s:Button>
        
    </s:VGroup>        
</s:Application>

法律上の注意 | プライバシーポリシー

DropShadowFilter - AS3 Flex

クラス x

alpha

angle

color

distance

hideObject

inner

DropShadowFilter

clone