GU/GU_SopResolver.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:
 *      Mark Elendt
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GU_SopResolver.h ( GU Library, C++)
 *
 * COMMENTS:    Resolver class for resolving filenames like "op:/soppath"
 */

#ifndef __GU_SopResolver__
#define __GU_SopResolver__

#include "GU_API.h"
#include <SYS/SYS_Types.h>
#include "GU_DetailHandle.h"

// Class to query a SOP's detail for the resolver
class GU_API GU_SopQuery {
public:
     GU_SopQuery()
     {
         myOpId = -1;
         myFrameSpecified = false;
         myTimeSpecified = false;
     }
     // If a detail has been locked, then it will be unlocked automatically on
     // destruction.
    ~GU_SopQuery() { clear(); }

    void                 clear();
    void                 clearButLeaveTime();

    void                 setDetail(const GU_DetailHandle &handle)
                             { myDetail = handle; 
                               myDetail.addPreserveRequest();
                             }

    GU_DetailHandle     &getDetail(const char *fullpath, int relative_to=-1);
    int                  getOpId() const        { return myOpId; }
    int                  getSourceId() const    { return mySourceOpId; }
    bool                 getFrame(fpreal &frame) const
                         {
                             if (myFrameSpecified)
                                 frame = myFrame;
                             return myFrameSpecified;
                         }

    void                 setFrame(fpreal frame)
                         {
                             myFrameSpecified = true;
                             myFrame = frame;
                         }
    
    bool                 getTime(fpreal &frame) const
                         {
                             if (myTimeSpecified)
                                 frame = myTime;
                             return myTimeSpecified;
                         }

    void                 setTime(fpreal frame)
                         {
                             myTimeSpecified = true;
                             myTime = frame;
                         }

private:
    GU_DetailHandle      myDetail;
    int                  myOpId;
    int                  mySourceOpId;
    bool                 myFrameSpecified;
    fpreal               myFrame;
    bool                 myTimeSpecified;
    fpreal               myTime;
    friend class         GU_SopResolver;
};

//
// Note:  The GU_SopResolver class shouldn't be accessed directly.  All access
// should be performed through the GU_SopQuery class.
//
class GU_API GU_SopResolver {
public:
             GU_SopResolver();
    virtual ~GU_SopResolver();

    static void                  setResolver(GU_SopResolver *resolver);
    static GU_SopResolver       *getResolver();

    // Lookup a path to see if it's a path to something that has geometry
    static bool                  lookup(const char *fullpath, GU_SopQuery &q);

    // Sub-class responsibilities:  These shouldn't be called directly.  They
    // are only public for the SopQuery class.

    // Given an operator path, return the unique ID associated with the Op.
    // Otherwise, return -1.
    virtual int                  resolveId(const char *fullpath,
                                            int relative_to) = 0;

    // The resolveDetail method should set the handle in the query
    // appropriately.
    virtual bool                resolveDetail(GU_SopQuery &q) = 0;
};

#endif

---