Skip to content
weSkelDOCUMENTATION
Documentation/API reference/Surface

Surface

NURBS surfaces: definition, CVs and parametric queries.

ClassAPI 2.0DAG
from weSkel.src.core.node.dag.surface.lib import Surface

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

Item Value
Classe Surface
Module weSkel.src.core.node.dag.surface.lib
Maya type nurbsSurface
Direct parent SurfaceShape
Inventory Members defined or overridden here; inherited members are grouped by parent in each section.

Signature : Surface(node) → Surface.

Parameter Accepted type Default
node Union[str, om.MObject, om.MObjectHandle, om.MFnDependencyNode, om.MDagPath, om.MFnDagNode, om.MFnNurbsSurface, om.MFnNurbsSurfaceData] 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.

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.

Property Return type Access
mfn_surface Optional[om.MFnNurbsSurface] R
mfn_surface_data Optional[om.MFnNurbsSurfaceData] R
u_degree int R/W
v_degree int R/W
u_spans int R/W
v_spans int R/W
u_knots om.MDoubleArray R/W
v_knots om.MDoubleArray R/W
u_form int R/W
v_form int R/W
is_uniform bool R/W
is_rational bool R/W
is_trimmed bool R
num_regions int R
boundary_per_region List[int] R
area float R
num_patches int R
num_patches_u int R
num_patches_v int R
num_edges_u int R
num_edges_v int R
edges_indices_u List[Tuple[Tuple[int, int], Tuple[int, int]]] R
edges_indices_v List[Tuple[Tuple[int, int], Tuple[int, int]]] R
edges_points_u List[Tuple[om.MPoint, om.MPoint]] R
edges_points_v List[Tuple[om.MPoint, om.MPoint]] R
cv_list Optional[List[Tuple[Tuple[int, int], om.MObject]]] R
num_cvs_u int R
num_cvs_v int R
cvs om.MPointArray R/W
num_cvs int R

node.mfn_surfaceRead only

Return the MFnNurbsSurface function set, or None if unavailable.

Item Type / behavior
Returns Optional[om.MFnNurbsSurface]
Observed type on live geometry MFnNurbsSurface

node.mfn_surface_dataRead only

Return the MFnNurbsSurfaceData bound to the shape’s ‘local’ plug, or None.

Item Type / behavior
Returns Optional[om.MFnNurbsSurfaceData]
Observed type on live geometry MFnNurbsSurfaceData

node.u_degreeRead / write

Return the degree in U.

Item Type / behavior
Returns int
Observed type on live geometry int
Setter value int

The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.v_degreeRead / write

Get the degree in V.

Item Type / behavior
Returns int
Observed type on live geometry int
Setter value int

The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.u_spansRead / write

Get the number of U spans in the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int
Setter value int

The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.v_spansRead / write

Get the number of V spans in the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int
Setter value int

The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.u_knotsRead / write

Get the U knot vector of the Surface node.

Item Type / behavior
Returns om.MDoubleArray
Observed type on live geometry MDoubleArray
Setter value om.MDoubleArray

On a wrapper without a live surface, the setter calls .length() on the array. With the declared om.MDoubleArray type, this raises AttributeError in both tested versions. The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.v_knotsRead / write

Get the V knot vector of the Surface node.

Item Type / behavior
Returns om.MDoubleArray
Observed type on live geometry MDoubleArray
Setter value om.MDoubleArray

On a wrapper without a live surface, the setter calls .length() on the array. With the declared om.MDoubleArray type, this raises AttributeError in both tested versions. The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.u_formRead / write

Get the U form of the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int
Setter value int

The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.v_formRead / write

Get the V form of the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int
Setter value int

The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.is_uniformRead / write

Check if the Surface node is uniform.

Item Type / behavior
Returns bool
Observed type on live geometry bool
Setter value bool

The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.is_rationalRead / write

Check if the Surface node is rational.

Item Type / behavior
Returns bool
Observed type on live geometry bool
Setter value bool

The setter rejects a live surface (RuntimeError). Staged definitions can return values outside the annotation, including None or lists before initialization.

node.is_trimmedRead only

Check if the Surface node is trimmed.

Item Type / behavior
Returns bool
Observed type on live geometry bool

node.num_regionsRead only

Get the number of trim regions in the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int

node.boundary_per_regionRead only

Get the number of boundaries per trim region in the Surface node.

Item Type / behavior
Returns List[int]
Observed type on live geometry list

node.areaRead only

Get the surface area of the Surface node.

Item Type / behavior
Returns float
Observed type on live geometry float

node.num_patchesRead only

Get the number of patches in the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int

node.num_patches_uRead only

Get the number of patches in the U direction of the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int

node.num_patches_vRead only

Get the number of patches in the V direction of the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int

node.num_edges_uRead only

Get the number of edges in the U direction of the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int

node.num_edges_vRead only

Get the number of edges in the V direction of the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int

node.edges_indices_uRead only

Return edge index pairs along U.

Item Type / behavior
Returns List[Tuple[Tuple[int, int], Tuple[int, int]]]
Observed type on live geometry list

node.edges_indices_vRead only

Return edge index pairs along V.

Item Type / behavior
Returns List[Tuple[Tuple[int, int], Tuple[int, int]]]
Observed type on live geometry list

node.edges_points_uRead only

Return edge end points along U.

Item Type / behavior
Returns List[Tuple[om.MPoint, om.MPoint]]
Observed type on live geometry list

node.edges_points_vRead only

Return edge end points along V.

Item Type / behavior
Returns List[Tuple[om.MPoint, om.MPoint]]
Observed type on live geometry list

node.cv_listRead only

Get a list of control vertices (CVs) for the Surface node.

Item Type / behavior
Returns Optional[List[Tuple[Tuple[int, int], om.MObject]]]
Observed type on live geometry list

node.num_cvs_uRead only

Get the number of control vertices (CVs) in the U direction.

Item Type / behavior
Returns int
Observed type on live geometry int

node.num_cvs_vRead only

Get the number of control vertices (CVs) in the V direction.

Item Type / behavior
Returns int
Observed type on live geometry int

node.cvsRead / write

Get the control vertices (CVs) of the Surface node.

Item Type / behavior
Returns om.MPointArray
Observed type on live geometry MPointArray
Setter value Optional[Union[om.MPointArray, List[om.MPoint], List[List[float]]]]

The setter changes staged data and shape_orig data, without directly updating native CVs; it can fail without an intermediate shape. Use set_cv_positions() for live editing.

node.num_cvsRead only

Get the total number of control vertices (CVs) in the Surface node.

Item Type / behavior
Returns int
Observed type on live geometry int
Properties inherited from DAGNode20
Property Return type Access Description
dag_fn om.MFnDagNode R Live DAG function set, or unattached object when missing or invalid.
dag_path om.MDagPath R One path to the current node; empty path when unavailable.
has_valid_dag_path bool R Validity of the path returned by dag_path.
full_path_name str R Full DAG path; empty string when the path is invalid.
short_name str R Maya partial DAG path, which may contain more than a leaf name; empty string when invalid.
is_valid_dag_fn bool R Function-set validity for the current object.
is_shape bool R Current object compatibility with om.MFn.kShape.
parents list[DAGNode] R All native parents.
parent DAGNode | None R/W First parent only; None under world.
is_instanced bool R Whether the DAG object has multiple paths / parents; False when missing.
children list[DAGNode] R Direct children, without recursive traversal.
is_under_world bool R Live node directly under world; False when missing.
child_count int R Number of direct path children; 0 when invalid.
child_names list[str] R Full paths of direct children; empty list when the path is invalid.
shape_count int R Number of shapes directly under this path; 0 when invalid.
shapes list[DAGNode] R Direct child shapes, including intermediate shapes; empty list when invalid.
shape_orig DAGNode | None R First child shape with intermediateObject=True; None when absent.
intermediate_shapes list[DAGNode] R All direct child shapes marked as intermediate.
draw_override_info om.MDAGDrawOverrideInfo | None R Native path override information; None when unavailable.
fn_bounding_box om.MBoundingBox | None R Local bounding box from the function set; None when unavailable.
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.

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
tweak tweak _ValuePlugProxy · .value: bool
in_place inPlace _ValuePlugProxy · .value: bool
disp_cv dispCV _ValuePlugProxy · .value: bool
disp_ep dispEP _ValuePlugProxy · .value: bool
disp_geometry dispGeometry _ValuePlugProxy · .value: bool
disp_hull dispHull _ValuePlugProxy · .value: bool
disp_origin dispOrigin _ValuePlugProxy · .value: bool
sel_cv_disp selCVDisp _ValuePlugProxy · .value: bool
disp_sf dispSF _ValuePlugProxy · .value: bool
display_render_tessellation displayRenderTessellation _ValuePlugProxy · .value: bool
normals_display_scale normalsDisplayScale _ValuePlugProxy · .value: float
curve_precision curvePrecision _ValuePlugProxy · .value: int
curve_precision_shaded curvePrecisionShaded _ValuePlugProxy · .value: int
divisions_u divisionsU _ValuePlugProxy · .value: int
divisions_v divisionsV _ValuePlugProxy · .value: int
simplify_mode simplifyMode _ValuePlugProxy · .value: int
simplify_u simplifyU _ValuePlugProxy · .value: int
simplify_v simplifyV _ValuePlugProxy · .value: int
cached cached _ValuePlugProxy · .value: SurfaceProxy
curvature_tolerance curvatureTolerance _ValuePlugProxy · .value: int
degree_uv degreeUV _ValuePlugProxy · .value: tuple
degree_u degreeUV.degreeU _ValuePlugProxy · .value: int
degree_v degreeUV.degreeV _ValuePlugProxy · .value: int
smooth_edge_ratio smoothEdgeRatio _ValuePlugProxy · .value: float
form_u formU _ValuePlugProxy · .value: int
form_v formV _ValuePlugProxy · .value: int
header header MObject
create_spec create _ValuePlugProxy · .value: None
local local _ValuePlugProxy · .value: SurfaceProxy
min_max_range_u minMaxRangeU _ValuePlugProxy · .value: tuple
min_value_u minMaxRangeU.minValueU _ValuePlugProxy · .value: float
max_value_u minMaxRangeU.maxValueU _ValuePlugProxy · .value: float
min_max_range_v minMaxRangeV _ValuePlugProxy · .value: tuple
min_value_v minMaxRangeV.minValueV _ValuePlugProxy · .value: float
max_value_v minMaxRangeV.maxValueV _ValuePlugProxy · .value: float
spans_uv spansUV _ValuePlugProxy · .value: tuple
spans_u spansUV.spansU _ValuePlugProxy · .value: int
spans_v spansUV.spansV _ValuePlugProxy · .value: int
trim_face trimFace list
tweak_size_u tweakSizeU _ValuePlugProxy · .value: int
tweak_size_v tweakSizeV _ValuePlugProxy · .value: int
world_space worldSpace TypedArrayProxy
fix_texture_warp fixTextureWarp _ValuePlugProxy · .value: bool
render_triangle_count renderTriangleCount _ValuePlugProxy · .value: int
patch_uv_ids patchUVIds list
explicit_tessellation_attributes explicitTessellationAttributes _ValuePlugProxy · .value: bool
basic_tessellation_type basicTessellationType _ValuePlugProxy · .value: int
chord_height chordHeight _ValuePlugProxy · .value: float
obj_space_chord_height objSpaceChordHeight _ValuePlugProxy · .value: bool
chord_height_ratio chordHeightRatio _ValuePlugProxy · .value: float
edge_swap edgeSwap _ValuePlugProxy · .value: bool
grid_division_per_span_u gridDivisionPerSpanU _ValuePlugProxy · .value: int
grid_division_per_span_v gridDivisionPerSpanV _ValuePlugProxy · .value: int
min_screen minScreen _ValuePlugProxy · .value: float
mode_u modeU _ValuePlugProxy · .value: int
mode_v modeV _ValuePlugProxy · .value: int
number_u numberU _ValuePlugProxy · .value: int
number_v numberV _ValuePlugProxy · .value: int
u_divisions_factor uDivisionsFactor _ValuePlugProxy · .value: float
v_divisions_factor vDivisionsFactor _ValuePlugProxy · .value: float
use_chord_height useChordHeight _ValuePlugProxy · .value: bool
use_chord_height_ratio useChordHeightRatio _ValuePlugProxy · .value: bool
smooth_edge smoothEdge _ValuePlugProxy · .value: bool
use_min_screen useMinScreen _ValuePlugProxy · .value: bool

node.tweakNative spec

Access to native plug tweak.

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

node.in_placeNative spec

Access to native plug inPlace.

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

node.disp_cvNative spec

Access to native plug dispCV.

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

node.disp_epNative spec

Access to native plug dispEP.

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

node.disp_geometryNative spec

Access to native plug dispGeometry.

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

node.disp_hullNative spec

Access to native plug dispHull.

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

node.disp_originNative spec

Access to native plug dispOrigin.

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

node.sel_cv_dispNative spec

Access to native plug selCVDisp.

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

node.disp_sfNative spec

Access to native plug dispSF.

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

node.display_render_tessellationNative spec

Access to native plug displayRenderTessellation.

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

node.normals_display_scaleNative spec

Access to native plug normalsDisplayScale.

Item Type / behavior
Maya path normalsDisplayScale
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 1.0
Flags input, output, connectable, stored
Read node.normals_display_scale.value
Descriptor assignment node.normals_display_scale = value

node.curve_precisionNative spec

Access to native plug curvePrecision.

Item Type / behavior
Maya path curvePrecision
Property return _ValuePlugProxy · .value: int
Declared kind numeric:byte
Declared default 4
Flags input, output, connectable, stored
Read node.curve_precision.value
Descriptor assignment node.curve_precision = value

node.curve_precision_shadedNative spec

Access to native plug curvePrecisionShaded.

Item Type / behavior
Maya path curvePrecisionShaded
Property return _ValuePlugProxy · .value: int
Declared kind numeric:byte
Declared default 4
Flags input, output, connectable, stored
Read node.curve_precision_shaded.value
Descriptor assignment node.curve_precision_shaded = value

node.divisions_uNative spec

Access to native plug divisionsU.

Item Type / behavior
Maya path divisionsU
Property return _ValuePlugProxy · .value: int
Declared kind numeric:byte
Declared default 0
Flags input, output, connectable, stored
Read node.divisions_u.value
Descriptor assignment node.divisions_u = value

node.divisions_vNative spec

Access to native plug divisionsV.

Item Type / behavior
Maya path divisionsV
Property return _ValuePlugProxy · .value: int
Declared kind numeric:byte
Declared default 0
Flags input, output, connectable, stored
Read node.divisions_v.value
Descriptor assignment node.divisions_v = value

node.simplify_modeNative spec

Access to native plug simplifyMode.

Item Type / behavior
Maya path simplifyMode
Property return _ValuePlugProxy · .value: int
Declared kind numeric:byte
Declared default 0
Flags input, output, connectable, stored
Read node.simplify_mode.value
Descriptor assignment node.simplify_mode = value

node.simplify_uNative spec

Access to native plug simplifyU.

Item Type / behavior
Maya path simplifyU
Property return _ValuePlugProxy · .value: int
Declared kind numeric:byte
Declared default 0
Flags input, output, connectable, stored
Read node.simplify_u.value
Descriptor assignment node.simplify_u = value

node.simplify_vNative spec

Access to native plug simplifyV.

Item Type / behavior
Maya path simplifyV
Property return _ValuePlugProxy · .value: int
Declared kind numeric:byte
Declared default 0
Flags input, output, connectable, stored
Read node.simplify_v.value
Descriptor assignment node.simplify_v = value

node.cachedNative spec

Access to native plug cached.

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

node.curvature_toleranceNative spec

Access to native plug curvatureTolerance.

Item Type / behavior
Maya path curvatureTolerance
Property return _ValuePlugProxy · .value: int
Declared kind enum
Declared default 2
Flags input, output, connectable, stored
Read node.curvature_tolerance.value
Descriptor assignment node.curvature_tolerance = value

node.degree_uvNative spec

Access to native plug degreeUV.

Item Type / behavior
Maya path degreeUV
Property return _ValuePlugProxy · .value: tuple
Declared kind short2
Declared default (0, 0)
Flags output, connectable
Read node.degree_uv.value

node.degree_uNative spec

Access to native plug degreeUV.degreeU.

Item Type / behavior
Maya path degreeUV.degreeU
Property return _ValuePlugProxy · .value: int
Declared kind numeric:short
Declared default 0
Flags output, connectable
Read node.degree_u.value

node.degree_vNative spec

Access to native plug degreeUV.degreeV.

Item Type / behavior
Maya path degreeUV.degreeV
Property return _ValuePlugProxy · .value: int
Declared kind numeric:short
Declared default 0
Flags output, connectable
Read node.degree_v.value

node.smooth_edge_ratioNative spec

Access to native plug smoothEdgeRatio.

Item Type / behavior
Maya path smoothEdgeRatio
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 0.99
Flags input, output, connectable, stored
Read node.smooth_edge_ratio.value
Descriptor assignment node.smooth_edge_ratio = value

node.form_uNative spec

Access to native plug formU.

Item Type / behavior
Maya path formU
Property return _ValuePlugProxy · .value: int
Declared kind enum
Declared default 0
Flags output, connectable
Read node.form_u.value

node.form_vNative spec

Access to native plug formV.

Item Type / behavior
Maya path formV
Property return _ValuePlugProxy · .value: int
Declared kind enum
Declared default 0
Flags output, connectable
Read node.form_v.value

node.headerNative spec

Access to native plug header.

Item Type / behavior
Maya path header
Property return MObject
Declared kind typed:nurbsSurfaceHeader
Declared default None
Flags input, output

The descriptor setter rejects assignment; use Plug connection operations.

node.create_specNative spec

Access to native plug create.

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

node.localNative spec

Access to native plug local.

Item Type / behavior
Maya path local
Property return _ValuePlugProxy · .value: SurfaceProxy
Declared kind typed:nurbsSurface
Declared default None
Flags output, connectable
Read node.local.value

node.min_max_range_uNative spec

Access to native plug minMaxRangeU.

Item Type / behavior
Maya path minMaxRangeU
Property return _ValuePlugProxy · .value: tuple
Declared kind double2
Declared default (0.0, 0.0)
Flags output, connectable
Read node.min_max_range_u.value

node.min_value_uNative spec

Access to native plug minMaxRangeU.minValueU.

Item Type / behavior
Maya path minMaxRangeU.minValueU
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 0.0
Flags output, connectable
Read node.min_value_u.value

node.max_value_uNative spec

Access to native plug minMaxRangeU.maxValueU.

Item Type / behavior
Maya path minMaxRangeU.maxValueU
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 0.0
Flags output, connectable
Read node.max_value_u.value

node.min_max_range_vNative spec

Access to native plug minMaxRangeV.

Item Type / behavior
Maya path minMaxRangeV
Property return _ValuePlugProxy · .value: tuple
Declared kind double2
Declared default (0.0, 0.0)
Flags output, connectable
Read node.min_max_range_v.value

node.min_value_vNative spec

Access to native plug minMaxRangeV.minValueV.

Item Type / behavior
Maya path minMaxRangeV.minValueV
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 0.0
Flags output, connectable
Read node.min_value_v.value

node.max_value_vNative spec

Access to native plug minMaxRangeV.maxValueV.

Item Type / behavior
Maya path minMaxRangeV.maxValueV
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 0.0
Flags output, connectable
Read node.max_value_v.value

node.spans_uvNative spec

Access to native plug spansUV.

Item Type / behavior
Maya path spansUV
Property return _ValuePlugProxy · .value: tuple
Declared kind long2
Declared default (0, 0)
Flags output, connectable
Read node.spans_uv.value

node.spans_uNative spec

Access to native plug spansUV.spansU.

Item Type / behavior
Maya path spansUV.spansU
Property return _ValuePlugProxy · .value: int
Declared kind numeric:int
Declared default 0
Flags output, connectable
Read node.spans_u.value

node.spans_vNative spec

Access to native plug spansUV.spansV.

Item Type / behavior
Maya path spansUV.spansV
Property return _ValuePlugProxy · .value: int
Declared kind numeric:int
Declared default 0
Flags output, connectable
Read node.spans_v.value

node.trim_faceNative spec

Access to native plug trimFace.

Item Type / behavior
Maya path trimFace
Property return list
Declared kind array:typed:nurbstrimface
Declared default ()
Flags array, input, output, stored

node.tweak_size_uNative spec

Access to native plug tweakSizeU.

Item Type / behavior
Maya path tweakSizeU
Property return _ValuePlugProxy · .value: int
Declared kind numeric:int
Declared default -1
Flags input, output, connectable
Read node.tweak_size_u.value

node.tweak_size_vNative spec

Access to native plug tweakSizeV.

Item Type / behavior
Maya path tweakSizeV
Property return _ValuePlugProxy · .value: int
Declared kind numeric:int
Declared default -1
Flags input, output, connectable
Read node.tweak_size_v.value

node.world_spaceNative spec

Access to native plug worldSpace.

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

node.fix_texture_warpNative spec

Access to native plug fixTextureWarp.

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

node.render_triangle_countNative spec

Access to native plug renderTriangleCount.

Item Type / behavior
Maya path renderTriangleCount
Property return _ValuePlugProxy · .value: int
Declared kind numeric:int
Declared default 0
Flags output, connectable
Read node.render_triangle_count.value

node.patch_uv_idsNative spec

Access to native plug patchUVIds.

Item Type / behavior
Maya path patchUVIds
Property return list
Declared kind array:typed:nurbspatchuvids
Declared default ()
Flags array, input, output, connectable, stored, hidden

node.explicit_tessellation_attributesNative spec

Access to native plug explicitTessellationAttributes.

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

node.basic_tessellation_typeNative spec

Access to native plug basicTessellationType.

Item Type / behavior
Maya path basicTessellationType
Property return _ValuePlugProxy · .value: int
Declared kind enum
Declared default 0
Flags input, output, connectable, stored, hidden
Read node.basic_tessellation_type.value
Descriptor assignment node.basic_tessellation_type = value

node.chord_heightNative spec

Access to native plug chordHeight.

Item Type / behavior
Maya path chordHeight
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 0.1
Flags input, output, connectable, stored
Read node.chord_height.value
Descriptor assignment node.chord_height = value

node.obj_space_chord_heightNative spec

Access to native plug objSpaceChordHeight.

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

node.chord_height_ratioNative spec

Access to native plug chordHeightRatio.

Item Type / behavior
Maya path chordHeightRatio
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 0.983
Flags input, output, connectable, stored
Read node.chord_height_ratio.value
Descriptor assignment node.chord_height_ratio = value

node.edge_swapNative spec

Access to native plug edgeSwap.

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

node.grid_division_per_span_uNative spec

Access to native plug gridDivisionPerSpanU.

Item Type / behavior
Maya path gridDivisionPerSpanU
Property return _ValuePlugProxy · .value: int
Declared kind numeric:short
Declared default 4
Flags input, output, connectable, stored
Read node.grid_division_per_span_u.value
Descriptor assignment node.grid_division_per_span_u = value

node.grid_division_per_span_vNative spec

Access to native plug gridDivisionPerSpanV.

Item Type / behavior
Maya path gridDivisionPerSpanV
Property return _ValuePlugProxy · .value: int
Declared kind numeric:short
Declared default 4
Flags input, output, connectable, stored
Read node.grid_division_per_span_v.value
Descriptor assignment node.grid_division_per_span_v = value

node.min_screenNative spec

Access to native plug minScreen.

Item Type / behavior
Maya path minScreen
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 14.0
Flags input, output, connectable, stored
Read node.min_screen.value
Descriptor assignment node.min_screen = value

node.mode_uNative spec

Access to native plug modeU.

Item Type / behavior
Maya path modeU
Property return _ValuePlugProxy · .value: int
Declared kind enum
Declared default 3
Flags input, output, connectable, stored
Read node.mode_u.value
Descriptor assignment node.mode_u = value

node.mode_vNative spec

Access to native plug modeV.

Item Type / behavior
Maya path modeV
Property return _ValuePlugProxy · .value: int
Declared kind enum
Declared default 3
Flags input, output, connectable, stored
Read node.mode_v.value
Descriptor assignment node.mode_v = value

node.number_uNative spec

Access to native plug numberU.

Item Type / behavior
Maya path numberU
Property return _ValuePlugProxy · .value: int
Declared kind numeric:int
Declared default 3
Flags input, output, connectable, stored
Read node.number_u.value
Descriptor assignment node.number_u = value

node.number_vNative spec

Access to native plug numberV.

Item Type / behavior
Maya path numberV
Property return _ValuePlugProxy · .value: int
Declared kind numeric:int
Declared default 3
Flags input, output, connectable, stored
Read node.number_v.value
Descriptor assignment node.number_v = value

node.u_divisions_factorNative spec

Access to native plug uDivisionsFactor.

Item Type / behavior
Maya path uDivisionsFactor
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 4.5
Flags input, output, connectable, stored
Read node.u_divisions_factor.value
Descriptor assignment node.u_divisions_factor = value

node.v_divisions_factorNative spec

Access to native plug vDivisionsFactor.

Item Type / behavior
Maya path vDivisionsFactor
Property return _ValuePlugProxy · .value: float
Declared kind numeric:double
Declared default 4.5
Flags input, output, connectable, stored
Read node.v_divisions_factor.value
Descriptor assignment node.v_divisions_factor = value

node.use_chord_heightNative spec

Access to native plug useChordHeight.

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

node.use_chord_height_ratioNative spec

Access to native plug useChordHeightRatio.

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

node.smooth_edgeNative spec

Access to native plug smoothEdge.

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

node.use_min_screenNative spec

Access to native plug useMinScreen.

Item Type / behavior
Maya path useMinScreen
Property return _ValuePlugProxy · .value: bool
Declared kind numeric:bool
Declared default False
Flags input, output, connectable, stored
Read node.use_min_screen.value
Descriptor assignment node.use_min_screen = value
Specs inherited from SurfaceShape27
Property Maya plug Returns Description
bounding_box_scale boundingBoxScale _ValuePlugProxy · .value: tuple[float, float, float] Native surface bounding-box scale.
bounding_box_scale_x boundingBoxScale.boundingBoxScaleX _ValuePlugProxy · .value: float X component of bounding_box_scale.
bounding_box_scale_y boundingBoxScale.boundingBoxScaleY _ValuePlugProxy · .value: float Y component of bounding_box_scale.
bounding_box_scale_z boundingBoxScale.boundingBoxScaleZ _ValuePlugProxy · .value: float Z component of bounding_box_scale.
display_hw_environment displayHWEnvironment _ValuePlugProxy · .value: bool Hardware environment display.
hold_out holdOut _ValuePlugProxy · .value: bool Native holdout option.
smooth_shading smoothShading _ValuePlugProxy · .value: bool Smooth shading switch.
feature_displacement featureDisplacement _ValuePlugProxy · .value: bool Native feature-displacement option.
texture_treshold textureTreshold _ValuePlugProxy · .value: int Native textureTreshold threshold; API spelling preserved.
ignore_hw_shader ignoreHwShader _ValuePlugProxy · .value: bool Ignore-hardware-shader option.
normal_treshold normalTreshold _ValuePlugProxy · .value: float Native normalTreshold threshold; API spelling preserved.
double_sided doubleSided _ValuePlugProxy · .value: bool Double-sided display / rendering option.
opposite opposite _ValuePlugProxy · .value: bool Shape orientation reversal.
initial_sample_rate initialSampleRate _ValuePlugProxy · .value: int Initial surface sampling rate.
extra_sample_rate extraSampleRate _ValuePlugProxy · .value: int Additional sampling rate.
collision_depth_velocity_increment collisionDepthVelocityIncrement ArrayCompoundProxy Native collision-depth velocity increment ramp.
collision_depth_velocity_increment_position collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_Position IndexedPathProxy Position of a point on the collision_depth_velocity_increment ramp.
collision_depth_velocity_increment_float_value collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_FloatValue IndexedPathProxy Value of a point on the collision_depth_velocity_increment ramp.
collision_depth_velocity_increment_interp collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_Interp IndexedPathProxy Interpolation of a point on the collision_depth_velocity_increment ramp.
collision_depth_velocity_multiplier collisionDepthVelocityMultiplier ArrayCompoundProxy Native collision-depth velocity multiplier ramp.
collision_depth_velocity_multiplier_position collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_Position IndexedPathProxy Position of a point on the collision_depth_velocity_multiplier ramp.
collision_depth_velocity_multiplier_float_value collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_FloatValue IndexedPathProxy Value of a point on the collision_depth_velocity_multiplier ramp.
collision_depth_velocity_multiplier_interp collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_Interp IndexedPathProxy Interpolation of a point on the collision_depth_velocity_multiplier ramp.
collision_offset_velocity_multiplier collisionOffsetVelocityMultiplier ArrayCompoundProxy Native collision-offset velocity multiplier ramp.
collision_offset_velocity_multiplier_position collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_Position IndexedPathProxy Position of a point on the collision_offset_velocity_multiplier ramp.
collision_offset_velocity_multiplier_float_value collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_FloatValue IndexedPathProxy Value of a point on the collision_offset_velocity_multiplier ramp.
collision_offset_velocity_multiplier_interp collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_Interp IndexedPathProxy Interpolation of a point on the collision_offset_velocity_multiplier ramp.
Specs inherited from ControlPoint31
Property Maya plug Returns Description
blind_data_nodes blindDataNodes list[str] Link data for blind-data nodes.
color_set colorSet ArrayCompoundProxy Color-set array.
current_color_set currentColorSet _ValuePlugProxy · .value: str Current color-set name.
color_name colorSet[].colorName IndexedPathProxy Indexed color-set name.
clamped colorSet[].clamped IndexedPathProxy Color-set clamping state.
representation colorSet[].representation IndexedPathProxy Color representation mode.
color_set_points colorSet[].colorSetPoints AttributeError (direct access) Colors beneath an indexed color set.
color_set_points_r colorSet[].colorSetPoints[].colorSetPointsR IndexedPathProxy R component of color_set_points.
color_set_points_g colorSet[].colorSetPoints[].colorSetPointsG IndexedPathProxy G component of color_set_points.
color_set_points_b colorSet[].colorSetPoints[].colorSetPointsB IndexedPathProxy B component of color_set_points.
color_set_points_a colorSet[].colorSetPoints[].colorSetPointsA IndexedPathProxy A component of color_set_points.
control_points controlPoints ArrayCompoundProxy Native control-point / tweak array; not a universal read of final positions.
control_points_x_value controlPoints[].xValue IndexedPathProxy X component of the indexed control point.
control_points_y_value controlPoints[].yValue IndexedPathProxy Y component of the indexed control point.
control_points_z_value controlPoints[].zValue IndexedPathProxy Z component of the indexed control point.
relative_tweak relativeTweak _ValuePlugProxy · .value: bool Relative tweak mode.
tweak_location tweakLocation Any (native data) Native tweak-location data.
display_immediate displayImmediate _ValuePlugProxy · .value: bool Native immediate-display option.
display_color_channel displayColorChannel _ValuePlugProxy · .value: str Displayed color channel.
display_colors displayColors _ValuePlugProxy · .value: bool Component color display switch.
current_uv_set currentUVSet _ValuePlugProxy · .value: str Current UV-set name.
uv_set uvSet ArrayCompoundProxy UV-set array.
uv_set_name uvSet[].uvSetName IndexedPathProxy Indexed UV-set name.
uv_set_points uvSet[].uvSetPoints _DynNumericArrayProxy UV pairs of the UV set; access through its parent element to choose the set.
uv_set_points_u uvSet[].uvSetPoints[].uvSetPointsU IndexedPathProxy U coordinate addressed by two logical indices.
uv_set_points_v uvSet[].uvSetPoints[].uvSetPointsV IndexedPathProxy V coordinate addressed by two logical indices.
uv_set_tweak_location uvSet[].uvSetTweakLocation IndexedPathProxy UV-set tweak-location data.
uv_pivot uvPivot _ValuePlugProxy · .value: tuple[float, float] Two-component UV pivot.
uv_pivot_x uvPivot.uvPivotX _ValuePlugProxy · .value: float First UV pivot component.
uv_pivot_y uvPivot.uvPivotY _ValuePlugProxy · .value: float Second UV pivot component.
weights weights TypedArrayProxy Native control-point weights; distinct from skinCluster influence weights.
Specs inherited from GeometryShape32
Property Maya plug Returns Description
as_background asBackground _ValuePlugProxy · .value: bool Native background-use option.
depth_jitter depthJitter _ValuePlugProxy · .value: bool Native depth-jitter option.
primary_visiblity primaryVisibility _ValuePlugProxy · .value: bool Primary render visibility.
antialiasing_level antialiasingLevel _ValuePlugProxy · .value: int Geometry antialiasing level.
geometry_antialiasing_override geometryAntialiasingOverride _ValuePlugProxy · .value: bool Geometry antialiasing override switch.
component_tags componentTags ArrayCompoundProxy Component-tag array.
component_tag_name componentTags[].componentTagName IndexedPathProxy Tag name at the requested index.
component_tag_contents componentTags[].componentTagContents IndexedPathProxy Component-tag contents.
casts_shadows castsShadows _ValuePlugProxy · .value: bool Shadow casting switch.
hardware_fog_multiplier hardwareFogMultiplier _ValuePlugProxy · .value: float Hardware fog multiplier.
ignore_self_shadowing ignoreSelfShadowing _ValuePlugProxy · .value: bool Ignore-self-shadowing option.
max_shading_samples maxShadingSamples _ValuePlugProxy · .value: int Maximum shading sample count.
receive_shadows receiveShadows _ValuePlugProxy · .value: bool Shadow receiving switch.
shading_samples shadingSamples _ValuePlugProxy · .value: int Shading sample count.
shading_samples_override shadingSamplesOverride _ValuePlugProxy · .value: bool Shading sample override switch.
inst_material_assign instMaterialAssign list[str] Per-instance material assignment data.
pick_texture pickTexture None Native texture-picking connection.
comp_inst_obj_groups compInstObjGroups ArrayCompoundProxy Per-instance component groups.
comp_object_groups compInstObjGroups[].objectGroups AttributeError (direct access) Groups beneath a component instance.
comp_object_grp_comp_list compInstObjGroups[].objectGroups[].objectGrpCompList IndexedPathProxy Component list of the indexed group.
comp_object_group_id compInstObjGroups[].objectGroups[].objectGroupId IndexedPathProxy Indexed component group identifier.
reference_object referenceObject None Connection to the shape reference object.
max_visibility_samples maxVisibilitySamples _ValuePlugProxy · .value: int Maximum visibility sample count.
max_visibility_samples_override maxVisibilitySamplesOverride _ValuePlugProxy · .value: bool Visibility sample override switch.
render_type renderType _ValuePlugProxy · .value: int Native shape render type.
render_volume renderVolume _ValuePlugProxy · .value: bool Native volume rendering option.
visible_fraction visibleFraction _ValuePlugProxy · .value: float Native visible fraction.
visible_in_reflections visibleInReflections _ValuePlugProxy · .value: bool Visibility in reflections.
visible_in_refractions visibleInRefractions _ValuePlugProxy · .value: bool Visibility in refractions.
volume_samples volumeSamples _ValuePlugProxy · .value: int Volume sample count.
volume_samples_override volumeSamplesOverride _ValuePlugProxy · .value: bool Volume sample override switch.
motion_blur motionBlur _ValuePlugProxy · .value: bool Motion blur switch.
Specs inherited from DAGNode93
Property Maya plug Returns Description
use_object_color useObjectColor _ValuePlugProxy · .value: int Object-color usage mode.
visibility visibility _ValuePlugProxy · .value: bool Local node visibility; it does not summarize visibility across the hierarchy.
template template _ValuePlugProxy · .value: bool Object template display state.
lod_visibility lodVisibility _ValuePlugProxy · .value: bool Level-of-detail visibility.
object_color objectColor _ValuePlugProxy · .value: int Object color index.
object_color_rgb objectColorRGB _ValuePlugProxy · .value: tuple[float, float, float] Object RGB color.
object_color_r objectColorR _ValuePlugProxy · .value: float R component of object_color_rgb.
object_color_g objectColorG _ValuePlugProxy · .value: float G component of object_color_rgb.
object_color_b objectColorB _ValuePlugProxy · .value: float B component of object_color_rgb.
wire_color_rgb wireColorRGB _ValuePlugProxy · .value: tuple[float, float, float] Wireframe RGB color.
wire_color_r wireColorRGB.wireColorR _ValuePlugProxy · .value: float R component of wire_color_rgb.
wire_color_g wireColorRGB.wireColorG _ValuePlugProxy · .value: float G component of wire_color_rgb.
wire_color_b wireColorRGB.wireColorB _ValuePlugProxy · .value: float B component of wire_color_rgb.
hidden_in_outliner hiddenInOutliner _ValuePlugProxy · .value: bool Hidden state in the Outliner.
use_outliner_color useOutlinerColor _ValuePlugProxy · .value: bool Custom Outliner color switch.
outliner_color outlinerColor _ValuePlugProxy · .value: tuple[float, float, float] Outliner RGB color.
outliner_color_r outlinerColorR _ValuePlugProxy · .value: float R component of outliner_color.
outliner_color_g outlinerColorG _ValuePlugProxy · .value: float G component of outliner_color.
outliner_color_b outlinerColorB _ValuePlugProxy · .value: float B component of outliner_color.
ghosting ghosting _ValuePlugProxy · .value: bool Maya ghosting switch.
ghosting_mode ghostingMode _ValuePlugProxy · .value: int Ghosting mode.
ghost_custom_steps ghostCustomSteps CompoundProxy Compound ghosting-step settings.
ghost_pre_frames ghostCustomSteps.ghostPreFrames _ValuePlugProxy · .value: int Number of frames before the current frame.
ghost_post_frames ghostCustomSteps.ghostPostFrames _ValuePlugProxy · .value: int Number of frames after the current frame.
ghosts_step ghostCustomSteps.ghostsStep _ValuePlugProxy · .value: int Step between ghosting samples.
ghost_frames ghostFrames TypedArrayProxy Native ghosting frame list.
ghost_use_driver ghostUseDriver _ValuePlugProxy · .value: bool Use of a ghosting driver.
ghost_driver ghostDriver None Connection to the ghosting driver.
ghost_color_pre ghostColorPre _ValuePlugProxy · .value: tuple[float, float, float] Previous-ghost color.
ghost_color_pre_r ghostColorPre.ghostColorPreR _ValuePlugProxy · .value: float R component of ghost_color_pre.
ghost_color_pre_g ghostColorPre.ghostColorPreG _ValuePlugProxy · .value: float G component of ghost_color_pre.
ghost_color_pre_b ghostColorPre.ghostColorPreB _ValuePlugProxy · .value: float B component of ghost_color_pre.
ghost_color_post ghostColorPost _ValuePlugProxy · .value: tuple[float, float, float] Following-ghost color.
ghost_color_post_r ghostColorPost.ghostColorPostR _ValuePlugProxy · .value: float R component of ghost_color_post.
ghost_color_post_g ghostColorPost.ghostColorPostG _ValuePlugProxy · .value: float G component of ghost_color_post.
ghost_color_post_b ghostColorPost.ghostColorPostB _ValuePlugProxy · .value: float B component of ghost_color_post.
ghost_opacity_range ghostOpacityRange _ValuePlugProxy · .value: tuple[float, float] Compound ghost opacity range.
ghost_near_opacity ghostOpacityRange.ghostNearOpacity _ValuePlugProxy · .value: float Near-ghost opacity.
ghost_far_opacity ghostOpacityRange.ghostFarOpacity _ValuePlugProxy · .value: float Far-ghost opacity.
render_info renderInfo CompoundProxy Compound node render information.
identification renderInfo.identification _ValuePlugProxy · .value: int Native identifier in render information.
layer_renderable renderInfo.layerRenderable _ValuePlugProxy · .value: bool Layer renderability.
layer_override_color renderInfo.layerOverrideColor _ValuePlugProxy · .value: int Layer override color index.
render_layer_info renderLayerInfo ArrayCompoundProxy Per-render-layer information array.
render_layer_id renderLayerInfo[].renderLayerId IndexedPathProxy Render layer identifier at the requested index.
render_layer_renderable renderLayerInfo[].renderLayerRenderable IndexedPathProxy Renderability of the layer at the requested index.
render_layer_color renderLayerInfo[].renderLayerColor IndexedPathProxy Render layer color index.
selection_child_highlighting selectionChildHighlighting _ValuePlugProxy · .value: bool Child highlighting on selection.
inst_obj_groups instObjGroups ArrayCompoundProxy Membership groups per DAG instance.
object_groups instObjGroups[].objectGroups AttributeError (direct access) Component groups beneath a DAG instance.
object_grp_comp_list instObjGroups[].objectGroups[].objectGrpCompList IndexedPathProxy Group components addressed by two logical indices.
object_group_id instObjGroups[].objectGroups[].objectGroupId IndexedPathProxy Component group identifier.
object_grp_color instObjGroups[].objectGroups[].objectGrpColor IndexedPathProxy Component group color index.
matrix matrix _ValuePlugProxy · .value: om.MMatrix Local matrix evaluated by Maya.
inverse_matrix inverseMatrix _ValuePlugProxy · .value: om.MMatrix Inverse local matrix.
parent_matrix parentMatrix TypedArrayProxy Parent matrices indexed by instance.
parent_inverse_matrix parentInverseMatrix TypedArrayProxy Inverse parent matrices.
world_matrix worldMatrix TypedArrayProxy World matrices indexed by DAG instance.
world_inverse_matrix worldInverseMatrix TypedArrayProxy Inverse world matrices.
intermediate_object intermediateObject _ValuePlugProxy · .value: bool Maya intermediate-shape flag.
draw_override drawOverride CompoundProxy Compound display overrides.
override_enabled overrideEnabled _ValuePlugProxy · .value: bool Display override switch.
override_display_type overrideDisplayType _ValuePlugProxy · .value: int Override display type.
override_level_of_detail overrideLevelOfDetail _ValuePlugProxy · .value: int Override level of detail.
override_shading overrideShading _ValuePlugProxy · .value: bool Shading switch in the override.
override_texturing overrideTexturing _ValuePlugProxy · .value: bool Texturing switch in the override.
override_playback overridePlayback _ValuePlugProxy · .value: bool Playback display according to the override.
override_visibility overrideVisibility _ValuePlugProxy · .value: bool Override visibility.
override_color overrideColor _ValuePlugProxy · .value: int Override color index.
hide_on_playback hideOnPlayback _ValuePlugProxy · .value: bool Hide-on-playback switch.
override_rgb_colors overrideRGBColors _ValuePlugProxy · .value: bool RGB color mode for the override.
override_color_rgb overrideColorRGB _ValuePlugProxy · .value: tuple[float, float, float] Override RGB color.
override_color_r overrideColorRGB.overrideColorR _ValuePlugProxy · .value: float R component of override_color_rgb.
override_color_g overrideColorRGB.overrideColorG _ValuePlugProxy · .value: float G component of override_color_rgb.
override_color_b overrideColorRGB.overrideColorB _ValuePlugProxy · .value: float B component of override_color_rgb.
override_color_a overrideColorA _ValuePlugProxy · .value: float Override color alpha component.
bounding_box boundingBox CompoundProxy Compound bounding-box plugs; distinct from fn_bounding_box.
bounding_box_min boundingBox.boundingBoxMin _ValuePlugProxy · .value: tuple[float, float, float] Minimum corner of the local bounding box.
bounding_box_min_x boundingBox.boundingBoxMin.boundingBoxMinX _ValuePlugProxy · .value: float X component of bounding_box_min.
bounding_box_min_y boundingBox.boundingBoxMin.boundingBoxMinY _ValuePlugProxy · .value: float Y component of bounding_box_min.
bounding_box_min_z boundingBox.boundingBoxMin.boundingBoxMinZ _ValuePlugProxy · .value: float Z component of bounding_box_min.
bounding_box_max boundingBox.boundingBoxMax _ValuePlugProxy · .value: tuple[float, float, float] Maximum corner of the local bounding box.
bounding_box_max_x boundingBox.boundingBoxMax.boundingBoxMaxX _ValuePlugProxy · .value: float X component of bounding_box_max.
bounding_box_max_y boundingBox.boundingBoxMax.boundingBoxMaxY _ValuePlugProxy · .value: float Y component of bounding_box_max.
bounding_box_max_z boundingBox.boundingBoxMax.boundingBoxMaxZ _ValuePlugProxy · .value: float Z component of bounding_box_max.
bounding_box_size boundingBox.boundingBoxSize _ValuePlugProxy · .value: tuple[float, float, float] Local bounding-box dimensions.
bounding_box_size_x boundingBox.boundingBoxSize.boundingBoxSizeX _ValuePlugProxy · .value: float X component of bounding_box_size.
bounding_box_size_y boundingBox.boundingBoxSize.boundingBoxSizeY _ValuePlugProxy · .value: float Y component of bounding_box_size.
bounding_box_size_z boundingBox.boundingBoxSize.boundingBoxSizeZ _ValuePlugProxy · .value: float Z component of bounding_box_size.
center center _ValuePlugProxy · .value: tuple[float, float, float] Local bounding-box center.
center_x center.boundingBoxCenterX _ValuePlugProxy · .value: float X component of center.
center_y center.boundingBoxCenterY _ValuePlugProxy · .value: float Y component of center.
center_z center.boundingBoxCenterZ _ValuePlugProxy · .value: float Z component of center.
Specs inherited from ContainerBase21
Property Maya plug Returns Description
black_box blackBox _ValuePlugProxy · .value: bool Maya container black-box presentation.
border_connections borderConnections list[str] Container boundary connection data.
creator creator _ValuePlugProxy · .value: str Container creator metadata.
creation_date creationDate _ValuePlugProxy · .value: str Creation date metadata.
custom_treatment customTreatment _ValuePlugProxy · .value: str Custom container treatment.
hyper_layout hyperLayout None Connection to the Hypergraph layout.
icon_name iconName _ValuePlugProxy · .value: str Icon name associated with the container.
is_collapsed isCollapsed _ValuePlugProxy · .value: bool Collapsed container state in Maya views.
is_hierarchical_connection isHierarchicalConnection TypedArrayProxy Hierarchical connection flags.
rmb_command rmbCommand _ValuePlugProxy · .value: str Container context-menu command.
template_name templateName _ValuePlugProxy · .value: str Container template name.
template_path templatePath _ValuePlugProxy · .value: str Container template path.
template_version templateVersion _ValuePlugProxy · .value: int Container template version.
container_type containerType _ValuePlugProxy · .value: str Container type metadata.
ui_treatment uiTreatment _ValuePlugProxy · .value: int Container presentation mode.
view_mode viewMode _ValuePlugProxy · .value: int Container view mode.
view_name viewName _ValuePlugProxy · .value: str Container view name.
published_node_info publishedNodeInfo ArrayCompoundProxy Array of published-node information.
published_node publishedNodeInfo[].publishedNode IndexedPathProxy Connection to the published node at a given index.
is_hierarchical_node publishedNodeInfo[].isHierarchicalNode IndexedPathProxy Hierarchical flag of a published node.
published_node_type publishedNodeInfo[].publishedNodeType IndexedPathProxy Declared type of a published node.
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.
Method Returns
create None
snapshot SurfaceSnapshot
closest_point om.MPoint
closest_param Tuple[float, float]
get_param_at_point Tuple[float, float]
get_point_at_param om.MPoint
intersect Tuple[om.MPoint, float, float]
is_param_on_surface bool
is_point_on_trimmed_region bool
is_point_on_surface bool
add_cvs None
add_line None
remove_cvs None
clear_cvs None
get_cv om.MObject
get_cv_position om.MPoint
get_cvs om.MPointArray
set_cv_position None
set_cv_positions None
add_u_knots None
add_v_knots None
remove_u_knots None
remove_v_knots None
clear_knots None
clear_u_knots None
clear_v_knots None
set_u_knot None
set_v_knot None
set_u_degree None
set_v_degree None
set_degrees None
set_u_spans None
set_v_spans None

node.create() → NoneMethod

Create an empty shape or a surface from its offline definition.

Item Type / behavior
Returns None

The complete-definition path calls a native signature different from the tested example below. Creation from this definition is not validated here; the example explicitly creates API 2.0 geometry and then wraps it with Surface.

node.snapshot(profile: str='rig') → SurfaceSnapshotMethod

Build and return a minimal Surface snapshot for pre-create and safe replay.

Item Type / behavior
Returns SurfaceSnapshot
profile str · default: 'rig'

node.closest_point(point: om.MPoint, space: om.MSpace=None) → om.MPointMethod

Get the closest point on the Surface to a given point.

Item Type / behavior
Returns om.MPoint
point om.MPoint · default: —
space om.MSpace · default: None

The space parameter is not passed to the function set. Native tolerance is also fixed to zero; do not assume a world-space query.

node.closest_param(point: om.MPoint, space: om.MSpace=None) → Tuple[float, float]Method

Get the closest parameter (u, v) on the Surface to a given point.

Item Type / behavior
Returns Tuple[float, float]
point om.MPoint · default: —
space om.MSpace · default: None

The space parameter is not passed to the function set. Native tolerance is also fixed to zero; do not assume a world-space query.

node.get_param_at_point(point: om.MPoint, ignore_trim: bool=False, tolerance: float=None, space: om.MSpace=None) → Tuple[float, float]Method

Finds parameters at a point on the geometry; this is not automatic projection of an arbitrary point.

Item Type / behavior
Returns Tuple[float, float]
point om.MPoint · default: —
ignore_trim bool · default: False
tolerance float · default: None
space om.MSpace · default: None

The function set is built from an MObject. A world-space query raises RuntimeError without an MDagPath, as reproduced on the test patch. Choose object space where the parameter supports it.

node.get_point_at_param(u: float, v: float) → om.MPointMethod

Get the point on the Surface at a given parameter (u, v).

Item Type / behavior
Returns om.MPoint
u float · default: —
v float · default: —

node.intersect(ray_start: om.MPoint, ray_dir: om.MVector, tolerance: float=None, space: om.MSpace=None) → Tuple[om.MPoint, float, float]Method

Intersect a ray with the Surface.

Item Type / behavior
Returns Tuple[om.MPoint, float, float]
ray_start om.MPoint · default: —
ray_dir om.MVector · default: —
tolerance float · default: None
space om.MSpace · default: None

The function set is built from an MObject. A world-space query raises RuntimeError without an MDagPath, as reproduced on the test patch. Choose object space where the parameter supports it.

node.is_param_on_surface(u: float, v: float) → boolMethod

Check if a parameter (u, v) is on the Surface.

Item Type / behavior
Returns bool
u float · default: —
v float · default: —

node.is_point_on_trimmed_region(u: float, v: float) → boolMethod

Attempts to call isPointOnTrimmedEdge(), which is unavailable in the tested API 2.0 versions.

Item Type / behavior
Returns bool
u float · default: —
v float · default: —

Tested call: AttributeError, because om.MFnNurbsSurface has no isPointOnTrimmedEdge() in either target version. This path does not produce a usable boolean.

node.is_point_on_surface(point: om.MPoint, tolerance: float=None, space: om.MSpace=None) → boolMethod

Check if a point is on the Surface.

Item Type / behavior
Returns bool
point om.MPoint · default: —
tolerance float · default: None
space om.MSpace · default: None

node.add_cvs(points: Union[om.MPoint, List[om.MPoint], om.MPointArray, List[Union[int, float]], List[List[Union[int, float]]]]) → NoneMethod

Add control vertices (CVs) to the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
points Union[om.MPoint, List[om.MPoint], om.MPointArray, List[Union[int, float]], List[List[Union[int, float]]]] · default: —

node.add_line(start: om.MPoint=None, end: om.MPoint=None, line: Union[om.MPointArray, List[List[Union[int, float]]]]=None) → NoneMethod

Add a line defined by two points to the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
start om.MPoint · default: None
end om.MPoint · default: None
line Union[om.MPointArray, List[List[Union[int, float]]]] · default: None

node.remove_cvs(indices: Union[List[int], int]) → NoneMethod

Remove control vertices (CVs) from the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
indices Union[List[int], int] · default: —

node.clear_cvs() → NoneMethod

Clear all control vertices (CVs) from the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None

node.get_cv(u: int, v: int) → om.MObjectMethod

Get the control vertex (CV) at the specified U and V indices.

Item Type / behavior
Returns om.MObject
u int · default: —
v int · default: —

node.get_cv_position(uIndex: int, vIndex: int, space: Optional[om.MSpace]=None) → om.MPointMethod

Get the position of the control vertex (CV) at the specified U and V indices.

Item Type / behavior
Returns om.MPoint
uIndex int · default: —
vIndex int · default: —
space Optional[om.MSpace] · default: None

node.get_cvs(space: Optional[Union[om.MSpace, int]]=None) → om.MPointArrayMethod

Get the control vertices (CVs) of the Surface node.

Item Type / behavior
Returns om.MPointArray
space Optional[Union[om.MSpace, int]] · default: None

node.set_cv_position(uIndex: int, vIndex: int, position: om.MPoint, space: Optional[om.MSpace]=None) → NoneMethod

Set the position of the control vertex (CV) at the specified U and V indices.

Item Type / behavior
Returns None
uIndex int · default: —
vIndex int · default: —
position om.MPoint · default: —
space Optional[om.MSpace] · default: None

node.set_cv_positions(positions: om.MPointArray, space: Optional[om.MSpace]=None) → NoneMethod

Set the positions of the control vertices (CVs) of the Surface node.

Item Type / behavior
Returns None
positions om.MPointArray · default: —
space Optional[om.MSpace] · default: None

node.add_u_knots(knots: Union[List[Union[int, float]], int]) → NoneMethod

Add U knots to the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
knots Union[List[Union[int, float]], int] · default: —

node.add_v_knots(knots: Union[List[Union[int, float]], int]) → NoneMethod

Add V knots to the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
knots Union[List[Union[int, float]], int] · default: —

node.remove_u_knots(indices: Union[List[int], int]) → NoneMethod

Remove U knots from the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
indices Union[List[int], int] · default: —

node.remove_v_knots(indices: Union[List[int], int]) → NoneMethod

Remove V knots from the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
indices Union[List[int], int] · default: —

node.clear_knots() → NoneMethod

Clear all U and V knots from the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None

node.clear_u_knots() → NoneMethod

Clear all U knots from the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None

node.clear_v_knots() → NoneMethod

Clear all V knots from the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None

node.set_u_knot(index: int, knot: int) → NoneMethod

Set a specific U knot in the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
index int · default: —
knot int · default: —

node.set_v_knot(index: int, knot: int) → NoneMethod

Set a specific V knot in the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
index int · default: —
knot int · default: —

node.set_u_degree(degree: int) → NoneMethod

Set the U degree of the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
degree int · default: —

node.set_v_degree(degree: int) → NoneMethod

Set the V degree of the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
degree int · default: —

node.set_degrees(degrees: Union[List[int], int]) → NoneMethod

Set the U and V degrees of the Surface node. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
degrees Union[List[int], int] · default: —

node.set_u_spans(spans: int) → NoneMethod

Set U spans. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
spans int · default: —

node.set_v_spans(spans: int) → NoneMethod

Set V spans. This operates on staged definition data; it is not a native surface rebuild.

Item Type / behavior
Returns None
spans int · default: —
Methods inherited from DAGNode3
Method Returns Description
delete None Uses DGNode deletion.
finalize None Stores the dictionary and delegates replay to DGNode.finalize().
set_parent None Reparents the live node.
Methods inherited from DGNode3
Method Returns Description
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.
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.
Attribute Value / composition
NODE_TYPE 'nurbsSurface'
SPEC_LAYERS get_dg_specs_all, get_container_base_specs_all, get_dag_specs_all, get_geometry_shape_specs_all, get_control_point_specs_all, get_surface_shape_specs_all, get_surface_specs_all, get_curve_spec_overrides_map

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

Point Behavior
Identity A node recreated under the same name is a new Maya object.
Creation and geometry Creating an empty shape does not construct topology. The example below uses API 2.0 for geometry and the wrapper for documented operations.
Capture Snapshots can contain Maya objects; do not assume JSON-ready data or complete geometry reconstruction.
cvs The setter changes staged data and shape_orig data, without directly updating native CVs; it can fail without an intermediate shape. Use set_cv_positions() for live editing.
closest_point The space parameter is not passed to the function set. Native tolerance is also fixed to zero; do not assume a world-space query.
closest_param The space parameter is not passed to the function set. Native tolerance is also fixed to zero; do not assume a world-space query.
create The complete-definition path calls a native signature different from the tested example below. Creation from this definition is not validated here; the example explicitly creates API 2.0 geometry and then wraps it with Surface.
u_knots On a wrapper without a live surface, the setter calls .length() on the array. With the declared om.MDoubleArray type, this raises AttributeError in both tested versions.
v_knots On a wrapper without a live surface, the setter calls .length() on the array. With the declared om.MDoubleArray type, this raises AttributeError in both tested versions.
is_point_on_trimmed_region Tested call: AttributeError, because om.MFnNurbsSurface has no isPointOnTrimmedEdge() in either target version. This path does not produce a usable boolean.
get_param_at_point The function set is built from an MObject. A world-space query raises RuntimeError without an MDagPath, as reproduced on the test patch. Choose object space where the parameter supports it.
intersect The function set is built from an MObject. A world-space query raises RuntimeError without an MDagPath, as reproduced on the test patch. Choose object space where the parameter supports it.

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.dag.transform.lib import Transform
from weSkel.src.core.node.dag.surface.lib import Surface
parent = Transform("api_surface_" + uuid4().hex[:8])
try:
parent.create()
points = om.MPointArray([(0, 0, 0), (0, 0, 1), (1, 0, 0), (1, 0, 1)])
obj = om.MFnNurbsSurface().create(points, [0, 1], [0, 1], 1, 1,
om.MFnNurbsSurface.kOpen, om.MFnNurbsSurface.kOpen,
False, parent.mobject)
node = Surface(obj)
assert node.num_cvs_u == 2 and node.num_cvs_v == 2
point = node.get_point_at_param(0.5, 0.5)
assert isinstance(point, om.MPoint)
assert abs(node.area - 1.0) < 1e-6
print("Surface: native patch and parameter sampling OK")
finally:
parent.delete(snapshot=False)

Expected result : Surface: native patch and parameter sampling OK.

SDK checkpoint 87c3486. Member inventory and fixture reads checked in Maya 2025.3 and 2026.3; example executed in both versions. The example does not cover every method. Listed limitations remain in source; these checks do not validate the compiled package.