Skip to content
weSkelDOCUMENTATION
Documentation/API reference/Clamp

Clamp

Clamp the three components of a color or vector.

ClassAPI 2.0MATHS
objectNodeDGNodeClamp
from weSkel.src.core.node.dg.clamp.lib import Clamp

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

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

Signature : Clamp(node) → Clamp.

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

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

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

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

Properties inherited from DGNode15
Property Return type Access Description
dep_fn om.MFnDependencyNode R Live function set; unattached object when the node is missing.
uuid str | None R Live UUID, or the last staged value if still available.
name str | None R/W Live name, otherwise staged name.
absolute_name str | None R Absolute namespace name from MFnDependencyNode.absoluteName(); None without a node.
stripped_name str | None R/W Name without its namespace, or None when unnamed.
namespace str | None R/W Normalized namespace such as a:b; None at the root.
plugs Plugs | None R Live node plug manager; None otherwise.
is_valid_dep_fn bool R Function-set compatibility with the current MObject.
is_default_node bool R Whether this is a Maya default node; False without a node.
is_from_referenced_file bool R Whether the node comes from a referenced file; False without a node.
is_locked bool R/W Node lock, separate from plug locks.
is_shared bool R Shared state reported by Maya; False without a node.
plugin_name str | None R Associated Maya plugin name, possibly an empty string; None without a node.
affect_animation bool R Result of MFnDependencyNode.affectsAnimation(); False without a node.
type str | None R/W Live native type or staged type.
Properties inherited from Node10
Property Return type Access Description
mobject om.MObject R/W Live Maya object, or a null object.
mobject_handle om.MObjectHandle R/W Handle associated with the node.
api_type int | None R Maya API type identifier.
api_type_str str R API type name, for example "kTime".
exists bool R The wrapper currently has a live node.
is_null bool R The returned Maya object is null.
is_alive bool R The object exists with a valid, live handle.
is_valid_handle bool R Validity of the stored handle.
is_dag_node bool R Compatibility with om.MFn.kDagNode.
hash_code int R Maya handle hash.

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
input input _ValuePlugProxy · .value: tuple
input_b input.inputB _ValuePlugProxy · .value: float
input_g input.inputG _ValuePlugProxy · .value: float
input_r input.inputR _ValuePlugProxy · .value: float
max max _ValuePlugProxy · .value: tuple
max_b max.maxB _ValuePlugProxy · .value: float
max_g max.maxG _ValuePlugProxy · .value: float
max_r max.maxR _ValuePlugProxy · .value: float
min min _ValuePlugProxy · .value: tuple
min_b min.minB _ValuePlugProxy · .value: float
min_g min.minG _ValuePlugProxy · .value: float
min_r min.minR _ValuePlugProxy · .value: float
output output _ValuePlugProxy · .value: tuple
output_b output.outputB _ValuePlugProxy · .value: float
output_g output.outputG _ValuePlugProxy · .value: float
output_r output.outputR _ValuePlugProxy · .value: float
render_pass_mode renderPassMode _ValuePlugProxy · .value: int

node.inputNative spec

Access to native plug input.

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

node.input_bNative spec

Access to native plug input.inputB.

Item Type / behavior
Maya path input.inputB
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.input_b.value
Descriptor assignment node.input_b = value

node.input_gNative spec

Access to native plug input.inputG.

Item Type / behavior
Maya path input.inputG
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.input_g.value
Descriptor assignment node.input_g = value

node.input_rNative spec

Access to native plug input.inputR.

Item Type / behavior
Maya path input.inputR
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.input_r.value
Descriptor assignment node.input_r = value

node.maxNative spec

Access to native plug max.

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

node.max_bNative spec

Access to native plug max.maxB.

Item Type / behavior
Maya path max.maxB
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.max_b.value
Descriptor assignment node.max_b = value

node.max_gNative spec

Access to native plug max.maxG.

Item Type / behavior
Maya path max.maxG
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.max_g.value
Descriptor assignment node.max_g = value

node.max_rNative spec

Access to native plug max.maxR.

Item Type / behavior
Maya path max.maxR
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.max_r.value
Descriptor assignment node.max_r = value

node.minNative spec

Access to native plug min.

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

node.min_bNative spec

Access to native plug min.minB.

Item Type / behavior
Maya path min.minB
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.min_b.value
Descriptor assignment node.min_b = value

node.min_gNative spec

Access to native plug min.minG.

Item Type / behavior
Maya path min.minG
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.min_g.value
Descriptor assignment node.min_g = value

node.min_rNative spec

Access to native plug min.minR.

Item Type / behavior
Maya path min.minR
Property return _ValuePlugProxy · .value: float
Declared kind numeric:float
Declared default 0.0
Flags input, output, connectable, stored, keyable
Read node.min_r.value
Descriptor assignment node.min_r = value

node.outputNative spec

Access to native plug output.

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

node.output_bNative spec

Access to native plug output.outputB.

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

node.output_gNative spec

Access to native plug output.outputG.

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

node.output_rNative spec

Access to native plug output.outputR.

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

node.render_pass_modeNative spec

Access to native plug renderPassMode.

Item Type / behavior
Maya path renderPassMode
Property return _ValuePlugProxy · .value: int
Declared kind enum
Declared default 1
Flags input, output, connectable, stored, keyable
Native enum values 0 = Pass through, 1 = Apply to Render Passes, 2 = No Contribution, 3 = Write Shader Result to Beauty Passes
Read node.render_pass_mode.value
Descriptor assignment node.render_pass_mode = value
Specs inherited from DGNode6
Property Maya plug Returns Description
message message None Node message plug; used for connections, with no numeric value.
frozen frozen _ValuePlugProxy · .value: bool Native evaluation freeze state.
is_historically_interesting isHistoricallyInteresting _ValuePlugProxy · .value: int Node interest level in Maya history.
bin_membership binMembership _ValuePlugProxy · .value: str Maya bin membership.
caching_enabled caching _ValuePlugProxy · .value: bool Native node caching switch.
caching_node_state nodeState _ValuePlugProxy · .value: int Native nodeState evaluation state.

No additional public method; inherited methods remain available.

Methods inherited from DGNode7
Method Returns Description
create None Creates a missing node; does nothing if it already exists.
delete None Disconnects live connections, detaches the wrapper and deletes the node.
snapshot DGSnapshot Captures and stores an identity and spec-driven SVD dictionary.
snapshot_svd SVDSnapshot Captures Source / Value / Destinations for the requested list.
svd SVDView Returns a read-only live view of source, value and destinations; it is not a frozen capture.
finalize None Applies all sources, then undriven values, then destinations; enabled FSET dispatch follows.
clear_attr_cache None Clears this instance attribute cache; does not delete nodes or clear the global wrapper registry.
Methods inherited from Node2
Method Returns Description
has_fn(fn_type) bool Test compatibility with a Maya function set.
clear_node_registry() None Detach registered wrappers and clear their shared registry.
Attribute Value / composition
NODE_TYPE 'clamp'
SPEC_LAYERS get_dg_specs_all, get_clamp_specs_all

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 The constructor creates nothing; call create() before live operations.
Capture Snapshots can contain Maya objects; do not assume JSON-ready data or complete geometry reconstruction.

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
from weSkel.src.core.node.dg.clamp.lib import Clamp
node = Clamp("api_clamp_" + uuid4().hex[:8])
try:
node.create()
node.min = (0.0, 0.0, 0.0)
node.max = (1.0, 1.0, 1.0)
node.input = (-1.0, 0.5, 2.0)
assert all(abs(a-b)<1e-6 for a,b in zip(node.output.value, (0.0, 0.5, 1.0)))
print("Clamp: native evaluation OK")
finally:
node.delete(snapshot=False)

Expected result : Clamp: native evaluation OK.

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