OBJ/OBJ_Rivet.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:
 *      Rafal Jaroszkiewicz
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        OBJ_Rivet.h (Custom Library, C++)
 *
 * COMMENTS:    An object that attaches itself to another object (i.e.
 *              geometry). Based on three chosen points of the
 *              object, it constructs a local reference frame on the
 *              object's surface, and attaches itself to that frame.
 *              When surface moves, the attached rivet object also
 *              moves with it.
 *
 */

#ifndef __OBJ_Rivet__
#define __OBJ_Rivet__

#include "OBJ_API.h"
#include <UT/UT_Vector2.h>
#include <UT/UT_Vector3Array.h>
#include <GU/GU_DetailHandle.h>
#include "OBJ_Null.h"

class UT_FloatArray;

// order should correspond to OBJrivetTemplate
enum OBJ_RivetIndex
{
    I_RIVET_GEOPATH = I_N_NULL_INDICES,
    I_RIVET_POINTGROUP,
    I_RIVET_POINTWEIGHTS,
    I_RIVET_USEATTRIBS,
    I_RIVET_XATTRIBS,
    I_RIVET_ZATTRIBS,

    I_N_RIVET_INDICES
};


class OBJ_API OBJ_Rivet : public OBJ_Null
{
public:
                                 OBJ_Rivet(OP_Network *net,
                                           const char *name,
                                           OP_Operator *op);
    virtual                     ~OBJ_Rivet();

    virtual OBJ_OBJECT_TYPE      getObjectType() const;

    static OP_Node              *myConstructor(OP_Network *net,
                                               const char *name,
                                               OP_Operator *entry);

    static PRM_Template         *getTemplateList();
    virtual OBJ_Rivet           *castToOBJRivet()       { return this; }
    virtual unsigned             disableParms();


    // accessors of the parameters
    void                         RIVET_GEOPATH( UT_String &str, float t )
                                 {
                                     evalString(str, "rivetsop", 0, t);
                                 }
    void                         RIVET_POINTGROUP(UT_String &str, float t)
                                 {
                                     evalString(str, "rivetgroup", 0, t);
                                 }
    bool                         RIVET_USE_ATTRIBS()
                                 {
                                     return evalInt("rivetuseattribs", 0, 0.0f);
                                 }
    void                         RIVET_X_ATTRIB_NAME(UT_String &str, float t)
                                 {
                                     evalString(str, "rivetxattrib", 0, t);
                                 }
    void                         RIVET_Z_ATTRIB_NAME(UT_String &str, float t)
                                 {
                                     evalString(str, "rivetzattrib", 0, t);
                                 }

    void                         setRIVET_GEOPATH(UT_String &str,
                                            CH_StringMeaning meaning, float t)
                                 {
                                     setString(str, meaning, "rivetsop", 0, t);
                                 }
    void                         setRIVET_POINTGROUP(UT_String &str,
                                            CH_StringMeaning meaning, float t)
                                 {
                                     setString(str, meaning, "rivetgroup", 0,t);
                                 }

protected:
    // Used to get pointer to indirection indices for each object type
    virtual int                 *getIndirect() const
                                 { return rivetIndirect; }

    virtual OP_ERROR             cookMyObj(OP_Context &context);

    GU_DetailHandle              getStuckGdp(float t);

    virtual void                 buildPointGroupMenu( PRM_Name *menu,
                                            int size, 
                                            const PRM_SpareData *spare, 
                                            PRM_Parm *parm);
    float                        RIVET_POINTWEIGHT( float t, int k )
                                 {
                                     return evalFloat("rivetweights", k, t);
                                 } 

private:
    // obtains array of points based on which a local surface frame is build
    // also, for each point, obtains normals (z-axis) and tangents (x-axis)
    // if the attribute names are provided for them by the rivet parameters
    void                         getRivetPoints( OP_Context &context,
                                                 SOP_Node *sop, 
                                                 UT_Vector3Array &points,
                                                 UT_Vector3Array &tangents,
                                                 UT_Vector3Array &normals );

    // obtains the weights for the points 
    void                        getPointWeights( float t, 
                                                 UT_FloatArray &weights,
                                                 int point_count);

private:
    static int                  *rivetIndirect;
};

#endif

---