pymel.core.nodetypes.Wire

class Wire(*args, **kwargs)

class counterpart of mel function wire

This command creates a wire deformer.In the create mode the selection list is treated as the object(s) to be deformed, Wires are specified with the -w flag. Each wire can optionally have a holder which helps define the the regon of the object that is affected by the deformer.

addGeometry(object)

Adds a piece of geometry to the deformation.

Parameters :

object : PyNode

the geometry

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.addGeometry

Undo is not currently supported for this method

addWire(object)

Adds a new wire curve to the deformation.

Parameters :

object : PyNode

the new wire

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.addWire

Undo is not currently supported for this method

after(val=True, **kwargs)

If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).

Derived from mel command maya.cmds.wire

afterReference(val=True, **kwargs)

The -afterReference flag is used to specify deformer ordering in a hybrid way that choses between -before and -after automatically. If the geometry being deformed is referenced then -after mode is used in adding the new deformer otherwise -before mode is used. The net effect when using -afterReference to build deformer chains is that internal shape nodes in the deformer chain will only appear at reference file boundaries, leading to lightweight deformer networks that may be more amicable to reference swapping.

Derived from mel command maya.cmds.wire

before(val=True, **kwargs)

If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).

Derived from mel command maya.cmds.wire

frontOfChain(val=True, **kwargs)

This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and skin nodes in the shape’s history (but not ahead of existing tweak nodes). The input to the deformer will be the upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and edit mode if the deformer has no geometry added yet).

Derived from mel command maya.cmds.wire

getAffectedGeometry()

The geometry affected by this deformer is packed into the provided list of MObjects. Each of the MObjects will be a DAG node that has geometry.

Return type:PyNode list

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.getAffectedGeometry

getCrossingEffect()

Returns the crossing effect for this wire deformer.

Return type:float

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.crossingEffect

getDeformerTools(**kwargs)

Returns the name of the deformer tool objects (if any) as string string ...

Derived from mel command maya.cmds.wire

getDropoffDistance(**kwargs)

Set the dropoff distance (second parameter) for the wire at index (first parameter).

Derived from mel command maya.cmds.wire

getExclusive(**kwargs)

Puts the deformation set in a deform partition.

Derived from mel command maya.cmds.wire

getGeometry(**kwargs)

The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is also specified. When queried, this flag returns string string string ...

Derived from mel command maya.cmds.wire

getGeometryIndices(**kwargs)

Complements the -geometry flag in query mode. Returns the multi index of each geometry.

Derived from mel command maya.cmds.wire

getHolder(**kwargs)

Set the specified curve or surface (second parameter as a holder for the wire at index (first parameter).

Derived from mel command maya.cmds.wire

getHoldingShape(wireIndex)

Returns the holding shape for the given wire. The holding shape may be a nurbs curve or a nurbs surface. If the given wire does not have a holding shape, then a null MObject handle will be returned.

Parameters :

wireIndex : int

index of wire to get the holding shape for

Return type:

PyNode

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.holdingShape

getLocalInfluence(**kwargs)

Set the local control a wire has with respect to other wires irrespective of whether it is deforming the surface. Varies from no local effect at 0 to full local control at 1. Default is 0.

Derived from mel command maya.cmds.wire

getLocalIntensity()

Returns the local intensity for this wire deformer.

Return type:float

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.localIntensity

getRotation()

Returns the rotation value for this deformer.

Return type:float

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.rotation

getWire(**kwargs)

Specify or query the wire curve name.

Derived from mel command maya.cmds.wire

getWireCount(**kwargs)

Set the number of wires.

Derived from mel command maya.cmds.wire

getWireDropOffDistance(wireIndex)

Return the drop off distance of the wire at the given index. Increasing this value will give the wire a greater area of influence.

Parameters :

wireIndex : int

index of wire to return the drop off distance for

Return type:

float

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.wireDropOffDistance

getWireScale(wireIndex)

Return the radial scale of the wire at the given index. The scale value affects how the wire modifies the geometry in its area of influence. A value of between 0.0 and 1.0 causes the wire to pull the surrounding geometry points towards itself. A value of greater than one causes the wire to repulse the geometry points around it. A value of exactly 1.0 causes the wire to neither pull nor push the points around it.

Parameters :

wireIndex : int

index of wire to return the scale value for

Return type:

float

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.wireScale

numDropoffLocators(wireIndex)

Returns the number of drop off locators.

Parameters :

wireIndex : int

the index of the wire curve to query

Return type:

int

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.numDropoffLocators

numWires()

returns the number of wire curves connected to this deformer.

Return type:int

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.numWires

parallel(val=True, **kwargs)

Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry added yet).

Derived from mel command maya.cmds.wire

prune(val=True, **kwargs)

Removes any points not being deformed by the deformer in its current configuration from the deformer set.

Derived from mel command maya.cmds.wire

remove(val=True, **kwargs)

Specifies that objects listed after the -g flag should be removed from this deformer.

Derived from mel command maya.cmds.wire

removeGeometry(object)

Removes a piece of geometry from the deformation.

Parameters :

object : PyNode

the geometry

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.removeGeometry

Undo is not currently supported for this method

setCrossingEffect(crossingEffect)

Sets the crossing effect for this wire deformer.

Parameters :

crossingEffect : float

New crossing effect value

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.setCrossingEffect

setDropoffDistance(val=True, **kwargs)

Set the dropoff distance (second parameter) for the wire at index (first parameter).

Derived from mel command maya.cmds.wire

setGeometry(val=True, **kwargs)

The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is also specified. When queried, this flag returns string string string ...

Derived from mel command maya.cmds.wire

setHolder(val=True, **kwargs)

Set the specified curve or surface (second parameter as a holder for the wire at index (first parameter).

Derived from mel command maya.cmds.wire

setHoldingShape(wireIndex, holdingShape)

Sets the holding shape for the given wire. The holding shape may be a nurbs curve or a nurbs surface.

Parameters :

wireIndex : int

index of wire to set the holding shape for

holdingShape : PyNode

nurbs curve or surface to use as holding shape

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.setHoldingShape

setLocalInfluence(val=True, **kwargs)

Set the local control a wire has with respect to other wires irrespective of whether it is deforming the surface. Varies from no local effect at 0 to full local control at 1. Default is 0.

Derived from mel command maya.cmds.wire

setLocalIntensity(localIntensity)

Sets the local intensity for this wire deformer.

Parameters :

localIntensity : float

New local intensity value

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.setLocalIntensity

setRotation(rotation)

Sets the rotation value for this deformer.

Parameters :

rotation : float

new rotation value

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.setRotation

setWire(val=True, **kwargs)

Specify or query the wire curve name.

Derived from mel command maya.cmds.wire

setWireCount(val=True, **kwargs)

Set the number of wires.

Derived from mel command maya.cmds.wire

setWireDropOffDistance(wireIndex, dropOff)

Sets the drop off distance of the wire at the given index. Increasing this value will give the wire a greater area of influence.

Parameters :

wireIndex : int

index of wire to set the drop off distance for

dropOff : float

new drop off value

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.setWireDropOffDistance

setWireScale(wireIndex, scale)

Sets the radial scale value of the wire at the given index. The scale value affects how the wire modifies the geometry in its area of influence. A value of between 0.0 and 1.0 causes the wire to pull the surrounding geometry points towards itself. A value of greater than one causes the wire to repulse the geometry points around it. A value of exactly 1.0 causes the wire to neither pull nor push the points around it.

Parameters :

wireIndex : int

index of wire to set the drop off distance for

scale : float

new scale value

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.setWireScale

wire(wireIndex)

Return the wire at the given index. The returned object will be a nurbs curve shape suitable for use with the MFnNurbsCurve function set.

Parameters :

wireIndex : int

index of wire to return

Return type:

PyNode

Derived from api method maya.OpenMayaAnim.MFnWireDeformer.wire