ClosestPointOnSurface

object→Node→DGNode→ClosestPointOnSurface

0propriétés Python propres12propriétés de specs propres0méthodes propres2attributs de classe

Import

from weSkel.src.core.node.dg.closest_point_on_surface.lib import ClosestPointOnSurface

À 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.

Héritage et périmètre

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

Constructeur

Signature : ClosestPointOnSurface(node) → ClosestPointOnSurface.

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

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.

Propriétés issues des specs

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
in_position	inPosition	_ValuePlugProxy · .value: tuple
in_position_x	inPosition.inPositionX	_ValuePlugProxy · .value: float
in_position_y	inPosition.inPositionY	_ValuePlugProxy · .value: float
in_position_z	inPosition.inPositionZ	_ValuePlugProxy · .value: float
input_surface	inputSurface	_ValuePlugProxy · .value: None
result	result	CompoundProxy
position	result.position	_ValuePlugProxy · .value: tuple
position_x	result.position.positionX	_ValuePlugProxy · .value: float
position_y	result.position.positionY	_ValuePlugProxy · .value: float
position_z	result.position.positionZ	_ValuePlugProxy · .value: float
parameter_u	result.parameterU	_ValuePlugProxy · .value: float
parameter_v	result.parameterV	_ValuePlugProxy · .value: float

in_position

node.in_positionSpec native

Accès au plug natif inPosition.

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

in_position_x

node.in_position_xSpec native

Accès au plug natif inPosition.inPositionX.

Élément	Type / comportement
Chemin Maya	inPosition.inPositionX
Retour de la propriété	_ValuePlugProxy · .value: float
Type déclaré	unit:distance
Défaut déclaré	0.0
Flags	input, output, connectable, stored
Lecture	node.in_position_x.value
Affectation du descriptor	node.in_position_x = value

in_position_y

node.in_position_ySpec native

Accès au plug natif inPosition.inPositionY.

Élément	Type / comportement
Chemin Maya	inPosition.inPositionY
Retour de la propriété	_ValuePlugProxy · .value: float
Type déclaré	unit:distance
Défaut déclaré	0.0
Flags	input, output, connectable, stored
Lecture	node.in_position_y.value
Affectation du descriptor	node.in_position_y = value

in_position_z

node.in_position_zSpec native

Accès au plug natif inPosition.inPositionZ.

Élément	Type / comportement
Chemin Maya	inPosition.inPositionZ
Retour de la propriété	_ValuePlugProxy · .value: float
Type déclaré	unit:distance
Défaut déclaré	0.0
Flags	input, output, connectable, stored
Lecture	node.in_position_z.value
Affectation du descriptor	node.in_position_z = value

input_surface

node.input_surfaceSpec native

Accès au plug natif inputSurface.

Élément	Type / comportement
Chemin Maya	inputSurface
Retour de la propriété	_ValuePlugProxy · .value: None
Type déclaré	typed:nurbsSurface
Défaut déclaré	None
Flags	input, output, connectable
Lecture	node.input_surface.value

result

node.resultSpec native

Accès au plug natif result.

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

position

node.positionSpec native

Accès au plug natif result.position.

Élément	Type / comportement
Chemin Maya	result.position
Retour de la propriété	_ValuePlugProxy · .value: tuple
Type déclaré	double3
Défaut déclaré	(0.0, 0.0, 0.0)
Flags	output, connectable
Lecture	node.position.value

position_x

node.position_xSpec native

Accès au plug natif result.position.positionX.

Élément	Type / comportement
Chemin Maya	result.position.positionX
Retour de la propriété	_ValuePlugProxy · .value: float
Type déclaré	unit:distance
Défaut déclaré	0.0
Flags	output, connectable
Lecture	node.position_x.value

position_y

node.position_ySpec native

Accès au plug natif result.position.positionY.

Élément	Type / comportement
Chemin Maya	result.position.positionY
Retour de la propriété	_ValuePlugProxy · .value: float
Type déclaré	unit:distance
Défaut déclaré	0.0
Flags	output, connectable
Lecture	node.position_y.value

position_z

node.position_zSpec native

Accès au plug natif result.position.positionZ.

Élément	Type / comportement
Chemin Maya	result.position.positionZ
Retour de la propriété	_ValuePlugProxy · .value: float
Type déclaré	unit:distance
Défaut déclaré	0.0
Flags	output, connectable
Lecture	node.position_z.value

parameter_u

node.parameter_uSpec native

Accès au plug natif result.parameterU.

Élément	Type / comportement
Chemin Maya	result.parameterU
Retour de la propriété	_ValuePlugProxy · .value: float
Type déclaré	numeric:double
Défaut déclaré	0.0
Flags	output, connectable
Lecture	node.parameter_u.value

parameter_v

node.parameter_vSpec native

Accès au plug natif result.parameterV.

Élément	Type / comportement
Chemin Maya	result.parameterV
Retour de la propriété	_ValuePlugProxy · .value: float
Type déclaré	numeric:double
Défaut déclaré	0.0
Flags	output, connectable
Lecture	node.parameter_v.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.

Méthodes

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é.

Attributs de classe

Attribut	Valeur / composition
NODE_TYPE	'closestPointOnSurface'
SPEC_LAYERS	get_dg_specs_all, get_closest_point_on_surface_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.

Comportements à retenir

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.
Utilisation	La position d’entrée doit utiliser le même espace que la surface connectée. L’exemple utilise la sortie locale d’un patch dont le transform est à l’identité.

Exemples d’utilisation

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.closest_point_on_surface.lib import ClosestPointOnSurface
from weSkel.src.core.node.dag.transform.lib import Transform
from weSkel.src.core.node.dag.surface.lib import Surface

suffix = uuid4().hex[:8]
parent = Transform("api_geometry_" + suffix)
node = ClosestPointOnSurface("api_closest_point_on_surface_" + suffix)
try:
    parent.create()
    node.create()
    surface_object = om.MFnNurbsSurface().create(
        [om.MPoint(0, 0, 0), om.MPoint(0, 0, 1), om.MPoint(1, 0, 0), om.MPoint(1, 0, 1)],
        [0, 1], [0, 1], 1, 1, om.MFnNurbsSurface.kOpen, om.MFnNurbsSurface.kOpen,
        False, parent.mobject)
    geometry = Surface(surface_object)
    geometry.plugs["local"].connect_to(node.input_surface.plug)
    node.in_position = (0.5, 2.0, 0.5)
    assert om.MVector(node.position.value).isEquivalent(om.MVector(0.5, 0.0, 0.5), 1e-5)
    assert abs(node.parameter_u.value - 0.5) < 1e-5
    assert abs(node.parameter_v.value - 0.5) < 1e-5
    print("ClosestPointOnSurface: connected geometry evaluation OK")
finally:
    node.delete(snapshot=False)
    parent.delete(snapshot=False)

Résultat attendu : ClosestPointOnSurface: connected geometry 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.