GU/GU_Fur.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        GU_Fur.h (GU Library, C++)
 *
 * COMMENTS:    Generates fur geometry
 */

#ifndef __GU_Fur__
#define __GU_Fur__

#include "GU_API.h"

#include "GU_Detail.h"
#include <UT/UT_OpCaller.h>

enum GU_FurCurveType
{
    GU_FUR_POLYGON,
    GU_FUR_NURBS
};

// This class is a convenient wrapper around attributes.  It provides a
// simpler interface to reading attributes.  Vertex, Point, Primitive, and
// Detail attributes are all searched.
class GU_API guFurAttribute
{
public:
    guFurAttribute(const GU_Detail *gdp, const char *name, int size, GB_AttribType type);
    guFurAttribute(const GU_Detail *gdp, GEO_AttributeOwner owner, const GB_Attribute *atr);

    // for float attributes, specifies a default value if the attribute is not
    // present or scalar multiplier if the attribute is present
    void setDefaultScalar(fpreal scalar);
 
    // evaluate attributes at the given primitive/vertex
    fpreal evalFloat(int pr, int v, int i = 0) const;
    int evalInt(int pr, int v, int i = 0) const;
    const char *evalString(int pr, int v, int i = 0) const;

    // return true if the attribute exists on the detail
    bool hasAttrib() const { return myOffset >= 0; }

    // returns the detail containing the attribute
    const GU_Detail *getGdp() const { return myGdp; }

private:
    const void *getData(int pr, int v) const;

    const GU_Detail *myGdp;
    GEO_AttributeOwner myOwner;
    const GB_Attribute *myAttribute;
    int myOffset;
    bool myUseDefaultScalar;
    fpreal myDefaultScalar;
};

class guFurSkinWrapper;
class guFurClumpsWrapper;
class guFurPartingLinesWrapper;

class GU_API GU_Fur
{
public:
    GU_Fur(const GU_Detail *skin,
           const GU_Detail *guides,
           const GU_Detail *clumps,
           const GU_Detail *partinglines,
           int seed,
           fpreal density,
           fpreal length,
           fpreal clumpradius,
           fpreal partingradius,
           const UT_String &skin_shader,
           const UT_String &guide_shader,
           const UT_String &skin_attribs,
           const UT_String &guide_attribs,
           bool set_id);
    virtual ~GU_Fur();

    // This must be called and return true before attempting to generate
    // curves with the generate() method.
    // This method can fail (return false) if the number primitives in the
    // guides geometry does not match the number of points in the skin
    // geometry or the number of vertices in guide and clump geometries
    // are inconsistent.
    bool initialize(int nvertices);

    // creates curves in 'gdp' grown from the primitives specified by
    // 'skinprims' from the skin geometry used in the constructor
    void generate(UT_OpCaller *caller,
                  GU_Detail *gdp,
                  const UT_IntArray &skinprims,
                  fpreal display,
                  bool use_closest_clump,
                  GU_FurCurveType type,
                  GEO_AttributeOwner skinowner,
                  GEO_AttributeOwner guideowner,
                  bool interruptable);

    // subclasses implement these methods to record any errors and warnings
    virtual void addError(const UT_String &str) = 0;
    virtual void addWarning(const UT_String &str) = 0;

protected:
    guFurSkinWrapper *mySkin;
    const GU_Detail *myGuides;
    guFurClumpsWrapper *myClumps;
    guFurPartingLinesWrapper *myPartingLines;

    int mySeed;
    fpreal myDensity;
    fpreal myLength;
    const UT_String mySkinShader;
    const UT_String myGuideShader;
    const UT_String mySkinAttribs;
    const UT_String myGuideAttribs;
    bool mySetId;
    int myNumVertices;
};

#endif

---