IFD/IFD_IPRObject.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:        IFD_IPRObject.h ( IFD Library, C++)
 *
 * COMMENTS:    This class contains information about a particular node in an IPR tree.  The node 
 */

#ifndef __IFD_IPRObject__
#define __IFD_IPRObject__

#include "IFD_API.h"
#include <UT/UT_SmallObject.h>

class UT_IStream;
class ROP_IPRObject;
class IFD_IPRTree;

enum {
    IFD_IPR_LIGHT,
    IFD_IPR_INSTANCE,
    IFD_IPR_FOG,
    IFD_IPR_DETAIL,
    IFD_IPR_MAX_STYLES
};

class IFD_API IFD_IPRObject 
        : public UT_SmallObject<IFD_IPRObject,
                                UT_SMALLOBJECT_CLEANPAGES_ON,
                                1024,
                                UT_SMALLOBJECT_THREADSAFE_ON>
{
public:
             IFD_IPRObject(IFD_IPRTree *tree);
    virtual ~IFD_IPRObject();

    virtual ROP_IPRObject       *castToROP();
    virtual const ROP_IPRObject *castToROP() const;

    /// When re-rendering an scene using IPR, it's possible that some objects
    /// may not be included in the render.  There are several possible causes
    /// for this:
    ///         A Houdini object has been deleted
    ///         The visible object/light/fog mask has changed
    ///         The display flag has been turned off
    ///         etc.
    bool                isInScene() const       { return myInScene; }
    void                setInScene(bool onoff)  { myInScene = onoff; }

    void                setTreeIndex(int idx)   { myTreeIndex = idx; }
    int                 getTreeIndex() const    { return myTreeIndex; }

    /// Determines whether an attribute of the object is dirty or not.  For
    /// example, one might call light->isDirty("shader").
    /// Attributes are currently:
    ///         space   - Transform space
    ///         texture - Texture/Shader space
    ///         surface - Instance/Detail surface shader
    ///         displace - Instance/Detail displacement shader
    ///         lmask   - Instance light mask
    ///         shader  - Light shader
    ///         shadow  - Light shadow shader
    virtual bool        isDirty(const char *attribute) = 0;

    /// The unique ID needs to be unique since it's used to index into a hash
    /// table.  Ideally, this should just be the OPs unique id.
    virtual int         getUniqueId() const = 0;
    virtual int         getGeometryObject(int) const { return getUniqueId(); }
    virtual int         getInstancePoint(int) const     { return -1; }
    virtual int         getSurfaceId(int, int) const    { return -1; }
    virtual int         getDisplaceId(int, int) const   { return -1; }

    /// Debug dump of object information
    virtual void        dump();

    virtual int         save(ostream &os)               { return 1; }
    virtual bool        load(UT_IStream &is, float now) { return true; }
    virtual int         afterLoad(float now)            { return 1; }
    

protected:
    /// Flag the whole tree as dirty (this should be done any time a node
    /// becomes dirty).  The tree may become flagged as "clean" again (after a
    /// re-render), this is regardless of the dirty state of each node.
    void                 setTreeDirty();

    IFD_IPRTree         *myTree;
    int                  myTreeIndex;
    bool                 myInScene;
};

class IFD_API IFD_IPRObjectFactory
{
public:
             IFD_IPRObjectFactory() {}
    virtual ~IFD_IPRObjectFactory() {}

    virtual IFD_IPRObject       *create() = 0;
};

#endif

---