IKArmature - Guide de référence de l’API Adobe ActionScript® 3 (AS3 Flash)

Package	fl.ik
Classe	public class IKArmature
Héritage	IKArmature Object

Version du langage:

ActionScript 3.0

Version du produit:

Flash CS4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La classe IKArmature décrit un squelette de cinématique inverse (IK). Un squelette est une collection de fragments, appelés « segments », connectés les uns aux autres au niveau des « liaisons ». Les squelettes sont souvent décrits comme une structure de type arborescence ou chaîne. Les squelettes peuvent tirer parti des fonctionnalités de ressort et d’amortissement du moteur physique dynamique via la propriété springsEnabled.

Comme les squelettes ne peuvent être créés que dans l’outil de création de Flash, il est préférable de ne pas utiliser le constructeur de la classe IKArmature pour créer des occurrences de cette classe. Flash Player crée toutes les occurrences de la classe IKArmature au démarrage de l’exécution d’un fichier SWF. Vous pouvez créer une référence à un squelette à l’aide des méthodes getArmatureAt() ou getArmatureByName() de la classe IKManager.

Remarque : lorsqu’un squelette n’est pas dans la première image d’une scène, utilisez la méthode registerElements() pour initialiser ce squelette pour un objet DisplayObject spécifique.

Plus d’exemples

Aperçu de l’animation de squelettes IK

Eléments de l’API associés

fl.ik.IKManager.getArmatureAt()
fl.ik.IKManager.getArmatureByName()

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		container : DisplayObjectContainer [lecture seule] Renvoie DisplayObjectContainer transmis par appel de la méthode registerElements.	IKArmature
		name : String [lecture seule] Nom du squelette.	IKArmature
		rootJoint : IKJoint [lecture seule] Liaison racine du squelette.	IKArmature
		springsEnabled : Boolean Indique si les ressorts d’un squelette sont activés.	IKArmature

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		getBoneByName(targetName:String):IKBone Renvoie le segment spécifié.	IKArmature
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.	Object
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		registerElements(container:DisplayObjectContainer):* Active un mouvement de cinématique inverse (IK) pour une occurrence de symbole de bibliothèque contenant un squelette.	IKArmature
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object

Détails de la propriété

container

propriété

container:DisplayObjectContainer [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie DisplayObjectContainer transmis par appel de la méthode registerElements.

Implémentation
public function get container():DisplayObjectContainer

name

propriété

name:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flash CS4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Nom du squelette. Le nom d’un squelette ne peut être spécifié que dans l’outil de création de Flash.

Implémentation
public function get name():String

Exemple ( Comment utiliser cet exemple )

L’exemple suivant montre comment récupérer le nom du premier squelette d’un document :

         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

propriété

rootJoint:IKJoint [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flash CS4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Liaison racine du squelette. Chaque squelette contient une seule liaison racine mais peut avoir plusieurs liaisons enfant. Vous pouvez traverser un squelette en récupérant la liaison racine et en utilisant les méthodes de la classe IKJoint pour vous déplacer d’une liaison à l’autre.

Implémentation
public function get rootJoint():IKJoint

Eléments de l’API associés

fl.ik.IKJoint

Exemple ( Comment utiliser cet exemple )

L’exemple suivant montre comment récupérer le premier squelette d’un document et récupérer sa liaison racine :

         import fl.ik.*;
         // Retrieve the first armature and store in variable "arm0"
         var arm0:IKArmature = IKManager.getArmatureAt(0);
         // Retrieve the armature's root joint
         var rootJnt:IKJoint = arm0.rootJoint;

springsEnabled

propriété

springsEnabled:Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

Flash Player 10.1, AIR 1.5

Indique si les ressorts d’un squelette sont activés. Lorsque cette valeur est définie sur true, le squelette peut tirer parti du nouveau moteur physique dynamique, qui ajoute des fonctions de ressort et d’amortissement à une animation. La valeur par défaut est true.

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

Implémentation
public function get springsEnabled():Boolean
public function set springsEnabled(value:Boolean):void

Détails de la méthode

getBoneByName

()

méthode

public function getBoneByName(targetName:String):IKBone

Version du langage:

ActionScript 3.0

Version du produit:

Flash CS4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le segment spécifié. Un nom peut être attribué à chaque segment dans l’outil de création de Flash. Utilisez cette méthode pour créer une référence à un segment de manière à pouvoir le manipuler au moment de l’exécution.

Paramètres

targetName:String

Valeur renvoyée

IKBone — Occurrence IKBone spécifiée par le paramètre targetName.

Eléments de l’API associés

Classe IKBone

Exemple ( Comment utiliser cet exemple )

L’exemple suivant montre comment récupérer un segment nommé « firstBone » et l’affecter à une variable nommée « bone » :

         import fl.ik.*;
         // Retrieve bone named "firstBone" and store in variable "bone"
         var bone:IKBone = IKArmature.getBoneByName("firstBone");

registerElements

()

méthode

public function registerElements(container:DisplayObjectContainer):*

Version du langage:

ActionScript 3.0

Version du produit:

Flash CS4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Active un mouvement de cinématique inverse (IK) pour une occurrence de symbole de bibliothèque contenant un squelette. Une bibliothèque MovieClip, contenant un squelette et instanciée à l’exécution, doit appeler cette méthode pour activer les effets de la cinématique inverse à l’exécution.

Remarque : cette méthode doit être appelée lorsque le squelette n’est pas dans la première image de la première scène.

Paramètres

container:DisplayObjectContainer — Référence à la scène, accessible par le biais de la propriété stage de tout DisplayObject actuellement dans la liste d’affichage.

Valeur renvoyée

*

Exemple ( Comment utiliser cet exemple )

L’exemple suivant montre comment activer un mouvement de cinématique inverse pour un symbole de bibliothèque instancié au moment de l’exécution. Le symbole de bibliothèque est un objet MovieClip nommé « IKPerson » qui contient un squelette.

         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);

L’exemple suivant décrit l’utilisation de la méthode registerElements() pour initialiser un squelette qui n’est pas dans la première image d’une séquence. Pour initialiser un squelette, joignez le code suivant à la première image qui le contient :

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

Informations juridiques | Politique de confidentialité en ligne

IKArmature - AS3 Flash

Packagesx

Eléments du langage

Annexes

Package fl.ik

container

name

rootJoint

springsEnabled

getBoneByName

registerElements