aboutsummaryrefslogtreecommitdiff
path: root/NvBlast/sdk/toolkit/include/NvBlastTkObject.h
blob: 085e8596cf7c795c8a32fd610436a225d4de9288 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
* Copyright (c) 2016-2017, NVIDIA CORPORATION.  All rights reserved.
*
* NVIDIA CORPORATION and its licensors retain all intellectual property
* and proprietary rights in and to this software, related documentation
* and any modifications thereto.  Any use, reproduction, disclosure or
* distribution of this software and related documentation without an express
* license agreement from NVIDIA CORPORATION is strictly prohibited.
*/

#ifndef NVBLASTTKOBJECT_H
#define NVBLASTTKOBJECT_H


namespace Nv
{
namespace Blast
{

/**
Base class for all objects in Tk.  All TkObjects are releasable.
*/
class TkObject
{
public:
	/**
	Constructor clears userData.
	*/
	TkObject() : userData(nullptr) {}

	// Object API

	/**
	Release this object and free associated memory.
	*/
	virtual void	release() = 0;

protected:
	/**
	Destructor is virtual and not public - use the release() method instead of explicitly deleting a TkObject
	*/
	virtual			~TkObject() {}

public:
	// Data

	/**
	Pointer field available to the user.
	*/
	void*	userData;
};

} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTTKOBJECT_H