ICT290 / lib / irrKlang / include / ik_IVirtualRefCounted.h
ik_IVirtualRefCounted.h
Raw
// Copyright (C) 2002-2018 Nikolaus Gebhardt
// This file is part of the "irrKlang" library.
// For conditions of distribution and use, see copyright notice in irrKlang.h

#ifndef __I_IRRKLANG_VIRTUAL_UNKNOWN_H_INCLUDED__
#define __I_IRRKLANG_VIRTUAL_UNKNOWN_H_INCLUDED__

#include "ik_irrKlangTypes.h"


namespace irrklang
{

	//! Reference counting base class for objects in the Irrlicht Engine similar to IRefCounted.
	/** See IRefCounted for the basics of this class.
	The difference to IRefCounted is that the class has to implement reference counting
	for itself. 
	*/
	class IVirtualRefCounted
	{
	public:

		//! Destructor.
		virtual ~IVirtualRefCounted()
		{
		}

		//! Grabs the object. Increments the reference counter by one.
		/** To be implemented by the derived class. If you don't want to
		implement this, use the class IRefCounted instead. See IRefCounted::grab() for details
		of this method. */
		virtual void grab() = 0;

		//! Drops the object. Decrements the reference counter by one.
		/** To be implemented by the derived class. If you don't want to
		implement this, use the class IRefCounted instead. See IRefCounted::grab() for details
		of this method. */
		virtual bool drop() = 0;
	};



} // end namespace irrklang



#endif