Go to: Synopsis. Return value. Flags. MEL examples.
detachSurface [-caching boolean] [-constructionHistory boolean] [-direction int] [-keep boolean] [-name string] [-nodeState int] [-object boolean] [-parameter float] [-replaceOriginal boolean]
surface
detachSurface is undoable, queryable, and editable.
The detachSurface command detaches a surface into pieces, given a list
of parameter values and a direction. You can also specify which
pieces to keep and which to discard using the "-k" flag.
The names of the newly detached surface(s) are returned. If history
is on, the name of the resulting dependency node is also returned.
You can only detach in either U or V (not both) with a single detachSurface operation.
You can use this command to open a closed surface at a particular
parameter value. You would use this command with only one "-p" flag.
If you are specifying "-k" flags, then you must specify one, none
or all "-k" flags. If you are specifying all "-k" flags, there
must be one more "-k" flag than "-p" flags.
string[] | Object name and node name |
In query mode, return type is based on queried flag.
caching, constructionHistory, direction, keep, name, nodeState, object, parameter, replaceOriginal
Long name (short name) |
Argument types |
Properties |
|
-caching(-cch)
|
boolean
|
|
|
Toggle caching for all attributes so that no recomputation is needed
|
|
-direction(-d)
|
int
|
|
|
Direction in which to detach:
0 - V direction,
1 - U direction
Default: 1
|
|
-keep(-k)
|
boolean
|
|
|
Keep the detached pieces.
Default: true
|
|
-nodeState(-nds)
|
int
|
|
|
Maya dependency nodes have 6 possible states.
The Normal (0), HasNoEffect (1), and Blocking (2) states can be
used to alter how the graph is evaluated.
The Waiting-Normal (3), Waiting-HasNoEffect (4), Waiting-Blocking (5)
are for internal use only. They temporarily shut off parts of the graph during interaction
(e.g., manipulation). The understanding is that once the operation is done,
the state will be reset appropriately, e.g. Waiting-Blocking will reset
back to Blocking.
The Normal and Blocking cases apply to all nodes, while
HasNoEffect is node specific; many nodes do not support this option.
Plug-ins store state in the MPxNode::state attribute. Anyone can set
it or check this attribute. Additional details about each of these 3 states follow.
State |
Description |
Normal |
The normal node state. This is the default. |
HasNoEffect |
The HasNoEffect option (a.k.a. pass-through), is used in cases where
there is an operation on an input producing an output of the same data type.
Nearly all deformers support this state, as do a few other nodes.
As stated earlier, it is not supported by all nodes.
It’s typical to implement support for the HasNoEffect state in
the node’s compute method and to perform appropriate operations.
Plug-ins can also support HasNoEffect.
The usual implementation of this state is to copy the input directly to the
matching output without applying the algorithm in the node. For deformers,
applying this state leaves the input geometry undeformed on the output.
|
Blocking |
This is implemented in the depend node base class and applies to all nodes.
Blocking is applied during the evaluation phase to connections.
An evaluation request to a blocked connection will return as failures,
causing the destination plug to retain its current value. Dirty propagation
is indirectly affected by this state since blocked connections are never cleaned.
When a node is set to Blocking the behavior is supposed to be the same as
if all outgoing connections were broken. As long as nobody requests evaluation
of the blocked node directly it won’t evaluate after that. Note that a blocked
node will still respond to getAttr requests but a getAttr on a
downstream node will not reevaluate the blocked node.
Setting the root transform of a hierarchy to Blocking won’t automatically
influence child transforms in the hierarchy. To do this, you’d need to
explicitly set all child nodes to the Blocking state.
For example, to set all child transforms to Blocking, you could use the
following script.
import maya.cmds as cmds
def blockTree(root):
nodesToBlock = []
for node in {child:1 for child in cmds.listRelatives( root, path=True, allDescendents=True )}.keys():
nodesToBlock += cmds.listConnections(node, source=True, destination=True )
for node in {source:1 for source in nodesToBlock}.keys():
cmds.setAttr( '%s.nodeState' % node, 2 )
Applying this script would continue to draw objects but things would not be animated.
|
Default: kdnNormal
|
|
-parameter(-p)
|
float
|
|
|
Parameter at which to detach.
Default: 0.0
|
|
Common flags |
-constructionHistory(-ch)
|
boolean
|
|
|
Turn the construction history on or off.
|
|
-name(-n)
|
string
|
|
|
Sets the name of the newly-created node. If it contains
namespace path, the new node will be created under the
specified namespace; if the namespace does not exist, it
will be created.
|
|
-object(-o)
|
boolean
|
|
|
Create the result, or just the dependency node.
|
|
-replaceOriginal(-rpo)
|
boolean
|
|
|
Create "in place" (i.e., replace).
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
Flag can appear in Query mode of command
|
Flag can be used more than once in a command.
|
detachSurface -ch on -d 1 -p 0.3 -rpo off surface1;
detachSurface -ch on surface1.u[0.3];
// Detaches surface1 into two pieces at u = 0.3.
// The results are two surface pieces, and a detachSurface dependency node.
// Since no "-keep" flag is used, all pieces are kept.
detachSurface -ch on -k on -k off -rpo off -p 0.34 -d 0 surface1;
detachSurface -ch on -k on -k off -rpo off surface1.v[0.34];
// Detaches surface1 at v = 0.34. Because of the "-k" flags, two
// surfaces are created but the second surface is empty. A
// detachSurface dependency node is also returned.
detachSurface -ch on -rpo on -p 0.2 -p 0.5 -d 1 surface1;
detachSurface -ch on -rpo on surface1.u[0.2] surface1.u[0.5];
// Detaches surface1 into three pieces. Because of the "-rpo" flag,
// the first surface piece is used to replace the original surface1.
// The results are the three surfaces (including the original surface).
// Even though the "-ch" flag is on, a dependency node is not created
// if surface1 is not a result of construction history. If surface1
// is the result of construction history, then a dependency node is
// created and its name is returned.
detachSurface -ch on -d 0 -p 0.3 -rpo off cylinder1;
// Detaches cylinder1, which is periodic in V, where the V parameter
// ranges between 0.0 and 8.0. The parameter, 0.3, is used to move
// the start point of the cylinder, also known as the "seam".
// The resulting surface's V parameter range is 0.0 to 0.3.
detachSurface -ch on -d 0 -p 0.3 -p 0.7 -rpo off cylinder1;
// Detaches cylinder1, which is periodic in V, where the V parameter
// ranges between 0.0 and 8.0. The 1st parameter, 0.3, is used to move
// the start point of the cylinder, also known as the "seam".
// The second parameter, 0.7, is used to detach the cylinder again.
// The result is only TWO surfaces; the first surface's V parameter ranges
// from 0.0 to 0.3. The second surface's V parameter ranges from 0.3 to 0.7.