DistanceBetween

object→Node→DGNode→DistanceBetween

0own Python properties11own spec properties0own methods2class attributes

Import

from weSkel.src.core.node.dg.distance_between.lib import DistanceBetween

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

Inheritance and scope

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

Constructor

Signature : DistanceBetween(node) → DistanceBetween.

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
distance	distance	_ValuePlugProxy · .value: float
point_1	point1	_ValuePlugProxy · .value: tuple
point_1_x	point1.point1X	_ValuePlugProxy · .value: float
point_1_y	point1.point1Y	_ValuePlugProxy · .value: float
point_1_z	point1.point1Z	_ValuePlugProxy · .value: float
point_2	point2	_ValuePlugProxy · .value: tuple
point_2_x	point2.point2X	_ValuePlugProxy · .value: float
point_2_y	point2.point2Y	_ValuePlugProxy · .value: float
point_2_z	point2.point2Z	_ValuePlugProxy · .value: float
in_matrix_1	inMatrix1	_ValuePlugProxy · .value: tuple
in_matrix_2	inMatrix2	_ValuePlugProxy · .value: tuple

distance

node.distanceNative spec

Access to native plug distance.

Item	Type / behavior
Maya path	distance
Property return	_ValuePlugProxy · .value: float
Declared kind	numeric:double
Declared default	0.0
Flags	output, connectable
Observed read · Maya 2025.3	_ValuePlugProxy · .value: MDistance
Observed read · Maya 2026.3	_ValuePlugProxy · .value: float
Read	node.distance.value

point_1

node.point_1Native spec

Access to native plug point1.

Item	Type / behavior
Maya path	point1
Property return	_ValuePlugProxy · .value: tuple
Declared kind	double3
Declared default	()
Flags	input, connectable, stored
Read	node.point_1.value
Descriptor assignment	node.point_1 = value

point_1_x

node.point_1_xNative spec

Access to native plug point1.point1X.

Item	Type / behavior
Maya path	point1.point1X
Property return	_ValuePlugProxy · .value: float
Declared kind	numeric:double
Declared default	0.0
Flags	input, connectable, stored
Observed read · Maya 2025.3	_ValuePlugProxy · .value: MDistance
Observed read · Maya 2026.3	_ValuePlugProxy · .value: float
Read	node.point_1_x.value
Descriptor assignment	node.point_1_x = value

point_1_y

node.point_1_yNative spec

Access to native plug point1.point1Y.

Item	Type / behavior
Maya path	point1.point1Y
Property return	_ValuePlugProxy · .value: float
Declared kind	numeric:double
Declared default	0.0
Flags	input, connectable, stored
Observed read · Maya 2025.3	_ValuePlugProxy · .value: MDistance
Observed read · Maya 2026.3	_ValuePlugProxy · .value: float
Read	node.point_1_y.value
Descriptor assignment	node.point_1_y = value

point_1_z

node.point_1_zNative spec

Access to native plug point1.point1Z.

Item	Type / behavior
Maya path	point1.point1Z
Property return	_ValuePlugProxy · .value: float
Declared kind	numeric:double
Declared default	0.0
Flags	input, connectable, stored
Observed read · Maya 2025.3	_ValuePlugProxy · .value: MDistance
Observed read · Maya 2026.3	_ValuePlugProxy · .value: float
Read	node.point_1_z.value
Descriptor assignment	node.point_1_z = value

point_2

node.point_2Native spec

Access to native plug point2.

Item	Type / behavior
Maya path	point2
Property return	_ValuePlugProxy · .value: tuple
Declared kind	double3
Declared default	()
Flags	input, connectable, stored
Read	node.point_2.value
Descriptor assignment	node.point_2 = value

point_2_x

node.point_2_xNative spec

Access to native plug point2.point2X.

Item	Type / behavior
Maya path	point2.point2X
Property return	_ValuePlugProxy · .value: float
Declared kind	numeric:double
Declared default	0.0
Flags	input, connectable, stored
Observed read · Maya 2025.3	_ValuePlugProxy · .value: MDistance
Observed read · Maya 2026.3	_ValuePlugProxy · .value: float
Read	node.point_2_x.value
Descriptor assignment	node.point_2_x = value

point_2_y

node.point_2_yNative spec

Access to native plug point2.point2Y.

Item	Type / behavior
Maya path	point2.point2Y
Property return	_ValuePlugProxy · .value: float
Declared kind	numeric:double
Declared default	0.0
Flags	input, connectable, stored
Observed read · Maya 2025.3	_ValuePlugProxy · .value: MDistance
Observed read · Maya 2026.3	_ValuePlugProxy · .value: float
Read	node.point_2_y.value
Descriptor assignment	node.point_2_y = value

point_2_z

node.point_2_zNative spec

Access to native plug point2.point2Z.

Item	Type / behavior
Maya path	point2.point2Z
Property return	_ValuePlugProxy · .value: float
Declared kind	numeric:double
Declared default	0.0
Flags	input, connectable, stored
Observed read · Maya 2025.3	_ValuePlugProxy · .value: MDistance
Observed read · Maya 2026.3	_ValuePlugProxy · .value: float
Read	node.point_2_z.value
Descriptor assignment	node.point_2_z = value

in_matrix_1

node.in_matrix_1Native spec

Access to native plug inMatrix1.

Item	Type / behavior
Maya path	inMatrix1
Property return	_ValuePlugProxy · .value: tuple
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, connectable, stored
Read	node.in_matrix_1.value
Descriptor assignment	node.in_matrix_1 = value

in_matrix_2

node.in_matrix_2Native spec

Access to native plug inMatrix2.

Item	Type / behavior
Maya path	inMatrix2
Property return	_ValuePlugProxy · .value: tuple
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, connectable, stored
Read	node.in_matrix_2.value
Descriptor assignment	node.in_matrix_2 = 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	'distanceBetween'
SPEC_LAYERS	get_dg_specs_all, get_distance_between_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 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.distance_between.lib import DistanceBetween

node = DistanceBetween("api_distance_between_" + uuid4().hex[:8])
try:
    node.create()
    node.point_1 = (0.0, 0.0, 0.0)
    node.point_2 = (3.0, 4.0, 0.0)
    value = node.distance.value
    result = value.asCentimeters() if isinstance(value, om.MDistance) else value
    assert abs(result - 5.0) < 1e-6
    print("DistanceBetween: native evaluation OK")
finally:
    node.delete(snapshot=False)

Expected result : DistanceBetween: native 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.