OP/OP_Context.h

Go to the documentation of this file.

#ifndef __OP_Context__
#define __OP_Context__

#include "OP_API.h"
#include "OP_DataTypes.h"               // For OP_DATA_TYPE
#include "OP_Version.h"                 // For OP_VERSION

#include <stdio.h>

class OP_API OP_ContextFlags
{
public:
    unsigned long       myCookOverride:1,       // Cook only if it is quick
                        myTimeDep:1;            // Am I time dependent?
};

class OP_API OP_Context
{
public:
                         OP_Context();
    explicit             OP_Context(float t);
                         OP_Context(float t, int thread);
                         OP_Context(const OP_Context &from);

    void                *getData()    const { return myData; }
    OP_VERSION           getVersion() const { return myVersion; }
    long                 getFrame()   const;
    float                getFloatFrame() const;
    float                getTime()    const { return myTime; }
    void                 setTime(float t)   { myTime = t; }

    void                 setThread(int thr) { myThread = thr; }
    int                  getThread() const  { return myThread; }

    void                 setData(void *data)            { myData = data; }
    void                 setVersion(OP_VERSION version) { myVersion = version; }

    void                 setData(void *data, OP_DATA_TYPE type)
                         {
                            myData  = data;
                            myType  = type;
                         }
    void                 setFrame(long frame);
    void                 setFrame(float frame);

    void                 copyPointer(const OP_Context &from);

    int                  operator==( const OP_Context &to ) const;
    OP_Context          &operator= ( const OP_Context &to );

    void                 print(FILE *);


                                        // Match criteria.
                                        // These fields define the parameters
                                        // for getCookedData(), or
                                        // needToCook() or cook().
    float                myTime;        // 0 based time
    int                  myXres;        // Pixel resolution
    int                  myYres;        // Pixel resolution


                                        // These fields are used to define the
                                        // kind of COOK or GET that is to take
                                        // place

    OP_DATA_TYPE         myType;        // What kind of data is myData
    void                *myData;        // Put output here instead of with node

    OP_VERSION           myVersion;     // When fetching data, this is the
                                        // version number of the fetched data.

    int                  myThread;      // UTgetSTID() when this context was
                                        // created.

    OP_ContextFlags      myFlags;

private:
    void                 initDefaults(float t, int thread);
};

#endif

---