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

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

IKArmature クラスはインバースキネマティック（IK）アーマチュアを表します。アーマチュアは「ボーン」と呼ばれるセグメントの集まりで、「ジョイント」で互いに接続されます。通常、アーマチュアはツリー構造やチェーン構造のように記述します。アーマチュアでは、springsEnabled プロパティを使用して、動的な物理エンジンのスプリング減衰機能を利用できます。

アーマチュアは Flash オーサリングツールでのみ作成することができるので、IKArmature クラスのコンストラクターを使用してインスタンスを作成しないでください。SWF ファイルが起動するとき、Flash Player は IKArmature クラスのすべてのインスタンスを作成します。IKManager クラスの getArmatureAt() や getArmatureByName() メソッドを使用してアーマチュアの参照を作成することができます。

注意：アーマチュアがシーンの最初のフレームにない場合、registerElements() メソッドを使用して特定の DisplayObject のアーマチュアを初期化します。

パブリックプロパティ

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

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

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		container : DisplayObjectContainer [読み取り専用] registerElements の呼び出しに渡された DisplayObjectContainer を返します。	IKArmature
		name : String [読み取り専用] アーマチュア名です。	IKArmature
		rootJoint : IKJoint [読み取り専用] アーマチュアのルートジョイントです。	IKArmature
		springsEnabled : Boolean アーマチュアのスプリングを有効にするかどうかを指定します。	IKArmature

パブリックメソッド

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

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

	メソッド		定義元
		getBoneByName(targetName:String):IKBone 指定されたボーンを返します。	IKArmature
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		registerElements(container:DisplayObjectContainer):* アーマチュアを含むライブラリシンボルインスタンスのインバースキネマティック（IK）移動をアクティブ化します。	IKArmature
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object

プロパティの詳細

container

プロパティ

container:DisplayObjectContainer [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

registerElements の呼び出しに渡された DisplayObjectContainer を返します。

実装
public function get container():DisplayObjectContainer

name

プロパティ

name:String [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

アーマチュア名です。アーマチュア名は Flash オーサリングツールでのみ指定することができます。

実装
public function get name():String

例 ( この例の使用方法 )

次の例は、ドキュメント内の最初のアーマチュアの名前を取得する方法を示したものです。

         import fl.ik.*;
         // Retrieve the first armature and store in variable "arm0"
         var arm0:IKArmature = IKManager.getArmatureAt(0);
         // Trace the name of the first armature
         trace(arm0.name);

rootJoint

プロパティ

rootJoint:IKJoint [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

アーマチュアのルートジョイントです。アーマチュアにはルートジョイントは 1 つしかありませんが、複数の子ジョイントを持つことが可能です。ルートジョイントを取得し、ジョイントからジョイントへ移動するために IKJoint クラスのメソッドを使うことで、アーマチュア内を移動することができます。

実装
public function get rootJoint():IKJoint

springsEnabled

プロパティ

springsEnabled:Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10.1, AIR 1.5

アーマチュアのスプリングを有効にするかどうかを指定します。この値が true の場合、アーマチュアでは、アニメーションにスプリング減衰を追加する新しい動的な物理エンジンを利用できます。デフォルト値は true です。

         myArmature:IKArmature = fl.ik.IKManager.getArmatureAt(0);
         myArmature.springsEnabled = true; // turns springs on

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

メソッドの詳細

getBoneByName

()

メソッド

public function getBoneByName(targetName:String):IKBone

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定されたボーンを返します。Flash オーサリングツールを使用してボーンに名前を割り当てることができます。実行時にボーンを操作することができるように、このメソッドを使用してボーンの参照を作成します。

パラメーター

targetName:String

戻り値

IKBone — targetName パラメーターで指定された IKBone インスタンスです。

registerElements

()

メソッド

public function registerElements(container:DisplayObjectContainer):*

言語バージョン:

ActionScript 3.0

製品バージョン:

Flash CS4

ランタイムバージョン:

Flash Player 10, AIR 1.5

アーマチュアを含むライブラリシンボルインスタンスのインバースキネマティック（IK）移動をアクティブ化します。アーマチュアを含み、実行時にインスタンス化される MovieClip ライブラリは、実行時インバースキネマティック効果をアクティブ化するためにこのメソッドを呼び出します。

注意：このメソッドは、アーマチュアが最初のシーンの最初のフレーム上にない場合にも呼び出される必要があります。

パラメーター

container:DisplayObjectContainer — ステージへの参照は、現在表示リストにある DisplayObject の stage プロパティを通してアクセス可能になります。

戻り値

*

例 ( この例の使用方法 )

次の例は、実行時のインスタンス化されたライブラリシンボルへのインバースキネマティック移動をアクティブ化する方法を示したものです。ライブラリシンボルは、アーマチュアを含む「IKPerson」という名前の MovieClip です。

         import fl.ik.*;
         // Add a Library Symbol named "IKPerson"
         // that contains an armature.
         // The symbol must be marked "Export for ActionScript"
         var myPerson:IKPerson = new IKPerson();
         
         // add MovieClip to display list
         addChild(myPerson);
         
         // The IKPerson MovieClip contains an IK Armature with the name
         // "Armature_Person" and marked as Runtime Armature instead of Authortime Armature
         var myArmature:IKArmature = IKManager.getArmatureByName("Armature_Person");
         
         // Allow armature to perform inverse kinematic
         // movement at run time
         myArmature.registerElements(stage);
         
         // Allow user to track armature and perform
         // IK movement with the mouse
         IKManager.trackIKArmature(myArmature, true);

次の例は、registerElements() メソッドを使用してシーンの最初のフレームにないアーマチュアを初期化する方法を示しています。アーマチュアを初期化するには、アーマチュアを含む最初のフレームに次のコードをアタッチします。

         import fl.ik.*;
         var arm:IKArmature = IKManager.getArmatureAt(0);
         arm.registerElements(stage);

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

IKArmature - AS3 Flash

クラス x

container

name

rootJoint

springsEnabled

getBoneByName

registerElements