aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/include/turbulencefs/TurbulenceFSPreview.h
blob: 9bc0c7a6a7e98b6cdf866c0bd1b523c4bc367830 (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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*
 * Copyright (c) 2008-2015, 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 TURBULENCE_FSPREVIEW_H
#define TURBULENCE_FSPREVIEW_H

#include "Apex.h"
#include "AssetPreview.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class RenderDebugInterface;

/**
	\brief The APEX_TURBO namespace contains the defines for setting the preview detail levels.

	TURBO_DRAW_NOTHING - draw nothing<BR>
	TURBO_DRAW_ICON - draw the APEX TurbulenceFS Icon<BR>
	TURBO_DRAW_BOX - draw the box<BR>
	TURBO_DRAW_GRIDS - draw the top and bottom grids of the box<BR>
	TURBO_DRAW_ASSET_INFO - draw the asset info in the screen space<BR>
	TURBO_DRAW_FULL_DETAIL - draw all components of the preview<BR>
*/
namespace APEX_TURBO
{
/**
	\def TURBO_DRAW_NOTHING
	Draw no preview items.
*/
static const uint32_t TURBO_DRAW_NOTHING = 0x00;
/**
	\def TURBO_DRAW_ICON
	Draw the icon.
*/
static const uint32_t TURBO_DRAW_ICON = 0x01;
/**
	\def TURBO_DRAW_BOX
	Draw the box.  The top of the box should be above ground and the bottom should be below ground.
*/
static const uint32_t TURBO_DRAW_BOX = 0x02;
/**
	\def TURBO_DRAW_GRIDS
	Draw the box grids.  These help to see if the entire top of the box is above ground and the
	bottom of the box is below ground.
*/
static const uint32_t TURBO_DRAW_GRIDS = 0x04;
/**
	\def TURBO_DRAW_ASSET_INFO
	Draw the Asset Info in Screen Space.  This displays the various asset members that are relevant to the current asset.
	parameters that are not relevant because they are disabled are not displayed.
*/
static const uint32_t TURBO_DRAW_ASSET_INFO = 0x20;
/**
	\def TURBO_DRAW_FULL_DETAIL
	Draw all of the preview rendering items.
*/
static const uint32_t TURBO_DRAW_FULL_DETAIL = (TURBO_DRAW_ICON + TURBO_DRAW_BOX + TURBO_DRAW_GRIDS + TURBO_DRAW_ASSET_INFO);
}

/**
\brief This class provides the asset preview for APEX TurbulenceFS Assets.  The class provides multiple levels of prevew
detail that can be selected individually.
*/
class TurbulenceFSPreview : public AssetPreview
{
public:
	/**
	\brief Set the half length dimensions of the actor thus resizing the box.
	*/
	virtual void	setHalfLengthDimensions(PxVec3 halfLengthDimensions) = 0;
	/**
	\brief Set number of grid cells in the box.
	*/
	virtual void	setNumGrids(PxVec3 numGrids) = 0;
	/**
	\brief Set the scale of the icon.
	
	The unscaled icon has is 1.0x1.0 game units.<BR>
	By default the scale of the icon is 1.0. (unscaled)<BR>
	*/
	virtual void	setIconScale(float scale) = 0;
	/**
	\brief Set the detail level of the preview rendering by selecting which features to enable.
	
	Any, all, or none of the following masks may be added together to select what should be drawn.<BR>
	The defines for the individual items are:<br>
		TURBO_DRAW_NOTHING - draw nothing<BR>
		TURBO_DRAW_ICON - draw the APEX TurbulenceFS Icon<BR>
		TURBO_DRAW_BOX - draw the box<BR>
		TURBO_DRAW_COLLISION_IMPLICIT - draw the collision implicit<BR>
		TURBO_DRAW_GRIDS - draw the top and bottom grids of the box<BR>
		TURBO_DRAW_ASSET_INFO - draw the turbulencefs asset info in the screen space<BR>
		TURBO_DRAW_FULL_DETAIL - draw all components of the turbulencefs preview<BR>
	All items may be drawn using the macro DRAW_FULL_DETAIL.
	*/
	virtual void	setDetailLevel(uint32_t detail) = 0;
};


PX_POP_PACK

}
} // namespace nvidia

#endif // TURBULENCE_FSPREVIEW_H