Public Member Functions | Protected Member Functions

MFnPfxGeometry Class Reference

Search for all occurrences

Detailed Description

PfxGeometry node function set.

This is the function set for paint effects objects.

PfxGeometry is the parent class for the stroke and pfxHair node. The output geometry for pfxHair and stroke nodes may be accessed through this class.

Examples:

pfxInfoCmd.cpp.

#include <MFnPfxGeometry.h>

Inheritance diagram for MFnPfxGeometry:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnPfxGeometry ()
 Destructor.
 MFnPfxGeometry ()
 Default constructor.
 MFnPfxGeometry (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnPfxGeometry (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MStatus getLineData (MRenderLineArray &mainLines, MRenderLineArray &leafLines, MRenderLineArray &flowerLines, bool doLines, bool doTwist, bool doWidth, bool doFlatness, bool doParameter, bool doColor, bool doIncandescence, bool doTransparency, bool worldSpace)
 Get line data for the current output pfx tubes.
MStatus getBoundingBox (double *min, double *max)
 Gets the bounding box of the specified geometry.
 MFnPfxGeometry (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnPfxGeometry ( ) [virtual]

Destructor.

Class Destructor.

MFnPfxGeometry ( 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:
MFnPfxGeometry ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given constant MDagPath object.

Parameters:
[in]objectThe const MDagPath to attach the function set to
[out]ReturnStatusThe return status
Status Codes:
MFnPfxGeometry ( 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::kPfxGeometry.

Reimplemented from MFnDagNode.

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

Class name.

Return the class name : "MFnPfxGeometry".

Reimplemented from MFnDagNode.

MStatus getLineData ( MRenderLineArray mainLines,
MRenderLineArray leafLines,
MRenderLineArray flowerLines,
bool  doLines,
bool  doTwist,
bool  doWidth,
bool  doFlatness,
bool  doParameter,
bool  doColor,
bool  doIncandescence,
bool  doTransparency,
bool  worldSpace 
)

Get line data for the current output pfx tubes.

The passed in arrays will be filled with pointers to MrenderLine classes. If there are no leaves or flowers then the passed in leafLine and flowerLine arrays will be left empty. Arrays are generated for only the specified attributes. This routine creates the memory for the arrays that it computes. This memory can only be released using the deleteArray method on the MRenderLineArray class. DeleteArray should be called for the mainLine, leafLine, and flowerLine variables when done. These variables wrap the returned data and allow access but the MRenderLineArray destructer does not delete this wrapped memory, so one must use MRenderLineArray::deleteArray(). The MRenderLine, MVectorArray and MDoubleArrays returned from MRenderLineArray will point to deleted memory after calling deleteArray, so be careful to only call deleteArray when finished using the line data(or copy the arrays first).

Parameters:
[out]mainLinesprimary MRenderLineArray
[out]leafLinesleaf MRenderLineArray
[out]flowerLinesflower MRenderLineArray
[in]doLinescreate line(vertex) arrays
[in]doTwistcreate twist arrays
[in]doWidthcreate width arrays
[in]doFlatnesscreate flatness arrays
[in]doParametercreate parameter arrays
[in]doColorcreate color arrays
[in]doIncandescencecreate incandescence arrays
[in]doTransparencycreate transparency arrays
[in]worldSpacecompute lines in worldspace, instead of the stroke objectspace
Returns:
Status code
Status Codes:
MStatus getBoundingBox ( double *  min,
double *  max 
)

Gets the bounding box of the specified geometry.

The passed in double arrays will be filled with minimum and maximum coordinates of the geometry.

Parameters:
[out]minminimum coordinates
[out]maxmaximum coordinates
Returns:
Status code
Status Codes:

MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry
MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry MFnPfxGeometry