aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/include/basicfs/VortexFSPreview.h
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /APEX_1.4/include/basicfs/VortexFSPreview.h
downloadphysx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz
physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip
Initial commit:
PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167]
Diffstat (limited to 'APEX_1.4/include/basicfs/VortexFSPreview.h')
-rw-r--r--APEX_1.4/include/basicfs/VortexFSPreview.h90
1 files changed, 90 insertions, 0 deletions
diff --git a/APEX_1.4/include/basicfs/VortexFSPreview.h b/APEX_1.4/include/basicfs/VortexFSPreview.h
new file mode 100644
index 00000000..8270995d
--- /dev/null
+++ b/APEX_1.4/include/basicfs/VortexFSPreview.h
@@ -0,0 +1,90 @@
+/*
+ * 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 VORTEX_FSPREVIEW_H
+#define VORTEX_FSPREVIEW_H
+
+#include "Apex.h"
+#include "AssetPreview.h"
+
+namespace nvidia
+{
+namespace apex
+{
+
+PX_PUSH_PACK_DEFAULT
+
+class RenderDebugInterface;
+
+/**
+ \brief The APEX_VORTEX namespace contains the defines for setting the preview detail levels.
+
+ VORTEX_DRAW_NOTHING - draw nothing<BR>
+ VORTEX_DRAW_SHAPE - draw the Vortex shape<BR>
+ VORTEX_DRAW_ASSET_INFO - draw the asset info in the screen space<BR>
+ VORTEX_DRAW_FULL_DETAIL - draw all components of the preview<BR>
+*/
+namespace APEX_VORTEX
+{
+/**
+ \def VORTEX_DRAW_NOTHING
+ Draw no preview items.
+*/
+static const uint32_t VORTEX_DRAW_NOTHING = 0x00;
+/**
+ \def VORTEX_DRAW_SHAPE
+ Draw the shape. The top of the shape should be above ground and the bottom should be below ground.
+*/
+static const uint32_t VORTEX_DRAW_SHAPE = 0x01;
+/**
+ \def VORTEX_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 VORTEX_DRAW_ASSET_INFO = 0x02;
+/**
+ \def VORTEX_DRAW_FULL_DETAIL
+ Draw all of the preview rendering items.
+*/
+static const uint32_t VORTEX_DRAW_FULL_DETAIL = (VORTEX_DRAW_SHAPE + VORTEX_DRAW_ASSET_INFO);
+}
+
+/**
+\brief This class provides the asset preview for APEX VortexFS Assets. The class provides multiple levels of prevew
+detail that can be selected individually.
+*/
+class VortexFSPreview : public AssetPreview
+{
+public:
+ /**
+ \brief Set the radius of the vortex.
+ */
+ virtual void setRadius(float radius) = 0;
+ /**
+ Set the detail level of the preview rendering by selecting which features to enable.<BR>
+ 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>
+ VORTEX_DRAW_NOTHING - draw nothing<BR>
+ VORTEX_DRAW_SHAPE - draw the shape<BR>
+ VORTEX_DRAW_ASSET_INFO - draw the turbulencefs asset info in the screen space<BR>
+ VORTEX_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 // VORTEX_FS_PREVIEW_H