aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/include/forcefield
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/forcefield
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/forcefield')
-rw-r--r--APEX_1.4/include/forcefield/ForceFieldActor.h131
-rw-r--r--APEX_1.4/include/forcefield/ForceFieldAsset.h72
-rw-r--r--APEX_1.4/include/forcefield/ForceFieldPreview.h92
-rw-r--r--APEX_1.4/include/forcefield/ModuleForceField.h52
4 files changed, 347 insertions, 0 deletions
diff --git a/APEX_1.4/include/forcefield/ForceFieldActor.h b/APEX_1.4/include/forcefield/ForceFieldActor.h
new file mode 100644
index 00000000..06f260fa
--- /dev/null
+++ b/APEX_1.4/include/forcefield/ForceFieldActor.h
@@ -0,0 +1,131 @@
+/*
+ * 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 FORCE_FIELD_ACTOR_H
+#define FORCE_FIELD_ACTOR_H
+
+#include "Apex.h"
+
+
+namespace nvidia
+{
+namespace apex
+{
+
+
+PX_PUSH_PACK_DEFAULT
+
+class ForceFieldAsset;
+class ForceFieldAssetParams;
+
+/**
+ \brief ForceField Actor
+ */
+class ForceFieldActor : public Actor
+{
+protected:
+ virtual ~ForceFieldActor() {}
+
+public:
+ /**
+ Return true if the force field actor is enabled.
+ */
+ virtual bool isEnable() = 0;
+
+ /**
+ Disable force field actor. Default status is enable. Can switch it freely.
+ A disabled explosion actor still exists there, but has no effect to the scene.
+ */
+ virtual bool disable() = 0;
+
+ /**
+ Enable force field actor. Default status is enable. Can switch it freely.
+ A disabled explosion actor still exists there, but has no effect to the scene.
+ */
+ virtual bool enable() = 0;
+
+ /**
+ Gets location and orientation of the force field.
+ */
+ virtual PxMat44 getPose() const = 0;
+
+ /**
+ Sets location and orientation of the force field.
+ */
+ virtual void setPose(const PxMat44& pose) = 0;
+
+ /**
+ Gets the force field actor's scale.
+ */
+ PX_DEPRECATED virtual float getScale() const = 0;
+
+ /**
+ Sets the force field actor's scale. (0.0f, +inf)
+ */
+ PX_DEPRECATED virtual void setScale(float scale) = 0;
+
+ /**
+ Gets the force field actor's scale.
+ */
+ PX_DEPRECATED virtual float getCurrentScale() const = 0;
+
+ /**
+ Sets the force field actor's scale. (0.0f, +inf)
+ */
+ PX_DEPRECATED virtual void setCurrentScale(float scale) = 0;
+
+
+
+ /**
+ Retrieves the name string for the force field actor.
+ */
+ virtual const char* getName() const = 0;
+
+ /**
+ Set a name string for the force field actor that can be retrieved with getName().
+ */
+ virtual void setName(const char* name) = 0;
+
+ /**
+ Set strength for the force field actor.
+ */
+ virtual void setStrength(const float strength) = 0;
+
+ /**
+ Set lifetime for the force field actor.
+ */
+ virtual void setLifetime(const float lifetime) = 0;
+
+ /**
+ Set falloff type (linear, steep, scurve, custom, none) for the force field actor.
+ Only works for radial force field types.
+ */
+ PX_DEPRECATED virtual void setFalloffType(const char* type) = 0;
+
+ /**
+ Set falloff multiplier for the force field actor.
+ Only works for radial force field types.
+ */
+ PX_DEPRECATED virtual void setFalloffMultiplier(const float multiplier) = 0;
+
+ /**
+ Returns the asset the actor has been created from.
+ */
+ virtual ForceFieldAsset* getForceFieldAsset() const = 0;
+
+};
+
+PX_POP_PACK
+
+} // namespace apex
+} // namespace nvidia
+
+#endif // FORCE_FIELD_ACTOR_H
diff --git a/APEX_1.4/include/forcefield/ForceFieldAsset.h b/APEX_1.4/include/forcefield/ForceFieldAsset.h
new file mode 100644
index 00000000..81ee3480
--- /dev/null
+++ b/APEX_1.4/include/forcefield/ForceFieldAsset.h
@@ -0,0 +1,72 @@
+/*
+ * 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 FORCE_FIELD_ASSET_H
+#define FORCE_FIELD_ASSET_H
+
+#include "Apex.h"
+#include "ForceFieldPreview.h"
+
+namespace nvidia
+{
+namespace apex
+{
+
+PX_PUSH_PACK_DEFAULT
+
+#define FORCEFIELD_AUTHORING_TYPE_NAME "ForceFieldAsset"
+
+class ForceFieldActor;
+
+/**
+ \brief ForceField Asset
+ */
+class ForceFieldAsset : public Asset
+{
+protected:
+ /**
+ \brief force field asset default destructor.
+ */
+ virtual ~ForceFieldAsset() {}
+
+public:
+ /**
+ \brief returns the default scale of the asset.
+ */
+ virtual float getDefaultScale() const = 0;
+
+ /**
+ \brief release an actor created from this asset.
+ */
+ virtual void releaseForceFieldActor(ForceFieldActor&) = 0;
+};
+
+/**
+ \brief ForceField Asset Authoring
+ */
+class ForceFieldAssetAuthoring : public AssetAuthoring
+{
+protected:
+ /**
+ \brief force field asset authoring default destructor.
+ */
+ virtual ~ForceFieldAssetAuthoring() {}
+
+public:
+};
+
+
+PX_POP_PACK
+
+} // namespace apex
+} // namespace nvidia
+
+#endif // FORCE_FIELD_ASSET_H
diff --git a/APEX_1.4/include/forcefield/ForceFieldPreview.h b/APEX_1.4/include/forcefield/ForceFieldPreview.h
new file mode 100644
index 00000000..3e37a5d9
--- /dev/null
+++ b/APEX_1.4/include/forcefield/ForceFieldPreview.h
@@ -0,0 +1,92 @@
+/*
+ * 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 FORCE_FIELD_PREVIEW_H
+#define FORCE_FIELD_PREVIEW_H
+
+#include "Apex.h"
+#include "AssetPreview.h"
+
+namespace nvidia
+{
+namespace apex
+{
+
+PX_PUSH_PACK_DEFAULT
+
+class RenderDebugInterface;
+
+namespace APEX_FORCEFIELD
+{
+/**
+ \def FORCEFIELD_DRAW_NOTHING
+ Draw no items.
+*/
+static const uint32_t FORCEFIELD_DRAW_NOTHING = (0x00);
+/**
+ \def FORCEFIELD_DRAW_ICON
+ Draw the icon.
+*/
+static const uint32_t FORCEFIELD_DRAW_ICON = (0x01);
+/**
+ \def FORCEFIELD_DRAW_BOUNDARIES
+ Draw the ForceField include shapes.
+*/
+static const uint32_t FORCEFIELD_DRAW_BOUNDARIES = (0x2);
+/**
+ \def FORCEFIELD_DRAW_WITH_CYLINDERS
+ Draw the explosion field boundaries.
+*/
+static const uint32_t FORCEFIELD_DRAW_WITH_CYLINDERS = (0x4);
+/**
+ \def FORCEFIELD_DRAW_FULL_DETAIL
+ Draw all of the preview rendering items.
+*/
+static const uint32_t FORCEFIELD_DRAW_FULL_DETAIL = (FORCEFIELD_DRAW_ICON + FORCEFIELD_DRAW_BOUNDARIES);
+/**
+ \def FORCEFIELD_DRAW_FULL_DETAIL_BOLD
+ Draw all of the preview rendering items using cylinders instead of lines to make the text and icon look BOLD.
+*/
+static const uint32_t FORCEFIELD_DRAW_FULL_DETAIL_BOLD = (FORCEFIELD_DRAW_FULL_DETAIL + FORCEFIELD_DRAW_WITH_CYLINDERS);
+}
+
+/**
+\brief APEX asset preview force field asset.
+*/
+class ForceFieldPreview : public AssetPreview
+{
+public:
+ /**
+ Set the scale of the icon.
+ The unscaled icon has is 1.0x1.0 game units.
+ By default the scale of the icon is 1.0. (unscaled)
+ */
+ virtual void setIconScale(float scale) = 0;
+ /**
+ 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.
+ The defines for the individual items are FORCEFIELD_DRAW_NOTHING, FORCEFIELD_DRAW_ICON, FORCEFIELD_DRAW_BOUNDARIES,
+ FORCEFIELD_DRAW_WITH_CYLINDERS.
+ All items may be drawn using the macro FORCEFIELD_DRAW_FULL_DETAIL and FORCEFIELD_DRAW_FULL_DETAIL_BOLD.
+ */
+ virtual void setDetailLevel(uint32_t detail) = 0;
+
+protected:
+ ForceFieldPreview() {};
+};
+
+
+PX_POP_PACK
+
+} // namespace apex
+} // namespace nvidia
+
+#endif // FORCE_FIELD_PREVIEW_H
diff --git a/APEX_1.4/include/forcefield/ModuleForceField.h b/APEX_1.4/include/forcefield/ModuleForceField.h
new file mode 100644
index 00000000..b8440020
--- /dev/null
+++ b/APEX_1.4/include/forcefield/ModuleForceField.h
@@ -0,0 +1,52 @@
+/*
+ * 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 MODULE_FORCE_FIELD_H
+#define MODULE_FORCE_FIELD_H
+
+#include "Apex.h"
+
+namespace nvidia
+{
+namespace apex
+{
+
+PX_PUSH_PACK_DEFAULT
+
+class ForceFieldAsset;
+class ForceFieldAssetAuthoring;
+
+/**
+\brief ForceField Module
+*/
+class ModuleForceField : public Module
+{
+public:
+ /**
+ \brief The module ID value of the force field.
+ */
+ virtual uint32_t getModuleValue() const = 0;
+
+protected:
+ /**
+ \brief Force field module default destructor.
+ */
+ virtual ~ModuleForceField() {}
+};
+
+
+
+PX_POP_PACK
+
+} // namespace apex
+} // namespace nvidia
+
+#endif // MODULE_FORCE_FIELD_H