UVPin

object→Node→DGNode→UVPin

0own Python properties19own spec properties0own methods2class attributes

Import

from weSkel.src.core.node.dg.uv_pin.lib import UVPin

Run in Maya or an initialized mayapy process. Import om only if your script uses OpenMaya types.

Inheritance and scope

Item	Value
Classe	UVPin
Module	weSkel.src.core.node.dg.uv_pin.lib
Maya type	uvPin
Direct parent	DGNode
Inventory	Members defined or overridden here; inherited members are grouped by parent in each section.

Constructor

Signature : UVPin(node) → UVPin.

Parameter	Accepted type	Default
node	Union[str, om.MObject, om.MObjectHandle, om.MFnDependencyNode]	Required

Wraps an existing node or stages a wrapper for an absent name; does not create the node. Call create() separately. An incompatible object or type can raise TypeError. Shared identity can return an already registered compatible wrapper.

Properties

Python properties defined or overridden here. R: read-only; R/W: a setter exists, subject to the member notes. om.* types belong to maya.api.OpenMaya.

No new Python property; see inherited members and specs below.

Properties inherited from DGNode15

Property	Return type	Access	Description
dep_fn	om.MFnDependencyNode	R	Live function set; unattached object when the node is missing.
uuid	str | None	R	Live UUID, or the last staged value if still available.
name	str | None	R/W	Live name, otherwise staged name.
absolute_name	str | None	R	Absolute namespace name from MFnDependencyNode.absoluteName(); None without a node.
stripped_name	str | None	R/W	Name without its namespace, or None when unnamed.
namespace	str | None	R/W	Normalized namespace such as a:b; None at the root.
plugs	Plugs | None	R	Live node plug manager; None otherwise.
is_valid_dep_fn	bool	R	Function-set compatibility with the current MObject.
is_default_node	bool	R	Whether this is a Maya default node; False without a node.
is_from_referenced_file	bool	R	Whether the node comes from a referenced file; False without a node.
is_locked	bool	R/W	Node lock, separate from plug locks.
is_shared	bool	R	Shared state reported by Maya; False without a node.
plugin_name	str | None	R	Associated Maya plugin name, possibly an empty string; None without a node.
affect_animation	bool	R	Result of MFnDependencyNode.affectsAnimation(); False without a node.
type	str | None	R/W	Live native type or staged type.

Properties inherited from Node10

Property	Return type	Access	Description
mobject	om.MObject	R/W	Live Maya object, or a null object.
mobject_handle	om.MObjectHandle	R/W	Handle associated with the node.
api_type	int | None	R	Maya API type identifier.
api_type_str	str	R	API type name, for example "kTime".
exists	bool	R	The wrapper currently has a live node.
is_null	bool	R	The returned Maya object is null.
is_alive	bool	R	The object exists with a valid, live handle.
is_valid_handle	bool	R	Validity of the stored handle.
is_dag_node	bool	R	Compatibility with om.MFn.kDagNode.
hash_code	int	R	Maya handle hash.

Spec properties

Defaults and flags below are spec declarations, not guaranteed live values. A descriptor can return a proxy: .value reads its value; .plug accesses the Plug. Proxy names describe results, not private classes to import. Observed types come from a test fixture; disconnected geometry inputs may notably return None.

For writes where failure must be checked, use the Plug explicitly and verify live state. Descriptor setters do not propagate every native failure.

Property	Maya plug	Returns
cache_setup	cacheSetup	None
deformed_geometry	deformedGeometry	_ValuePlugProxy · .value: None
original_geometry	originalGeometry	_ValuePlugProxy · .value: None
rail_curve	railCurve	_ValuePlugProxy · .value: None
output_matrix	outputMatrix	TypedArrayProxy
relative_space_matrix	relativeSpaceMatrix	_ValuePlugProxy · .value: MMatrix
relative_space_mode	relativeSpaceMode	_ValuePlugProxy · .value: int
normal_axis	normalAxis	_ValuePlugProxy · .value: int
normal_override	normalOverride	_ValuePlugProxy · .value: int
output_translate	outputTranslate	_DynNumericArrayProxy
output_translate_x	outputTranslate[].outputTranslateX	IndexedPathProxy
output_translate_y	outputTranslate[].outputTranslateY	IndexedPathProxy
output_translate_z	outputTranslate[].outputTranslateZ	IndexedPathProxy
tangent_axis	tangentAxis	_ValuePlugProxy · .value: int
coordinate	coordinate	_DynNumericArrayProxy
coordinate_u	coordinate[].coordinateU	IndexedPathProxy
coordinate_v	coordinate[].coordinateV	IndexedPathProxy
normalized_iso_parms	normalizedIsoParms	_ValuePlugProxy · .value: bool
uv_set_name	uvSetName	_ValuePlugProxy · .value: str

cache_setup

node.cache_setupNative spec

Access to native plug cacheSetup.

Item	Type / behavior
Maya path	cacheSetup
Property return	None
Declared kind	typed:ctype
Declared default	None
Flags	connectable, hidden

The descriptor setter rejects assignment; use Plug connection operations.

deformed_geometry

node.deformed_geometryNative spec

Access to native plug deformedGeometry.

Item	Type / behavior
Maya path	deformedGeometry
Property return	_ValuePlugProxy · .value: None
Declared kind	typed:geometry
Declared default	None
Flags	input, output, connectable
Read	node.deformed_geometry.value

original_geometry

node.original_geometryNative spec

Access to native plug originalGeometry.

Item	Type / behavior
Maya path	originalGeometry
Property return	_ValuePlugProxy · .value: None
Declared kind	typed:geometry
Declared default	None
Flags	input, output, connectable
Read	node.original_geometry.value

rail_curve

node.rail_curveNative spec

Access to native plug railCurve.

Item	Type / behavior
Maya path	railCurve
Property return	_ValuePlugProxy · .value: None
Declared kind	typed:geometry
Declared default	None
Flags	input, output, connectable
Read	node.rail_curve.value

output_matrix

node.output_matrixNative spec

Access to native plug outputMatrix.

Item	Type / behavior
Maya path	outputMatrix
Property return	TypedArrayProxy
Declared kind	array:typed:matrix
Declared default	()
Flags	array, output, connectable
Underlying plug	node.output_matrix.plug

relative_space_matrix

node.relative_space_matrixNative spec

Access to native plug relativeSpaceMatrix.

Item	Type / behavior
Maya path	relativeSpaceMatrix
Property return	_ValuePlugProxy · .value: MMatrix
Declared kind	typed:matrix
Declared default	(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
Read	node.relative_space_matrix.value
Descriptor assignment	node.relative_space_matrix = value

relative_space_mode

node.relative_space_modeNative spec

Access to native plug relativeSpaceMode.

Item	Type / behavior
Maya path	relativeSpaceMode
Property return	_ValuePlugProxy · .value: int
Declared kind	enum
Declared default	0
Flags	input, output, connectable, stored
Native enum values	0 = World, 1 = Local, 2 = Custom
Read	node.relative_space_mode.value
Descriptor assignment	node.relative_space_mode = value

normal_axis

node.normal_axisNative spec

Access to native plug normalAxis.

Item	Type / behavior
Maya path	normalAxis
Property return	_ValuePlugProxy · .value: int
Declared kind	enum
Declared default	0
Flags	input, output, connectable, stored
Native enum values	0 = X, 1 = Y, 2 = Z, 3 = -X, 4 = -Y, 5 = -Z
Read	node.normal_axis.value
Descriptor assignment	node.normal_axis = value

normal_override

node.normal_overrideNative spec

Access to native plug normalOverride.

Item	Type / behavior
Maya path	normalOverride
Property return	_ValuePlugProxy · .value: int
Declared kind	enum
Declared default	0
Flags	input, output, connectable, stored
Native enum values	0 = Auto, 1 = Rail Curve
Read	node.normal_override.value
Descriptor assignment	node.normal_override = value

output_translate

node.output_translateNative spec

Access to native plug outputTranslate.

Item	Type / behavior
Maya path	outputTranslate
Property return	_DynNumericArrayProxy
Declared kind	array:double3
Declared default	()
Flags	array, output, connectable
Underlying plug	node.output_translate.plug

output_translate_x

node.output_translate_xNative spec

Access to native plug outputTranslate[].outputTranslateX.

Item	Type / behavior
Maya path	outputTranslate[].outputTranslateX
Property return	IndexedPathProxy
Declared kind	unit:distance
Declared default	0.0
Flags	output, connectable
Verified explicit path · Plug	node.plugs["outputTranslate"][i1]["outputTranslateX"]

Observed limitation on the tested fixture: AttributeError: Child 'outputTranslateX' not found under 'api_UVPin.outputTranslate[0]'. Indices are Maya logical indices; choose existing or intended elements.

output_translate_y

node.output_translate_yNative spec

Access to native plug outputTranslate[].outputTranslateY.

Item	Type / behavior
Maya path	outputTranslate[].outputTranslateY
Property return	IndexedPathProxy
Declared kind	unit:distance
Declared default	0.0
Flags	output, connectable
Verified explicit path · Plug	node.plugs["outputTranslate"][i1]["outputTranslateY"]

Observed limitation on the tested fixture: AttributeError: Child 'outputTranslateY' not found under 'api_UVPin.outputTranslate[0]'. Indices are Maya logical indices; choose existing or intended elements.

output_translate_z

node.output_translate_zNative spec

Access to native plug outputTranslate[].outputTranslateZ.

Item	Type / behavior
Maya path	outputTranslate[].outputTranslateZ
Property return	IndexedPathProxy
Declared kind	unit:distance
Declared default	0.0
Flags	output, connectable
Verified explicit path · Plug	node.plugs["outputTranslate"][i1]["outputTranslateZ"]

Observed limitation on the tested fixture: AttributeError: Child 'outputTranslateZ' not found under 'api_UVPin.outputTranslate[0]'. Indices are Maya logical indices; choose existing or intended elements.

tangent_axis

node.tangent_axisNative spec

Access to native plug tangentAxis.

Item	Type / behavior
Maya path	tangentAxis
Property return	_ValuePlugProxy · .value: int
Declared kind	enum
Declared default	2
Flags	input, output, connectable, stored
Native enum values	0 = X, 1 = Y, 2 = Z, 3 = -X, 4 = -Y, 5 = -Z
Read	node.tangent_axis.value
Descriptor assignment	node.tangent_axis = value

coordinate

node.coordinateNative spec

Access to native plug coordinate.

Item	Type / behavior
Maya path	coordinate
Property return	_DynNumericArrayProxy
Declared kind	array:double2
Declared default	()
Flags	array, input, connectable, stored, keyable
Underlying plug	node.coordinate.plug

coordinate_u

node.coordinate_uNative spec

Access to native plug coordinate[].coordinateU.

Item	Type / behavior
Maya path	coordinate[].coordinateU
Property return	IndexedPathProxy
Declared kind	numeric:double
Declared default	0.0
Flags	input, connectable, stored, keyable
Verified explicit path · Plug	node.plugs["coordinate"][i1]["coordinateU"]

Observed limitation on the tested fixture: AttributeError: Child 'coordinateU' not found under 'api_UVPin.coordinate[0]'. Indices are Maya logical indices; choose existing or intended elements.

coordinate_v

node.coordinate_vNative spec

Access to native plug coordinate[].coordinateV.

Item	Type / behavior
Maya path	coordinate[].coordinateV
Property return	IndexedPathProxy
Declared kind	numeric:double
Declared default	0.0
Flags	input, connectable, stored, keyable
Verified explicit path · Plug	node.plugs["coordinate"][i1]["coordinateV"]

Observed limitation on the tested fixture: AttributeError: Child 'coordinateV' not found under 'api_UVPin.coordinate[0]'. Indices are Maya logical indices; choose existing or intended elements.

normalized_iso_parms

node.normalized_iso_parmsNative spec

Access to native plug normalizedIsoParms.

Item	Type / behavior
Maya path	normalizedIsoParms
Property return	_ValuePlugProxy · .value: bool
Declared kind	numeric:bool
Declared default	True
Flags	input, output, connectable, stored
Read	node.normalized_iso_parms.value
Descriptor assignment	node.normalized_iso_parms = value

uv_set_name

node.uv_set_nameNative spec

Access to native plug uvSetName.

Item	Type / behavior
Maya path	uvSetName
Property return	_ValuePlugProxy · .value: str
Declared kind	typed:string
Declared default	None
Flags	input, output, connectable, stored
Read	node.uv_set_name.value
Descriptor assignment	node.uv_set_name = value

Specs inherited from DGNode6

Property	Maya plug	Returns	Description
message	message	None	Node message plug; used for connections, with no numeric value.
frozen	frozen	_ValuePlugProxy · .value: bool	Native evaluation freeze state.
is_historically_interesting	isHistoricallyInteresting	_ValuePlugProxy · .value: int	Node interest level in Maya history.
bin_membership	binMembership	_ValuePlugProxy · .value: str	Maya bin membership.
caching_enabled	caching	_ValuePlugProxy · .value: bool	Native node caching switch.
caching_node_state	nodeState	_ValuePlugProxy · .value: int	Native nodeState evaluation state.

Methods

No additional public method; inherited methods remain available.

Methods inherited from DGNode7

Method	Returns	Description
create	None	Creates a missing node; does nothing if it already exists.
delete	None	Disconnects live connections, detaches the wrapper and deletes the node.
snapshot	DGSnapshot	Captures and stores an identity and spec-driven SVD dictionary.
snapshot_svd	SVDSnapshot	Captures Source / Value / Destinations for the requested list.
svd	SVDView	Returns a read-only live view of source, value and destinations; it is not a frozen capture.
finalize	None	Applies all sources, then undriven values, then destinations; enabled FSET dispatch follows.
clear_attr_cache	None	Clears this instance attribute cache; does not delete nodes or clear the global wrapper registry.

Methods inherited from Node2

Method	Returns	Description
has_fn(fn_type)	bool	Test compatibility with a Maya function set.
clear_node_registry()	None	Detach registered wrappers and clear their shared registry.

Class attributes

Attribute	Value / composition
NODE_TYPE	'uvPin'
SPEC_LAYERS	get_dg_specs_all, get_uv_pin_specs_all

NODE_REGISTRY and other class attributes not overridden here remain inherited. Exported Snapshot types describe dictionaries; use node.snapshot() to capture state.

Behavior at a glance

Point	Behavior
Identity	A node recreated under the same name is a new Maya object.
Creation and geometry	The constructor creates nothing; call create() before live operations.
Capture	Snapshots can contain Maya objects; do not assume JSON-ready data or complete geometry reconstruction.
Usage	The example uses a static NURBS surface for originalGeometry and deformedGeometry. In production, keep stable original geometry and connect deformed geometry separately. Mesh coordinates depend on the UV set; the example does not cover the mesh case.

Usage examples

Self-contained Maya Python Script Editor example. In mayapy, initialize maya.standalone before this block. The demonstration creates its own nodes and removes them in finally.

from uuid import uuid4
import maya.api.OpenMaya as om
from weSkel.src.core.node.dg.uv_pin.lib import UVPin
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 = UVPin("api_uv_pin_" + 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.original_geometry.plug)
    geometry.plugs["local"].connect_to(node.deformed_geometry.plug)
    node.normal_axis = 1
    node.tangent_axis = 0
    node.plugs["coordinate"][0]["coordinateU"].value = 0.5
    node.plugs["coordinate"][0]["coordinateV"].value = 0.5
    matrix = node.plugs["outputMatrix"][0].value
    position = om.MTransformationMatrix(matrix).translation(om.MSpace.kTransform)
    assert position.isEquivalent(om.MVector(0.5, 0.0, 0.5), 1e-5)
    print("UVPin: connected geometry evaluation OK")
finally:
    node.delete(snapshot=False)
    parent.delete(snapshot=False)

Expected result : UVPin: connected geometry evaluation OK.

SDK checkpoint 87c3486. Member inventory checked against loaded classes in Maya 2025.3 and 2026.3; reads and compatibility are specified in the member cards. Example run in both versions, including explicitly documented expected failures. The example does not cover every method. Listed limitations remain in source; these checks do not validate the compiled package.