from weSkel.src.core.node.abstract.surface_shape.lib import SurfaceShapeIn Maya or in a Python script run by Maya / initialized mayapy, with weSkel available. Importing om is only required when using OpenMaya types in your own code.
Properties shared by surfaces and meshes.
from weSkel.src.core.node.abstract.surface_shape.lib import SurfaceShapeIn Maya or in a Python script run by Maya / initialized mayapy, with weSkel available. Importing om is only required when using OpenMaya types in your own code.
| Item | Value |
|---|---|
| Class | SurfaceShape |
| Module | weSkel.src.core.node.abstract.surface_shape.lib |
| Direct parent | ControlPoint |
| Represented direct descendants | Mesh, Surface |
| Own members | 0 Python properties + 27 spec properties; 0 methods defined or overridden here. |
Parent members remain available. Each section includes collapsible tables grouped by parent class, with links to the full contracts. Private methods and standard Python mechanisms are outside this inventory.
Signature : SurfaceShape(node) → SurfaceShape or an already registered compatible subclass.
| Parameter | Accepted types | Default |
|---|---|---|
node |
str, om.MObject, om.MObjectHandle, om.MFnDependencyNode, om.MDagPath, om.MFnDagNode |
Required |
Wraps an existing node or stages a wrapper if the name is unresolved; creates no node. For another wrapper, pass other.mobject. The shared registry preserves identity and may return the existing concrete wrapper. Incompatible input can raise TypeError, and identity conflicts RuntimeError.
This base has an abstract NODE_TYPE. Descendant type recognition depends on concrete classes already imported. Import and use Mesh, Curve or Surface as appropriate; the bottom example shows base access after importing the concrete wrapper. Do not call .create() to instantiate the abstract type.
Python properties defined on this class. om means maya.api.OpenMaya. Spec-generated properties are detailed in the following section.
No additional Python properties: this class adds the spec properties below and inherits its parent properties.
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. |
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. |
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. |
Python and Maya names are reproduced exactly. Declared kind, Python return and declared default are different facts. A spec default is not necessarily the live node value, nor a value automatically written at creation.
The returns below describe this class descriptors; live observations use a network, container, transform, mesh or skinCluster as appropriate. Some plugs depend on the concrete type. A subclass may override a member and its write capabilities. Proxy names identify current results: do not import their private classes.
| Form | Usage |
|---|---|
_ValuePlugProxy |
.value reads the value; .plug gives a Plug, .mplug an MPlug. |
IndexedPathProxy |
Indexed access object. Resolution has limitations at this checkpoint: member cards provide verified alternatives using node.plugs[...]. |
| Flags / writing | stored, input, output, connectable describe the replay contract. They do not guarantee a native plug is editable in its current state. |
For writes where failure must be checked, use the Plug explicitly and verify live state: some descriptor setters can stage a value without propagating a Maya write error.
| Property | Maya plug | Returns |
|---|---|---|
bounding_box_scale |
boundingBoxScale |
_ValuePlugProxy · .value: tuple[float, float, float] |
bounding_box_scale_x |
boundingBoxScale.boundingBoxScaleX |
_ValuePlugProxy · .value: float |
bounding_box_scale_y |
boundingBoxScale.boundingBoxScaleY |
_ValuePlugProxy · .value: float |
bounding_box_scale_z |
boundingBoxScale.boundingBoxScaleZ |
_ValuePlugProxy · .value: float |
display_hw_environment |
displayHWEnvironment |
_ValuePlugProxy · .value: bool |
hold_out |
holdOut |
_ValuePlugProxy · .value: bool |
smooth_shading |
smoothShading |
_ValuePlugProxy · .value: bool |
feature_displacement |
featureDisplacement |
_ValuePlugProxy · .value: bool |
texture_treshold |
textureTreshold |
_ValuePlugProxy · .value: int |
ignore_hw_shader |
ignoreHwShader |
_ValuePlugProxy · .value: bool |
normal_treshold |
normalTreshold |
_ValuePlugProxy · .value: float |
double_sided |
doubleSided |
_ValuePlugProxy · .value: bool |
opposite |
opposite |
_ValuePlugProxy · .value: bool |
initial_sample_rate |
initialSampleRate |
_ValuePlugProxy · .value: int |
extra_sample_rate |
extraSampleRate |
_ValuePlugProxy · .value: int |
collision_depth_velocity_increment |
collisionDepthVelocityIncrement |
ArrayCompoundProxy |
collision_depth_velocity_increment_position |
collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_Position |
IndexedPathProxy |
collision_depth_velocity_increment_float_value |
collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_FloatValue |
IndexedPathProxy |
collision_depth_velocity_increment_interp |
collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_Interp |
IndexedPathProxy |
collision_depth_velocity_multiplier |
collisionDepthVelocityMultiplier |
ArrayCompoundProxy |
collision_depth_velocity_multiplier_position |
collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_Position |
IndexedPathProxy |
collision_depth_velocity_multiplier_float_value |
collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_FloatValue |
IndexedPathProxy |
collision_depth_velocity_multiplier_interp |
collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_Interp |
IndexedPathProxy |
collision_offset_velocity_multiplier |
collisionOffsetVelocityMultiplier |
ArrayCompoundProxy |
collision_offset_velocity_multiplier_position |
collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_Position |
IndexedPathProxy |
collision_offset_velocity_multiplier_float_value |
collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_FloatValue |
IndexedPathProxy |
collision_offset_velocity_multiplier_interp |
collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_Interp |
IndexedPathProxy |
Native surface bounding-box scale.
| Item | Type / behavior |
|---|---|
| Declared Maya path | boundingBoxScale |
| Property return | _ValuePlugProxy · .value: tuple[float, float, float] |
| Declared spec kind | float3 |
| Declared default | (1.5, 1.5, 1.5) |
| Flags | input, output, connectable, stored |
| Read the value | node.bounding_box_scale.value |
| Assignment | node.bounding_box_scale = value |
X component of bounding_box_scale.
| Item | Type / behavior |
|---|---|
| Declared Maya path | boundingBoxScale.boundingBoxScaleX |
| Property return | _ValuePlugProxy · .value: float |
| Declared spec kind | numeric:float |
| Declared default | 1.5 |
| Flags | input, output, connectable, stored |
| Read the value | node.bounding_box_scale_x.value |
| Assignment | node.bounding_box_scale_x = value |
Y component of bounding_box_scale.
| Item | Type / behavior |
|---|---|
| Declared Maya path | boundingBoxScale.boundingBoxScaleY |
| Property return | _ValuePlugProxy · .value: float |
| Declared spec kind | numeric:float |
| Declared default | 1.5 |
| Flags | input, output, connectable, stored |
| Read the value | node.bounding_box_scale_y.value |
| Assignment | node.bounding_box_scale_y = value |
Z component of bounding_box_scale.
| Item | Type / behavior |
|---|---|
| Declared Maya path | boundingBoxScale.boundingBoxScaleZ |
| Property return | _ValuePlugProxy · .value: float |
| Declared spec kind | numeric:float |
| Declared default | 1.5 |
| Flags | input, output, connectable, stored |
| Read the value | node.bounding_box_scale_z.value |
| Assignment | node.bounding_box_scale_z = value |
Hardware environment display.
| Item | Type / behavior |
|---|---|
| Declared Maya path | displayHWEnvironment |
| Property return | _ValuePlugProxy · .value: bool |
| Declared spec kind | numeric:bool |
| Declared default | False |
| Flags | input, output, connectable, stored, hidden |
| Read the value | node.display_hw_environment.value |
| Assignment | node.display_hw_environment = value |
Native holdout option.
| Item | Type / behavior |
|---|---|
| Declared Maya path | holdOut |
| Property return | _ValuePlugProxy · .value: bool |
| Declared spec kind | numeric:bool |
| Declared default | False |
| Flags | input, output, connectable, stored |
| Read the value | node.hold_out.value |
| Assignment | node.hold_out = value |
Smooth shading switch.
| Item | Type / behavior |
|---|---|
| Declared Maya path | smoothShading |
| Property return | _ValuePlugProxy · .value: bool |
| Declared spec kind | numeric:bool |
| Declared default | True |
| Flags | input, output, connectable, stored |
| Read the value | node.smooth_shading.value |
| Assignment | node.smooth_shading = value |
Native feature-displacement option.
| Item | Type / behavior |
|---|---|
| Declared Maya path | featureDisplacement |
| Property return | _ValuePlugProxy · .value: bool |
| Declared spec kind | numeric:bool |
| Declared default | True |
| Flags | input, output, connectable, stored |
| Read the value | node.feature_displacement.value |
| Assignment | node.feature_displacement = value |
Native textureTreshold threshold; API spelling preserved.
| Item | Type / behavior |
|---|---|
| Declared Maya path | textureTreshold |
| Property return | _ValuePlugProxy · .value: int |
| Declared spec kind | numeric:int |
| Declared default | 0 |
| Flags | input, output, connectable, stored |
| Read the value | node.texture_treshold.value |
| Assignment | node.texture_treshold = value |
Ignore-hardware-shader option.
| Item | Type / behavior |
|---|---|
| Declared Maya path | ignoreHwShader |
| Property return | _ValuePlugProxy · .value: bool |
| Declared spec kind | numeric:bool |
| Declared default | False |
| Flags | input, output, connectable, stored |
| Read the value | node.ignore_hw_shader.value |
| Assignment | node.ignore_hw_shader = value |
Native normalTreshold threshold; API spelling preserved.
| Item | Type / behavior |
|---|---|
| Declared Maya path | normalTreshold |
| Property return | _ValuePlugProxy · .value: float |
| Declared spec kind | numeric:float |
| Declared default | 30.0 |
| Flags | input, output, connectable, stored |
| Read the value | node.normal_treshold.value |
| Assignment | node.normal_treshold = value |
Double-sided display / rendering option.
| Item | Type / behavior |
|---|---|
| Declared Maya path | doubleSided |
| Property return | _ValuePlugProxy · .value: bool |
| Declared spec kind | numeric:bool |
| Declared default | True |
| Flags | input, output, connectable, stored |
| Read the value | node.double_sided.value |
| Assignment | node.double_sided = value |
Shape orientation reversal.
| Item | Type / behavior |
|---|---|
| Declared Maya path | opposite |
| Property return | _ValuePlugProxy · .value: bool |
| Declared spec kind | numeric:bool |
| Declared default | False |
| Flags | input, output, connectable, stored |
| Read the value | node.opposite.value |
| Assignment | node.opposite = value |
Initial surface sampling rate.
| Item | Type / behavior |
|---|---|
| Declared Maya path | initialSampleRate |
| Property return | _ValuePlugProxy · .value: int |
| Declared spec kind | numeric:int |
| Declared default | 6 |
| Flags | input, output, connectable, stored |
| Read the value | node.initial_sample_rate.value |
| Assignment | node.initial_sample_rate = value |
Additional sampling rate.
| Item | Type / behavior |
|---|---|
| Declared Maya path | extraSampleRate |
| Property return | _ValuePlugProxy · .value: int |
| Declared spec kind | numeric:int |
| Declared default | 5 |
| Flags | input, output, connectable, stored |
| Read the value | node.extra_sample_rate.value |
| Assignment | node.extra_sample_rate = value |
Native collision-depth velocity increment ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionDepthVelocityIncrement |
| Property return | ArrayCompoundProxy |
| Declared spec kind | array:compound |
| Declared default | None |
| Flags | array, input, output, connectable, stored |
| Plug access | node.collision_depth_velocity_increment.plug |
The property returns a structure. Edit an explicit child or use Plug operations; do not replace the proxy with a Python assignment.
Position of a point on the collision_depth_velocity_increment ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_Position |
| Property return | IndexedPathProxy |
| Declared spec kind | numeric:float |
| Declared default | 0.0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionDepthVelocityIncrement"][i1]["collisionDepthVelocityIncrement_Position"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
Value of a point on the collision_depth_velocity_increment ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_FloatValue |
| Property return | IndexedPathProxy |
| Declared spec kind | numeric:float |
| Declared default | 0.0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionDepthVelocityIncrement"][i1]["collisionDepthVelocityIncrement_FloatValue"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
Interpolation of a point on the collision_depth_velocity_increment ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionDepthVelocityIncrement[].collisionDepthVelocityIncrement_Interp |
| Property return | IndexedPathProxy |
| Declared spec kind | enum |
| Declared default | 0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionDepthVelocityIncrement"][i1]["collisionDepthVelocityIncrement_Interp"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
Native collision-depth velocity multiplier ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionDepthVelocityMultiplier |
| Property return | ArrayCompoundProxy |
| Declared spec kind | array:compound |
| Declared default | None |
| Flags | array, input, output, connectable, stored |
| Plug access | node.collision_depth_velocity_multiplier.plug |
The property returns a structure. Edit an explicit child or use Plug operations; do not replace the proxy with a Python assignment.
Position of a point on the collision_depth_velocity_multiplier ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_Position |
| Property return | IndexedPathProxy |
| Declared spec kind | numeric:float |
| Declared default | 0.0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionDepthVelocityMultiplier"][i1]["collisionDepthVelocityMultiplier_Position"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
Value of a point on the collision_depth_velocity_multiplier ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_FloatValue |
| Property return | IndexedPathProxy |
| Declared spec kind | numeric:float |
| Declared default | 0.0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionDepthVelocityMultiplier"][i1]["collisionDepthVelocityMultiplier_FloatValue"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
Interpolation of a point on the collision_depth_velocity_multiplier ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionDepthVelocityMultiplier[].collisionDepthVelocityMultiplier_Interp |
| Property return | IndexedPathProxy |
| Declared spec kind | enum |
| Declared default | 0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionDepthVelocityMultiplier"][i1]["collisionDepthVelocityMultiplier_Interp"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
Native collision-offset velocity multiplier ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionOffsetVelocityMultiplier |
| Property return | ArrayCompoundProxy |
| Declared spec kind | array:compound |
| Declared default | None |
| Flags | array, input, output, connectable, stored |
| Plug access | node.collision_offset_velocity_multiplier.plug |
The property returns a structure. Edit an explicit child or use Plug operations; do not replace the proxy with a Python assignment.
Position of a point on the collision_offset_velocity_multiplier ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_Position |
| Property return | IndexedPathProxy |
| Declared spec kind | numeric:float |
| Declared default | 0.0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionOffsetVelocityMultiplier"][i1]["collisionOffsetVelocityMultiplier_Position"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
Value of a point on the collision_offset_velocity_multiplier ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_FloatValue |
| Property return | IndexedPathProxy |
| Declared spec kind | numeric:float |
| Declared default | 0.0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionOffsetVelocityMultiplier"][i1]["collisionOffsetVelocityMultiplier_FloatValue"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
Interpolation of a point on the collision_offset_velocity_multiplier ramp.
| Item | Type / behavior |
|---|---|
| Declared Maya path | collisionOffsetVelocityMultiplier[].collisionOffsetVelocityMultiplier_Interp |
| Property return | IndexedPathProxy |
| Declared spec kind | enum |
| Declared default | 0 |
| Flags | input, output, connectable, stored |
| Indices | 1 logical index(es), in the order of [] in the Maya path. |
| Verified alternative · returns a Plug | node.plugs["collisionOffsetVelocityMultiplier"][i1]["collisionOffsetVelocityMultiplier_Interp"] |
Current limitation: descriptor resolution raises AttributeError in the verified case. Use the explicit path above with logical indices. The resulting Plug can then read .value or manage connections.
ControlPoint32| 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. |
tweak |
tweak |
_ValuePlugProxy · .value: bool |
Native tweak state. |
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. |
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. |
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. |
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. |
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. |
No new public methods on this class. Use inherited methods below; an abstract base does not provide a new creatable Maya type.
DAGNode5| Method | Returns | Description |
|---|---|---|
create |
None |
Creates a missing DAG node with its optional staged parent. |
delete |
None |
Uses DGNode deletion. |
snapshot |
DAGSnapshot |
Extends the DG dictionary with parent (partial path) and parent_long_name (full path), using schema_version="dag-1.0". |
finalize |
None |
Stores the dictionary and delegates replay to DGNode.finalize(). |
set_parent |
None |
Reparents the live node. |
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. |
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 | Type | Value / role |
|---|---|---|
NODE_TYPE |
str | None |
"surfaceShape" |
SPEC_LAYERS |
list[SpecLayer] |
Parent layers + get_surface_shape_specs_all |
Attributes defined or overridden here. NODE_REGISTRY is inherited from Node. COMPATIBLE_MAYA_FN_TYPES is inherited; for a class with explicit NODE_TYPE, its use also depends on the compatibility policy described under Constructor.
The SurfaceShapeSnapshot types exported by these modules are TypedDict descriptions, not classes to instantiate for capture. Use node.snapshot().
| Point | Behavior |
|---|---|
| Identity | The wrapper follows the Maya object; a replacement with the same name is not the same node. |
| Reading | Live reads take priority; check exists before native operations. |
| Specs | Describe existing plugs; do not automatically add Maya attributes. |
| Examples | The demonstration creates and deletes only its own nodes with a random name suffix. |
Self-contained example for the Maya Python Script Editor. To run it in mayapy, initialize maya.standalone before this block and shut it down afterwards, as shown in the Node.
The demonstration shape is an empty mesh: this tests the inherited property, not topology creation.
from uuid import uuid4from weSkel.src.core.node.abstract.surface_shape.lib import SurfaceShapefrom weSkel.src.core.node.dag.mesh.lib import Meshfrom weSkel.src.core.node.dag.transform.lib import Transform
prefix = "api_shape_" + uuid4().hex[:8]parent = Transform(prefix + "_parent")node = Mesh(prefix + "Shape")try: parent.create() node.parent = parent node.create() assert SurfaceShape(node.mobject) is node node.double_sided = False assert node.double_sided.value is False print("SurfaceShape: inherited shape property OK")finally: node.delete(snapshot=False) parent.delete(snapshot=False)Expected result : SurfaceShape: inherited shape property OK. Demonstration nodes are removed in finally.
SDK checkpoint 87c3486 reference. Inventory and examples checked against source under Maya 2025.3 and 2026.3; this does not validate the compiled package.