Public Member Functions | Protected Member Functions

MFnWireDeformer Class Reference

Search for all occurrences

Detailed Description

wire deformer function set

MFnWireDeformer is the function set for wire deformers. Wire deformers modify geometry based on its proximity to controlling wire curves. As the wire curves are modified, the parts of the geometry close to the curve will follow.

The wire deformer is actually a small network of dependency nodes in the dependency graph. This function set is provided to make manipulation of the network easier. The main deformer node should be given to this function set as its object.

#include <MFnWireDeformer.h>

Inheritance diagram for MFnWireDeformer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnWireDeformer ()
 Destructor.
 MFnWireDeformer ()
 Default constructor.
 MFnWireDeformer (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 Creates a new wire deformer.
MStatus addGeometry (const MObject &object)
 Adds a piece of geometry to the deformation.
MStatus removeGeometry (const MObject &object)
 Removes a piece of geometry from the deformation.
MStatus getAffectedGeometry (MObjectArray &objects)
 The geometry affected by this deformer is packed into the provided list of MObjects.
unsigned int numWires (MStatus *ReturnStatus=NULL) const
 returns the number of wire curves connected to this deformer.
MStatus addWire (const MObject &object)
 Adds a new wire curve to the deformation.
MObject wire (unsigned int wireIndex, MStatus *ReturnStatus=NULL)
 Return the wire at the given index.
float wireDropOffDistance (unsigned int wireIndex, MStatus *ReturnStatus=NULL) const
 Return the drop off distance of the wire at the given index.
MStatus setWireDropOffDistance (unsigned int wireIndex, float dropOff)
 Sets the drop off distance of the wire at the given index.
float wireScale (unsigned int wireIndex, MStatus *ReturnStatus=NULL) const
 Return the radial scale of the wire at the given index.
MStatus setWireScale (unsigned int wireIndex, float scale)
 Sets the radial scale value of the wire at the given index.
MObject holdingShape (unsigned int wireIndex, MStatus *ReturnStatus=NULL) const
 Returns the holding shape for the given wire.
MStatus setHoldingShape (unsigned int wireIndex, MObject holdingCurve)
 Sets the holding shape for the given wire.
float envelope (MStatus *ReturnStatus=NULL) const
 Returns the envelope for this deformer.
MStatus setEnvelope (float envelope)
 Sets the envelope for this deformer.
float rotation (MStatus *ReturnStatus=NULL) const
 Returns the rotation value for this deformer.
MStatus setRotation (float rotation)
 Sets the rotation value for this deformer.
float localIntensity (MStatus *ReturnStatus=NULL) const
 Returns the local intensity for this wire deformer.
MStatus setLocalIntensity (float localIntensity)
 Sets the local intensity for this wire deformer.
float crossingEffect (MStatus *ReturnStatus=NULL) const
 Returns the crossing effect for this wire deformer.
MStatus setCrossingEffect (float crossingEffect)
 Sets the crossing effect for this wire deformer.
unsigned int numDropoffLocators (unsigned int wireIndex, MStatus *ReturnStatus=NULL) const
 Returns the number of drop off locators.
MStatus setDropoffLocator (unsigned int wireIndex, unsigned int locatorIndex, float param, float percentage)
 Sets the parameters of a drop off locator.
MStatus getDropoffLocator (unsigned int wireIndex, unsigned int locatorIndex, float &param, float &percentage)
 Gets the parameters of a drop off locator.
 MFnWireDeformer (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnWireDeformer ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnWireDeformer ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kWire.

Reimplemented from MFnDependencyNode.

const char * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnWireDeformer".

Reimplemented from MFnDependencyNode.

MObject create ( MStatus ReturnStatus = NULL)

Creates a new wire deformer.

This function set's object is set to be the new wire deformer node.

Parameters:
[out]ReturnStatusreturn status
Returns:
Returns a handle to the new deformer
Status Codes:
MStatus addGeometry ( const MObject object)

Adds a piece of geometry to the deformation.

After adding new geometry to the deformation. The new geometry will then be deformed by the existing wires.

Parameters:
[in]objectthe geometry
Returns:
Return status
Status Codes:
MStatus removeGeometry ( const MObject object)

Removes a piece of geometry from the deformation.

Parameters:
[in]objectthe geometry
Returns:
Return status
Status Codes:
MStatus getAffectedGeometry ( MObjectArray objects)

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.

Parameters:
[out]objectsstorage for the returned array
Returns:
Return status
Status Codes:
unsigned int numWires ( MStatus ReturnStatus = NULL) const

returns the number of wire curves connected to this deformer.

Parameters:
[out]ReturnStatusreturn status
Returns:
The number of wires
Status Codes:
MStatus addWire ( const MObject object)

Adds a new wire curve to the deformation.

Parameters:
[in]objectthe new wire
Returns:
Return status
Status Codes:
MObject wire ( unsigned int  wireIndex,
MStatus ReturnStatus = NULL 
)

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:
[in]wireIndexindex of wire to return
[out]ReturnStatusreturn status
Returns:
A handle to the given wire curve
Status Codes:
float wireDropOffDistance ( unsigned int  wireIndex,
MStatus ReturnStatus = NULL 
) const

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:
[in]wireIndexindex of wire to return the drop off distance for
[out]ReturnStatusreturn status
Returns:
The drop off distance
Status Codes:
MStatus setWireDropOffDistance ( unsigned int  wireIndex,
float  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:
[in]wireIndexindex of wire to set the drop off distance for
[in]dropOffnew drop off value
Returns:
Return status
Status Codes:
float wireScale ( unsigned int  wireIndex,
MStatus ReturnStatus = NULL 
) const

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.

The surrounding points will always deform with the wire, The scale factor just allows the points around the wire to be radially scaled closer to or further from the wire.

Parameters:
[in]wireIndexindex of wire to return the scale value for
[out]ReturnStatusreturn status
Returns:
The radial scale value
Status Codes:
MStatus setWireScale ( unsigned int  wireIndex,
float  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.

The surrounding points will always deform with the wire, The scale factor just allows the points around the wire to be radially scaled closer to or further from the wire.

Parameters:
[in]wireIndexindex of wire to set the drop off distance for
[in]scalenew scale value
Returns:
Return status
Status Codes:
MObject holdingShape ( unsigned int  wireIndex,
MStatus ReturnStatus = NULL 
) const

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.

A holding shape pins down the deforming shapes when the associated wire is moved. One possible application is to use a curve to limit the area that a wire affects.

Parameters:
[in]wireIndexindex of wire to get the holding shape for
[out]ReturnStatusreturn status
Returns:
Return status
Status Codes:
MStatus setHoldingShape ( unsigned int  wireIndex,
MObject  holdingShape 
)

Sets the holding shape for the given wire.

The holding shape may be a nurbs curve or a nurbs surface.

A holding shape pins down the deforming shapes when the associated wire is moved. One possible application is to use a curve to limit the area that a wire affects.

Parameters:
[in]wireIndexindex of wire to set the holding shape for
[in]holdingShapenurbs curve or surface to use as holding shape
Returns:
Return status
Status Codes:
float envelope ( MStatus ReturnStatus = NULL) const

Returns the envelope for this deformer.

The envelope is a scale factor that affects the dropoff distances of all wires that belong to this deformer.

Parameters:
[in]ReturnStatusreturn status
Returns:
The envelope value
Status Codes:
MStatus setEnvelope ( float  envelope)

Sets the envelope for this deformer.

The envelope is a scale factor that affects the dropoff distances of all wires that belong to this deformer.

Parameters:
[in]envelopeenvelope value
Returns:
Return status
Status Codes:
float rotation ( MStatus ReturnStatus = NULL) const

Returns the rotation value for this deformer.

The rotation value determines how much the tangency of the wire curve affects the deformation. When the rotation value is 0.0, the deformation will be linear. The geometry will pull straight towards the wire. When the rotation value is 1.0, the tangency of the wire curve is taken into effect. This will provide more natural deformations when the wire curve is twisted with respect to its original position. The surface will pull towards the wire in an arc rather than in a straight line.

Parameters:
[out]ReturnStatusreturn status
Returns:
The rotation value
Status Codes:
MStatus setRotation ( float  rotation)

Sets the rotation value for this deformer.

The rotation value determines how much the tangency of the wire curve affects the deformation. When the rotation value is 0.0, the deformation will be linear. The geometry will pull straight towards the wire. When the rotation value is 1.0, the tangency of the wire curve is taken into effect. This will provide more natural deformations when the wire curve is twisted with respect to its original position. The surface will pull towards the wire in an arc rather than in a straight line.

Parameters:
[in]rotationnew rotation value
Returns:
Return status
Status Codes:
float localIntensity ( MStatus ReturnStatus = NULL) const

Returns the local intensity for this wire deformer.

The local intensity has an effect when two wire curves are positioned close to each other. Normally, only the most deformed of the two curves will affect the surface. When the local intensity is increased, the less deformed curve will start to pull the surface back towards itself.

Parameters:
[out]ReturnStatusreturn status
Returns:
The local intensity value
Status Codes:
MStatus setLocalIntensity ( float  localIntensity)

Sets the local intensity for this wire deformer.

The local intensity has an effect when two wire curves are positioned close to each other. Normally, only the most deformed of the two curves will affect the surface. When the local intensity is increased, the less deformed curve will start to pull the surface back towards itself.

Parameters:
[in]localIntensityNew local intensity value
Returns:
Status code
Status Codes:
float crossingEffect ( MStatus ReturnStatus = NULL) const

Returns the crossing effect for this wire deformer.

The crossing effect applies when two wire curves cross each other. Normally, the deformation is dampened so that the surface is only affected by the most deformed curve at the intersection point. When the crossing effect is increased, the effect of the wires becomes additive. So, the object will be deform more near crossing wires.

Parameters:
[out]ReturnStatusreturn status
Returns:
The crossing effect value
Status Codes:
MStatus setCrossingEffect ( float  crossingEffect)

Sets the crossing effect for this wire deformer.

The crossing effect applies when two wire curves cross each other. Normally, the deformation is dampened so that the surface is only affected by the most deformed curve at the intersection point. When the crossing effect is increased, the effect of the wires becomes additive. So, the object will be deform more near crossing wires.

Parameters:
[in]crossingEffectNew crossing effect value
Returns:
Status code
Status Codes:
unsigned int numDropoffLocators ( unsigned int  wireIndex,
MStatus ReturnStatus = NULL 
) const

Returns the number of drop off locators.

A drop off locator allows the modification the wire curve drop off distance at a specific point on the wire curve.

Parameters:
[in]wireIndexthe index of the wire curve to query
[out]ReturnStatusreturn status
Returns:
The number of drop off locators for the given curve
Status Codes:
MStatus setDropoffLocator ( unsigned int  wireIndex,
unsigned int  locatorIndex,
float  param,
float  percentage 
)

Sets the parameters of a drop off locator.

A drop off locator allows the modification the wire curve drop off distance at a specific point on the wire curve.

Parameters:
[in]wireIndexindex of the wire curve
[in]locatorIndexindex of the locator on the given wire
[in]paramnew param value along the curve at which to position the locator
[in]percentagepercentage of the drop off distance applied
Returns:
Return status
Status Codes:
MStatus getDropoffLocator ( unsigned int  wireIndex,
unsigned int  locatorIndex,
float &  param,
float &  percentage 
)

Gets the parameters of a drop off locator.

A drop off locator allows the modification the wire curve drop off distance at a specific point on the wire curve.

Parameters:
[in]wireIndexindex of the wire curve
[in]locatorIndexindex of the locator on the given wire
[in]paramstorage for the param value along the curve that the locator is positioned at
[in]percentagestorage for the percentage value of the locator
Returns:
Return status
Status Codes:

MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer
MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer MFnWireDeformer