Aller au contenu
weSkelDOCUMENTATION
Documentation/Référence API/AimMatrix

AimMatrix

Orientation d’une matrice vers des cibles primaires et secondaires.

ClassAPI 2.0MATRICES
objectNodeDGNodeAimMatrix
from weSkel.src.core.node.dg.aim_matrix.lib import AimMatrix

À exécuter dans Maya ou dans un processus mayapy initialisé. L’import om n’est nécessaire que si votre script utilise des types OpenMaya.

Élément Valeur
Classe AimMatrix
Module weSkel.src.core.node.dg.aim_matrix.lib
Type Maya aimMatrix
Parent direct DGNode
Inventaire Membres définis ou redéfinis ici ; les membres hérités sont regroupés par parent dans chaque rubrique.

Signature : AimMatrix(node) → AimMatrix.

Paramètre Type accepté Défaut
node Union[str, om.MObject, om.MObjectHandle, om.MFnDependencyNode] Obligatoire

Enveloppe un nœud existant ou prépare un wrapper pour un nom absent ; ne crée pas le nœud. Utiliser create() séparément. Un objet ou type incompatible peut lever TypeError. L’identité partagée peut renvoyer un wrapper compatible déjà enregistré.

Propriétés Python définies ou redéfinies ici. L : lecture seule ; L/E : setter disponible, avec les restrictions précisées dans la fiche. Les types om.* appartiennent à maya.api.OpenMaya.

Aucune nouvelle propriété Python ; consulter les membres hérités et les specs ci-dessous.

Propriétés héritées de DGNode15
Propriété Type retourné Accès Description
dep_fn om.MFnDependencyNode L Function set live ; objet non attaché si le nœud est absent.
uuid str | None L UUID live, ou dernière valeur mémorisée si elle reste disponible.
name str | None L/E Nom live, sinon nom mémorisé.
absolute_name str | None L Nom absolu de namespace renvoyé par MFnDependencyNode.absoluteName() ; None sans nœud.
stripped_name str | None L/E Nom sans namespace, ou None si aucun nom.
namespace str | None L/E Namespace normalisé comme a:b ; None à la racine.
plugs Plugs | None L Gestionnaire des plugs du nœud live ; None sinon.
is_valid_dep_fn bool L Compatibilité du function set avec le MObject courant.
is_default_node bool L Indique un nœud par défaut de Maya ; False sans nœud.
is_from_referenced_file bool L Indique un nœud issu d’un fichier référencé ; False sans nœud.
is_locked bool L/E Verrouillage du nœud, distinct des locks de plugs.
is_shared bool L État partagé renvoyé par Maya ; False sans nœud.
plugin_name str | None L Nom du plugin Maya associé, éventuellement chaîne vide ; None sans nœud.
affect_animation bool L Résultat de MFnDependencyNode.affectsAnimation() ; False sans nœud.
type str | None L/E Type natif live ou type mémorisé.
Propriétés héritées de Node10
Propriété Type retourné Accès Description
mobject om.MObject L/E Objet Maya live, ou objet nul.
mobject_handle om.MObjectHandle L/E Handle associé au nœud.
api_type int | None L Identifiant du type API Maya.
api_type_str str L Nom du type API, par exemple "kTime".
exists bool L Le wrapper possède actuellement un nœud live.
is_null bool L L’objet Maya retourné est nul.
is_alive bool L L’objet existe avec un handle valide et vivant.
is_valid_handle bool L Validité du handle mémorisé.
is_dag_node bool L Compatibilité avec om.MFn.kDagNode.
hash_code int L Hash du handle Maya.

Les defaults et flags ci-dessous sont les déclarations des specs, pas une garantie de valeur live. Un descriptor peut renvoyer un proxy : .value lit sa valeur ; .plug donne accès au Plug. Les noms des proxies décrivent le résultat, sans demander d’importer des classes privées. Les types observés proviennent d’un cas de contrôle ; une entrée géométrique non connectée peut notamment valoir None.

Pour une écriture dont il faut vérifier l’échec, utiliser explicitement le Plug et contrôler le résultat live. Les setters de descriptors ne propagent pas tous les échecs natifs.

Propriété Plug Maya Retour
enable enable _ValuePlugProxy · .value: bool
envelope envelope _ValuePlugProxy · .value: float
primary primary CompoundProxy
primary_input_axis primary.primaryInputAxis _ValuePlugProxy · .value: tuple
primary_input_axis_x primary.primaryInputAxis.primaryInputAxisX _ValuePlugProxy · .value: float
primary_input_axis_y primary.primaryInputAxis.primaryInputAxisY _ValuePlugProxy · .value: float
primary_input_axis_z primary.primaryInputAxis.primaryInputAxisZ _ValuePlugProxy · .value: float
primary_mode primary.primaryMode _ValuePlugProxy · .value: int
primary_target_vector primary.primaryTargetVector _ValuePlugProxy · .value: tuple
primary_target_vector_x primary.primaryTargetVector.primaryTargetVectorX _ValuePlugProxy · .value: float
primary_target_vector_y primary.primaryTargetVector.primaryTargetVectorY _ValuePlugProxy · .value: float
primary_target_vector_z primary.primaryTargetVector.primaryTargetVectorZ _ValuePlugProxy · .value: float
primary_target_matrix primary.primaryTargetMatrix _ValuePlugProxy · .value: MMatrix
secondary secondary CompoundProxy
secondary_input_axis secondary.secondaryInputAxis _ValuePlugProxy · .value: tuple
secondary_input_axis_x secondary.secondaryInputAxis.secondaryInputAxisX _ValuePlugProxy · .value: float
secondary_input_axis_y secondary.secondaryInputAxis.secondaryInputAxisY _ValuePlugProxy · .value: float
secondary_input_axis_z secondary.secondaryInputAxis.secondaryInputAxisZ _ValuePlugProxy · .value: float
secondary_mode secondary.secondaryMode _ValuePlugProxy · .value: int
secondary_target_vector secondary.secondaryTargetVector _ValuePlugProxy · .value: tuple
secondary_target_vector_x secondary.secondaryTargetVector.secondaryTargetVectorX _ValuePlugProxy · .value: float
secondary_target_vector_y secondary.secondaryTargetVector.secondaryTargetVectorY _ValuePlugProxy · .value: float
secondary_target_vector_z secondary.secondaryTargetVector.secondaryTargetVectorZ _ValuePlugProxy · .value: float
secondary_target_matrix secondary.secondaryTargetMatrix _ValuePlugProxy · .value: MMatrix
input_matrix inputMatrix _ValuePlugProxy · .value: MMatrix
output_matrix outputMatrix _ValuePlugProxy · .value: MMatrix
post_space_matrix postSpaceMatrix _ValuePlugProxy · .value: MMatrix
pre_space_matrix preSpaceMatrix _ValuePlugProxy · .value: MMatrix

node.enableSpec native

Accès au plug natif enable.

Élément Type / comportement
Chemin Maya enable
Retour de la propriété _ValuePlugProxy · .value: bool
Type déclaré numeric:bool
Défaut déclaré True
Flags input, output, connectable, stored
Lecture node.enable.value
Affectation du descriptor node.enable = value

node.envelopeSpec native

Accès au plug natif envelope.

Élément Type / comportement
Chemin Maya envelope
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 1.0
Flags input, output, connectable, stored
Lecture node.envelope.value
Affectation du descriptor node.envelope = value

node.primarySpec native

Accès au plug natif primary.

Élément Type / comportement
Chemin Maya primary
Retour de la propriété CompoundProxy
Type déclaré compound
Défaut déclaré None
Flags input, output, connectable, stored
Plug sous-jacent node.primary.plug

node.primary_input_axisSpec native

Accès au plug natif primary.primaryInputAxis.

Élément Type / comportement
Chemin Maya primary.primaryInputAxis
Retour de la propriété _ValuePlugProxy · .value: tuple
Type déclaré double3
Défaut déclaré ()
Flags input, output, connectable, stored, keyable
Lecture node.primary_input_axis.value
Affectation du descriptor node.primary_input_axis = value

node.primary_input_axis_xSpec native

Accès au plug natif primary.primaryInputAxis.primaryInputAxisX.

Élément Type / comportement
Chemin Maya primary.primaryInputAxis.primaryInputAxisX
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 1.0
Flags input, output, connectable, stored
Lecture node.primary_input_axis_x.value
Affectation du descriptor node.primary_input_axis_x = value

node.primary_input_axis_ySpec native

Accès au plug natif primary.primaryInputAxis.primaryInputAxisY.

Élément Type / comportement
Chemin Maya primary.primaryInputAxis.primaryInputAxisY
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.primary_input_axis_y.value
Affectation du descriptor node.primary_input_axis_y = value

node.primary_input_axis_zSpec native

Accès au plug natif primary.primaryInputAxis.primaryInputAxisZ.

Élément Type / comportement
Chemin Maya primary.primaryInputAxis.primaryInputAxisZ
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.primary_input_axis_z.value
Affectation du descriptor node.primary_input_axis_z = value

node.primary_modeSpec native

Accès au plug natif primary.primaryMode.

Élément Type / comportement
Chemin Maya primary.primaryMode
Retour de la propriété _ValuePlugProxy · .value: int
Type déclaré enum
Défaut déclaré 1
Flags input, output, connectable, stored
Valeurs enum natives 0 = Lock Axis, 1 = Aim, 2 = Align
Lecture node.primary_mode.value
Affectation du descriptor node.primary_mode = value

node.primary_target_vectorSpec native

Accès au plug natif primary.primaryTargetVector.

Élément Type / comportement
Chemin Maya primary.primaryTargetVector
Retour de la propriété _ValuePlugProxy · .value: tuple
Type déclaré double3
Défaut déclaré ()
Flags input, output, connectable, stored
Lecture node.primary_target_vector.value
Affectation du descriptor node.primary_target_vector = value

node.primary_target_vector_xSpec native

Accès au plug natif primary.primaryTargetVector.primaryTargetVectorX.

Élément Type / comportement
Chemin Maya primary.primaryTargetVector.primaryTargetVectorX
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.primary_target_vector_x.value
Affectation du descriptor node.primary_target_vector_x = value

node.primary_target_vector_ySpec native

Accès au plug natif primary.primaryTargetVector.primaryTargetVectorY.

Élément Type / comportement
Chemin Maya primary.primaryTargetVector.primaryTargetVectorY
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.primary_target_vector_y.value
Affectation du descriptor node.primary_target_vector_y = value

node.primary_target_vector_zSpec native

Accès au plug natif primary.primaryTargetVector.primaryTargetVectorZ.

Élément Type / comportement
Chemin Maya primary.primaryTargetVector.primaryTargetVectorZ
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.primary_target_vector_z.value
Affectation du descriptor node.primary_target_vector_z = value

node.primary_target_matrixSpec native

Accès au plug natif primary.primaryTargetMatrix.

Élément Type / comportement
Chemin Maya primary.primaryTargetMatrix
Retour de la propriété _ValuePlugProxy · .value: MMatrix
Type déclaré typed:matrix
Défaut déclaré (1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0)
Flags input, output, connectable, stored
Lecture node.primary_target_matrix.value
Affectation du descriptor node.primary_target_matrix = value

node.secondarySpec native

Accès au plug natif secondary.

Élément Type / comportement
Chemin Maya secondary
Retour de la propriété CompoundProxy
Type déclaré compound
Défaut déclaré None
Flags input, output, connectable, stored, keyable
Plug sous-jacent node.secondary.plug

node.secondary_input_axisSpec native

Accès au plug natif secondary.secondaryInputAxis.

Élément Type / comportement
Chemin Maya secondary.secondaryInputAxis
Retour de la propriété _ValuePlugProxy · .value: tuple
Type déclaré double3
Défaut déclaré ()
Flags input, output, connectable, stored
Lecture node.secondary_input_axis.value
Affectation du descriptor node.secondary_input_axis = value

node.secondary_input_axis_xSpec native

Accès au plug natif secondary.secondaryInputAxis.secondaryInputAxisX.

Élément Type / comportement
Chemin Maya secondary.secondaryInputAxis.secondaryInputAxisX
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.secondary_input_axis_x.value
Affectation du descriptor node.secondary_input_axis_x = value

node.secondary_input_axis_ySpec native

Accès au plug natif secondary.secondaryInputAxis.secondaryInputAxisY.

Élément Type / comportement
Chemin Maya secondary.secondaryInputAxis.secondaryInputAxisY
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 1.0
Flags input, output, connectable, stored
Lecture node.secondary_input_axis_y.value
Affectation du descriptor node.secondary_input_axis_y = value

node.secondary_input_axis_zSpec native

Accès au plug natif secondary.secondaryInputAxis.secondaryInputAxisZ.

Élément Type / comportement
Chemin Maya secondary.secondaryInputAxis.secondaryInputAxisZ
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.secondary_input_axis_z.value
Affectation du descriptor node.secondary_input_axis_z = value

node.secondary_modeSpec native

Accès au plug natif secondary.secondaryMode.

Élément Type / comportement
Chemin Maya secondary.secondaryMode
Retour de la propriété _ValuePlugProxy · .value: int
Type déclaré enum
Défaut déclaré 0
Flags input, output, connectable, stored
Valeurs enum natives 0 = None, 1 = Aim, 2 = Align
Lecture node.secondary_mode.value
Affectation du descriptor node.secondary_mode = value

node.secondary_target_vectorSpec native

Accès au plug natif secondary.secondaryTargetVector.

Élément Type / comportement
Chemin Maya secondary.secondaryTargetVector
Retour de la propriété _ValuePlugProxy · .value: tuple
Type déclaré double3
Défaut déclaré ()
Flags input, output, connectable, stored
Lecture node.secondary_target_vector.value
Affectation du descriptor node.secondary_target_vector = value

node.secondary_target_vector_xSpec native

Accès au plug natif secondary.secondaryTargetVector.secondaryTargetVectorX.

Élément Type / comportement
Chemin Maya secondary.secondaryTargetVector.secondaryTargetVectorX
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.secondary_target_vector_x.value
Affectation du descriptor node.secondary_target_vector_x = value

node.secondary_target_vector_ySpec native

Accès au plug natif secondary.secondaryTargetVector.secondaryTargetVectorY.

Élément Type / comportement
Chemin Maya secondary.secondaryTargetVector.secondaryTargetVectorY
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.secondary_target_vector_y.value
Affectation du descriptor node.secondary_target_vector_y = value

node.secondary_target_vector_zSpec native

Accès au plug natif secondary.secondaryTargetVector.secondaryTargetVectorZ.

Élément Type / comportement
Chemin Maya secondary.secondaryTargetVector.secondaryTargetVectorZ
Retour de la propriété _ValuePlugProxy · .value: float
Type déclaré numeric:double
Défaut déclaré 0.0
Flags input, output, connectable, stored
Lecture node.secondary_target_vector_z.value
Affectation du descriptor node.secondary_target_vector_z = value

node.secondary_target_matrixSpec native

Accès au plug natif secondary.secondaryTargetMatrix.

Élément Type / comportement
Chemin Maya secondary.secondaryTargetMatrix
Retour de la propriété _ValuePlugProxy · .value: MMatrix
Type déclaré typed:matrix
Défaut déclaré (1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0)
Flags input, output, connectable, stored
Lecture node.secondary_target_matrix.value
Affectation du descriptor node.secondary_target_matrix = value

node.input_matrixSpec native

Accès au plug natif inputMatrix.

Élément Type / comportement
Chemin Maya inputMatrix
Retour de la propriété _ValuePlugProxy · .value: MMatrix
Type déclaré typed:matrix
Défaut déclaré (1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0)
Flags input, output, connectable, stored, keyable
Lecture node.input_matrix.value
Affectation du descriptor node.input_matrix = value

node.output_matrixSpec native

Accès au plug natif outputMatrix.

Élément Type / comportement
Chemin Maya outputMatrix
Retour de la propriété _ValuePlugProxy · .value: MMatrix
Type déclaré typed:matrix
Défaut déclaré (1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0)
Flags output, connectable
Lecture node.output_matrix.value

node.post_space_matrixSpec native

Accès au plug natif postSpaceMatrix.

Élément Type / comportement
Chemin Maya postSpaceMatrix
Retour de la propriété _ValuePlugProxy · .value: MMatrix
Type déclaré typed:matrix
Défaut déclaré (1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0)
Flags input, output, connectable, stored
Lecture node.post_space_matrix.value
Affectation du descriptor node.post_space_matrix = value

node.pre_space_matrixSpec native

Accès au plug natif preSpaceMatrix.

Élément Type / comportement
Chemin Maya preSpaceMatrix
Retour de la propriété _ValuePlugProxy · .value: MMatrix
Type déclaré typed:matrix
Défaut déclaré (1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0)
Flags input, output, connectable, stored
Lecture node.pre_space_matrix.value
Affectation du descriptor node.pre_space_matrix = value
Specs héritées de DGNode6
Propriété Plug Maya Retour Description
message message None Plug de message du nœud ; sert aux connexions, sans valeur numérique.
frozen frozen _ValuePlugProxy · .value: bool État natif de gel de l’évaluation.
is_historically_interesting isHistoricallyInteresting _ValuePlugProxy · .value: int Niveau d’intérêt du nœud dans l’historique Maya.
bin_membership binMembership _ValuePlugProxy · .value: str Appartenance aux bins Maya.
caching_enabled caching _ValuePlugProxy · .value: bool Activation du cache natif du nœud.
caching_node_state nodeState _ValuePlugProxy · .value: int État d’évaluation natif nodeState.

Aucune méthode publique supplémentaire ; les méthodes héritées restent disponibles.

Méthodes héritées de DGNode7
Méthode Retour Description
create None Crée le nœud s’il est absent ; ne fait rien s’il existe déjà.
delete None Déconnecte les connexions live, détache le wrapper puis supprime le nœud.
snapshot DGSnapshot Capture et mémorise un dictionnaire d’identité et d’état SVD selon les specs.
snapshot_svd SVDSnapshot Capture Source / Value / Destinations pour la liste demandée.
svd SVDView Renvoie une vue live en lecture seule de la source, de la valeur et des destinations ; ce n’est pas une capture figée.
finalize None Applique toutes les sources, puis les valeurs libres, puis les destinations ; le dispatch FSET activé suit ces phases.
clear_attr_cache None Vide le cache d’attributs de cette instance ; ne supprime aucun nœud et ne vide pas le registre global de wrappers.
Méthodes héritées de Node2
Méthode Retour Description
has_fn(fn_type) bool Tester la compatibilité avec un function set Maya.
clear_node_registry() None Détacher les wrappers enregistrés et vider leur registre partagé.
Attribut Valeur / composition
NODE_TYPE 'aimMatrix'
SPEC_LAYERS get_dg_specs_all, get_aim_matrix_specs_all

NODE_REGISTRY et les autres attributs de classe non redéfinis restent hérités. Les types Snapshot exportés décrivent des dictionnaires ; utiliser node.snapshot() pour effectuer une capture.

Point Comportement
Identité Un nœud recréé sous le même nom est un nouvel objet Maya.
Création et géométrie Le constructeur ne crée rien ; appeler create() avant les opérations live.
Capture Les snapshots peuvent contenir des objets Maya ; ne pas supposer un JSON prêt à exporter ni une reconstruction complète de géométrie.

Exemple autonome pour le Script Editor Python de Maya. Dans mayapy, initialiser maya.standalone avant ce bloc. La démonstration crée ses propres nœuds et les supprime dans le finally.

from uuid import uuid4
import maya.api.OpenMaya as om
from weSkel.src.core.node.dg.aim_matrix.lib import AimMatrix
node = AimMatrix("api_aim_matrix_" + uuid4().hex[:8])
try:
node.create()
node.primary_input_axis = (1.0, 0.0, 0.0)
node.primary_target_vector = (0.0, 1.0, 0.0)
node.primary_mode = 1
assert isinstance(node.output_matrix.value, om.MMatrix)
assert (om.MVector(1.0, 0.0, 0.0) * node.output_matrix.value).isEquivalent(om.MVector(0.0, 1.0, 0.0), 1e-6)
print("AimMatrix: native evaluation OK")
finally:
node.delete(snapshot=False)

Résultat attendu : AimMatrix: native evaluation OK.

Checkpoint SDK 87c3486. Inventaire confronté aux classes chargées sous Maya 2025.3 et 2026.3 ; lectures et compatibilité précisées dans les fiches. Exemple exécuté dans les deux versions, y compris les parcours d’échec attendu explicitement signalés. Les méthodes ne sont pas toutes couvertes par cet exemple. Les limites indiquées restent présentes dans les sources ; le package compilé n’est pas validé par ces contrôles.