SmartHandle.h

Go to the documentation of this file.

//
// Copyright 2010 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which 
// otherwise accompanies this software in either electronic or hard copy form.   
//
//

#pragma once

#include "./GraphicsDriverExport.h"
#include "./Types.h"

#include "../MaxHeap.h"
#include "../Noncopyable.h"

namespace MaxSDK { namespace Graphics {

class SmartHandle : public MaxSDK::Util::Noncopyable
{
public:
    GraphicsDriverAPI virtual ~SmartHandle();

    GraphicsDriverAPI bool IsValid() const;
    
    GraphicsDriverAPI void Release();

    GraphicsDriverAPI Identifier GetObjectID() const;

    // This function is internally used only.
    GraphicsDriverAPI void SetPointer(void* pObject);

    GraphicsDriverAPI void* GetPointer() const;

    // comparison operators
    inline bool operator == (const SmartHandle& rhs) const {
        return mpObject == rhs.mpObject;
    }

    inline bool operator != (const SmartHandle& rhs) const {
        return mpObject != rhs.mpObject;
    }

    inline bool operator < (const SmartHandle& rhs) const {
        return mpObject < rhs.mpObject;
    }

    inline bool operator <= (const SmartHandle& rhs) const {
        return mpObject <= rhs.mpObject;
    }

    inline bool operator > (const SmartHandle& rhs) const {
        return mpObject > rhs.mpObject;
    }

    inline bool operator >= (const SmartHandle& rhs) const {
        return mpObject >= rhs.mpObject;
    }

protected:
    // protected to keep the class from getting created directly. handle defaults to undefined
    GraphicsDriverAPI SmartHandle();

    // the object that this interface reference to. It is used to avoid accessing driver
    // every time you want to modify the object.
    void* mpObject;

private:
    SmartHandle(const SmartHandle&);
    SmartHandle& operator = (const SmartHandle&);

    void AddRef();
};

} } // end namespace