IKManager - Adobe ActionScript® 3（AS3 Flash）API リファレンス

パッケージ	fl.ik
クラス	public class IKManager
継承	IKManager EventDispatcher Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

IKManager クラスは、ドキュメントに定義されたすべてのインバースキネマティック（IK）ツリー（アーマチュア）を表し、実行時にアーマチュアを管理するコンテナクラスです。

アーマチュアは Flash オーサリングツールでのみ作成できます。アーマチュアを持つ Flash CS4 ドキュメントを発行すると、Flash オーサリングツールは XML 形式のアーマチュアと生成した ActionScript コードを SWF ファイルに格納します。実行時、Flash Player は ActionScript コードを実行し、XML を解析してアーマチュアを再作成します。

IKManager クラスのインスタンスを作成する必要はありません。ランタイムが自動的にインスタンスを作成します。また、IKManager クラスのすべてのプロパティとメソッドは静的で、IKManager クラスのインスタンスを参照する必要がありません。

注意：document クラス内の IKArmature オブジェクトを参照するときは、最初に frameConstructed イベントをチェックして、すべてのオブジェクトが含まれていることを確認してください。

パブリックプロパティ

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

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

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		numArmatures : int [静的] [読み取り専用] ステージ上のアーマチュア数です。	IKManager

パブリックメソッド

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

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

	メソッド		定義元
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		getArmatureAt(index:int):IKArmature [静的] 指定のインデックス位置のアーマチュアを返します。	IKManager
		getArmatureByName(name:String):IKArmature [静的] 指定された名前を持つアーマチュアを返します。	IKManager
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		setStage(stage:DisplayObjectContainer):void [静的] このメソッドを使用して、ロードされた SWFファイル内のシンボルのコンテナを示します。	IKManager
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		trackAllArmatures(enable:Boolean = true):void [静的] すべてのアーマチュアのライブトラッキングを有効または無効にします。	IKManager
		trackIKArmature(theTree:IKArmature, enable:Boolean = true):void [静的] 指定された IKArmature インスタンスのライブトラッキングを有効または無効にします。	IKManager
		trackIKObject(target:DisplayObject, enable:Boolean = true):* [静的] 指定された IK 表示オブジェクトインスタンスのライブトラッキングを有効または無効にします。	IKManager
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

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

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

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

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

プロパティの詳細

numArmatures

プロパティ

numArmatures:int [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

ステージ上のアーマチュア数です。SWF ファイルがその後で他の SWF ファイルをロードすると、ロードされた SWF ファイルのアーマチュアは含まれません。

実装
public static function get numArmatures():int

メソッドの詳細

getArmatureAt

()

メソッド

public static function getArmatureAt(index:int):IKArmature

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定のインデックス位置のアーマチュアを返します。

パラメーター

index:int — 取得するアーマチュアの 0 から始まるインデックス番号です。

戻り値

IKArmature — 指定のインデックス位置の IKArmature インスタンスを返します。

例 ( この例の使用方法 )

次の例では、ツリーの最初のアーマチュアを取得します。document クラス内のアーマチュアを参照するには、addedToStage イベントではなく、frameConstructed イベントを使用します。これにより、すべての IKArmatures が含まれていることを確認できます。

         package
         {
            import fl.ik;
            import flash.display.MovieClip;
            import flash.events;
         
            public class IKDocClass extends MovieClip
            {
               public var arm:IKArmature;
         
               function IKDocClass()
               {
                  addEventListener("frameConstructed", onFC);
               }
         
               function onFC(evt:Event):void
               {
                  //Refer to armatures in frameConstructed
                  arm = IKManager.getArmatureAt(0);
                  trace(arm.name);
                  removeEventListener("frameConstructed", onFC);
               }
            }
         }

getArmatureByName

()

メソッド

public static function getArmatureByName(name:String):IKArmature

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定された名前を持つアーマチュアを返します。

パラメーター

name:String — 取得するアーマチュアの名前です。

戻り値

IKArmature — 指定された名前を持つ IKArmature インスタンスを返します。

例 ( この例の使用方法 )

次の例では、ツリーの最初のアーマチュアを取得します。

         import fl.ik.*;
         // Retrieve the IKArmature named "arm0" and assign to variable "tree"
         var tree:IKArmature = IKManager.getArmatureByName("arm0");

setStage

()

メソッド

public static function setStage(stage:DisplayObjectContainer):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

このメソッドを使用して、ロードされた SWFファイル内のシンボルのコンテナを示します。アーマチュアが含まれている SWF ファイルをロードする場合、アーマチュアのシンボルの場所を親 SWF ファイルに示す必要があります。子 SWF ファイルのステージにアーマチュアシンボルがある場合、その値は stage またはステージの変数になります。

パラメーター

stage:DisplayObjectContainer — ロードされた SWF ファイル内のアーマチュアシンボルの場所。

例 ( この例の使用方法 )

次の例では、1 つの SWF ファイルが、アーマチュアが含まれている別の SWF ファイルをロードします。子 SWF ファイル（アーマチュアシンボルが含まれているファイル）は、myAnimation.fla ファイルから生成されます。親 SWF ファイル（myAnimation.swf ファイルをロードするファイル）は、Main.fla ファイルから生成されます。myAnimation.fla ファイルには、ステージ上に配置されたアーマチュアシンボルのセットが含まれています。ActionScript 行では、ステージの変数 myAnimationStage が設定されます。この場合、この変数はアーマチュアシンボルのコンテナとなります。Main.fla ファイル内の ActionScript は、setStage() を使用して、親 SWF ファイルに対して、子 SWF ファイル内のシンボルコンテナの名前を伝えます。

myAnimation.fla ファイル用の ActionScript（子 SWF ファイルを生成します）：

         import fl.ik.*;
         
         var myAnimationIKM = IKManager;
         var myAnimationArm:IKArmature = IKManager.getArmatureAt(0);
         // set a variable for the stage containing the armature symbols
         var myAnimationStage:DisplayObjectContainer = stage;

Main.fla ファイル用の ActionScript（親 SWF ファイルを生成します）：

         var myLoader:Loader = new Loader();
         myLoader.contentLoaderInfo.addEventListener(Event.COMPLETE, onCompleteFunc);
         
         function onCompleteFunc(event:Event) {
             // indicate container of the armature symbols
             myLoader.content.myAnimationIKM.setStage(loader.content.myAnimationStage);
             myLoader.content.myAnimationArm.registerElements(loader.content.myAnimationStage);
             myLoader.content.myAnimationIKM.trackAllArmatures();
         }
         
         myLoader.load(new URLRequest("myAnimation.swf"));
         addChild(myLoader);

trackAllArmatures

()

メソッド

public static function trackAllArmatures(enable:Boolean = true):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

すべてのアーマチュアのライブトラッキングを有効または無効にします。ライブトラッキングが有効の場合、アーマチュアが含まれる SWF ファイルのユーザーは、アーマチュアをクリックしたままドラッグすることでアーマチュアを移動できます。

パラメーター

enable:Boolean (default = true) — false に設定されている場合、ライブトラッキングは無効です。それ以外の場合、ライブトラッキングは有効です。

trackIKArmature

()

メソッド

public static function trackIKArmature(theTree:IKArmature, enable:Boolean = true):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定された IKArmature インスタンスのライブトラッキングを有効または無効にします。ライブトラッキングが有効の場合、アーマチュアが含まれる SWF ファイルのユーザーは、アーマチュアをクリックしたままドラッグすることでアーマチュアを移動できます。

パラメーター

	`theTree:IKArmature` — ライブトラッキングを有効または無効に設定するアーマチュアです。

	`enable:Boolean` (default = `true`) — `false` に設定されている場合、ライブトラッキングは無効です。それ以外の場合、ライブトラッキングは有効です。

trackIKObject

()

メソッド

public static function trackIKObject(target:DisplayObject, enable:Boolean = true):*

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定された IK 表示オブジェクトインスタンスのライブトラッキングを有効または無効にします。特定の IK 表示オブジェクトインスタンスでライブトラッキングが有効の場合、ユーザーはクリックしたままドラックして IK 表示オブジェクトを含むアーマチュアを動かすことができます。

パラメーター

	`target:DisplayObject` — ライブトラッキングを有効または無効に設定する IK 表示オブジェクトのインスタンスです。

	`enable:Boolean` (default = `true`) — `false` に設定されている場合、ライブトラッキングは無効です。それ以外の場合、ライブトラッキングは有効です。

戻り値

*

IKManager - AS3 Flash

クラス x

numArmatures

getArmatureAt

getArmatureByName

setStage

trackAllArmatures

trackIKArmature

trackIKObject