GR_SceneItem.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.
 *
 * NAME:        GR_SceneItem.h (GR Library, C++)
 *
 * COMMENTS:
 */
#ifndef GR_SceneItem_h
#define GR_SceneItem_h

#include <UT/UT_NonCopyable.h>
#include <UT/UT_StringHolder.h>
#include <SYS/SYS_AtomicInt.h>
#include <SYS/SYS_Types.h>

/// Base class for various things that can appear in a scene outside of geometry
class GR_SceneItem
{
public:
    // Identification
    const UT_StringHolder &name() const { return myName; }
    exint                  id() const   { return myID; }

     // Version control
    int64       getVersion() const      { return myVersion; }
    void        setVersion(int64 v)     { myVersion = v; }

    // 
    void        incref()
                { myRefCount.add(1); }
    void        decref()
                {
                    if (!myRefCount.add(-1))
                        delete this;
                }
    
    void        setName(const UT_StringHolder &name) { myName = name; }
    void        setID(int id) { myID = id; }

protected:
    GR_SceneItem(const UT_StringHolder &name, int id)
        : myName(name), myID(id) {}
    virtual ~GR_SceneItem() {}

    UT_NON_COPYABLE(GR_SceneItem);

private:
    UT_StringHolder myName;
    exint           myID;
    int64           myVersion = 0;
    SYS_AtomicInt32 myRefCount;
};

static inline void intrusive_ptr_add_ref(GR_SceneItem *i) { i->incref(); }
static inline void intrusive_ptr_release(GR_SceneItem *i) { i->decref(); }

#endif