aboutsummaryrefslogtreecommitdiff
path: root/PxShared/src/pvd/include/PxPvdDataStream.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 /PxShared/src/pvd/include/PxPvdDataStream.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 'PxShared/src/pvd/include/PxPvdDataStream.h')
-rw-r--r--PxShared/src/pvd/include/PxPvdDataStream.h272
1 files changed, 272 insertions, 0 deletions
diff --git a/PxShared/src/pvd/include/PxPvdDataStream.h b/PxShared/src/pvd/include/PxPvdDataStream.h
new file mode 100644
index 00000000..870e5973
--- /dev/null
+++ b/PxShared/src/pvd/include/PxPvdDataStream.h
@@ -0,0 +1,272 @@
+// This code contains NVIDIA Confidential Information and is disclosed to you
+// under a form of NVIDIA software license agreement provided separately to you.
+//
+// Notice
+// NVIDIA Corporation and its licensors retain all intellectual property and
+// proprietary rights in and to this software and 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.
+//
+// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
+// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
+// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
+// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
+//
+// Information and code furnished is believed to be accurate and reliable.
+// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
+// information or for any infringement of patents or other rights of third parties that may
+// result from its use. No license is granted by implication or otherwise under any patent
+// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
+// This code supersedes and replaces all information previously supplied.
+// NVIDIA Corporation products are not authorized for use as critical
+// components in life support devices or systems without express written approval of
+// NVIDIA Corporation.
+//
+// Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved.
+#ifndef PXPVDSDK_PXPVDDATASTREAM_H
+#define PXPVDSDK_PXPVDDATASTREAM_H
+
+/** \addtogroup pvd
+@{
+*/
+#include "pvd/PxPvd.h"
+#include "PxPvdErrorCodes.h"
+#include "PxPvdObjectModelBaseTypes.h"
+
+#if !PX_DOXYGEN
+namespace physx
+{
+namespace pvdsdk
+{
+#endif
+
+class PvdPropertyDefinitionHelper;
+
+class PvdMetaDataStream
+{
+ protected:
+ virtual ~PvdMetaDataStream()
+ {
+ }
+
+ public:
+ virtual PvdError createClass(const NamespacedName& nm) = 0;
+ template <typename TDataType>
+ PvdError createClass()
+ {
+ return createClass(getPvdNamespacedNameForType<TDataType>());
+ }
+
+ virtual PvdError deriveClass(const NamespacedName& parent, const NamespacedName& child) = 0;
+ template <typename TParentType, typename TChildType>
+ PvdError deriveClass()
+ {
+ return deriveClass(getPvdNamespacedNameForType<TParentType>(), getPvdNamespacedNameForType<TChildType>());
+ }
+
+ virtual bool isClassExist(const NamespacedName& nm) = 0;
+ template <typename TDataType>
+ bool isClassExist()
+ {
+ return isClassExist(getPvdNamespacedNameForType<TDataType>());
+ }
+
+ virtual PvdError createProperty(const NamespacedName& clsName, const char* name, const char* semantic,
+ const NamespacedName& dtypeName, PropertyType::Enum propertyType,
+ DataRef<NamedValue> values = DataRef<NamedValue>()) = 0;
+ template <typename TClsType, typename TDataType>
+ PvdError createProperty(String name, String semantic = "", PropertyType::Enum propertyType = PropertyType::Scalar,
+ DataRef<NamedValue> values = DataRef<NamedValue>())
+ {
+ return createProperty(getPvdNamespacedNameForType<TClsType>(), name, semantic,
+ getPvdNamespacedNameForType<TDataType>(), propertyType, values);
+ }
+
+ virtual PvdError createPropertyMessage(const NamespacedName& cls, const NamespacedName& msgName,
+ DataRef<PropertyMessageArg> entries, uint32_t messageSizeInBytes) = 0;
+
+ template <typename TClsType, typename TMsgType>
+ PvdError createPropertyMessage(DataRef<PropertyMessageArg> entries)
+ {
+ return createPropertyMessage(getPvdNamespacedNameForType<TClsType>(), getPvdNamespacedNameForType<TMsgType>(),
+ entries, sizeof(TMsgType));
+ }
+};
+
+class PvdInstanceDataStream
+{
+ protected:
+ virtual ~PvdInstanceDataStream()
+ {
+ }
+
+ public:
+ virtual PvdError createInstance(const NamespacedName& cls, const void* instance) = 0;
+
+ template <typename TDataType>
+ PvdError createInstance(const TDataType* inst)
+ {
+ return createInstance(getPvdNamespacedNameForType<TDataType>(), inst);
+ }
+ virtual bool isInstanceValid(const void* instance) = 0;
+
+ // If the property will fit or is already completely in memory
+ virtual PvdError setPropertyValue(const void* instance, String name, DataRef<const uint8_t> data,
+ const NamespacedName& incomingTypeName) = 0;
+ template <typename TDataType>
+ PvdError setPropertyValue(const void* instance, String name, const TDataType& value)
+ {
+ const uint8_t* dataStart = reinterpret_cast<const uint8_t*>(&value);
+ return setPropertyValue(instance, name, DataRef<const uint8_t>(dataStart, dataStart + sizeof(TDataType)),
+ getPvdNamespacedNameForType<TDataType>());
+ }
+
+ template <typename TDataType>
+ PvdError setPropertyValue(const void* instance, String name, const TDataType* value, uint32_t numItems)
+ {
+ const uint8_t* dataStart = reinterpret_cast<const uint8_t*>(value);
+ return setPropertyValue(instance, name,
+ DataRef<const uint8_t>(dataStart, dataStart + sizeof(TDataType) * numItems),
+ getPvdNamespacedNameForType<TDataType>());
+ }
+
+ // Else if the property is very large (contact reports) you can send it in chunks.
+ virtual PvdError beginSetPropertyValue(const void* instance, String name, const NamespacedName& incomingTypeName) = 0;
+
+ template <typename TDataType>
+ PvdError beginSetPropertyValue(const void* instance, String name)
+ {
+ return beginSetPropertyValue(instance, name, getPvdNamespacedNameForType<TDataType>());
+ }
+ virtual PvdError appendPropertyValueData(DataRef<const uint8_t> data) = 0;
+
+ template <typename TDataType>
+ PvdError appendPropertyValueData(const TDataType* value, uint32_t numItems)
+ {
+ const uint8_t* dataStart = reinterpret_cast<const uint8_t*>(value);
+ return appendPropertyValueData(DataRef<const uint8_t>(dataStart, dataStart + numItems * sizeof(TDataType)));
+ }
+
+ virtual PvdError endSetPropertyValue() = 0;
+
+ // Set a set of properties to various values on an object.
+
+ virtual PvdError setPropertyMessage(const void* instance, const NamespacedName& msgName,
+ DataRef<const uint8_t> data) = 0;
+
+ template <typename TDataType>
+ PvdError setPropertyMessage(const void* instance, const TDataType& value)
+ {
+ const uint8_t* dataStart = reinterpret_cast<const uint8_t*>(&value);
+ return setPropertyMessage(instance, getPvdNamespacedNameForType<TDataType>(),
+ DataRef<const uint8_t>(dataStart, sizeof(TDataType)));
+ }
+ // If you need to send of lot of identical messages, this avoids a hashtable lookup per message.
+ virtual PvdError beginPropertyMessageGroup(const NamespacedName& msgName) = 0;
+
+ template <typename TDataType>
+ PvdError beginPropertyMessageGroup()
+ {
+ return beginPropertyMessageGroup(getPvdNamespacedNameForType<TDataType>());
+ }
+ virtual PvdError sendPropertyMessageFromGroup(const void* instance, DataRef<const uint8_t> data) = 0;
+
+ template <typename TDataType>
+ PvdError sendPropertyMessageFromGroup(const void* instance, const TDataType& value)
+ {
+ const uint8_t* dataStart = reinterpret_cast<const uint8_t*>(&value);
+ return sendPropertyMessageFromGroup(instance, DataRef<const uint8_t>(dataStart, sizeof(TDataType)));
+ }
+
+ virtual PvdError endPropertyMessageGroup() = 0;
+
+ // These functions ensure the target array doesn't contain duplicates
+ virtual PvdError pushBackObjectRef(const void* instId, String propName, const void* objRef) = 0;
+ virtual PvdError removeObjectRef(const void* instId, String propName, const void* objRef) = 0;
+
+ // Instance elimination.
+ virtual PvdError destroyInstance(const void* key) = 0;
+
+ // Profiling hooks
+ virtual PvdError beginSection(const void* instance, String name) = 0;
+ virtual PvdError endSection(const void* instance, String name) = 0;
+
+ // Origin Shift
+ virtual PvdError originShift(const void* scene, PxVec3 shift) = 0;
+
+ public:
+ /*For some cases, pvd command cannot be run immediately. For example, when create joints, while the actors may still
+ *pending for insert, the joints update commands can be run deffered.
+ */
+ class PvdCommand
+ {
+ public:
+ // Assigned is needed for copying
+ PvdCommand(const PvdCommand&)
+ {
+ }
+ PvdCommand& operator=(const PvdCommand&)
+ {
+ return *this;
+ }
+
+ public:
+ PvdCommand()
+ {
+ }
+ virtual ~PvdCommand()
+ {
+ }
+
+ // Not pure virtual so can have default PvdCommand obj
+ virtual bool canRun(PvdInstanceDataStream&)
+ {
+ return false;
+ }
+ virtual void run(PvdInstanceDataStream&)
+ {
+ }
+ };
+
+ // PVD SDK provide this helper function to allocate cmd's memory and release them at after flush the command queue
+ virtual void* allocateMemForCmd(uint32_t length) = 0;
+
+ // PVD will call the destructor of PvdCommand object at the end fo flushPvdCommand
+ virtual void pushPvdCommand(PvdCommand& cmd) = 0;
+ virtual void flushPvdCommand() = 0;
+};
+
+class PvdDataStream : public PvdInstanceDataStream, public PvdMetaDataStream
+{
+ protected:
+ virtual ~PvdDataStream()
+ {
+ }
+
+ public:
+ virtual void release() = 0;
+ virtual bool isConnected() = 0;
+
+ virtual void addProfileZone(void* zone, const char* name) = 0;
+ virtual void addProfileZoneEvent(void* zone, const char* name, uint16_t eventId, bool compileTimeEnabled) = 0;
+
+ virtual PvdPropertyDefinitionHelper& getPropertyDefinitionHelper() = 0;
+
+ virtual void setIsTopLevelUIElement(const void* instance, bool topLevel) = 0;
+ virtual void sendErrorMessage(uint32_t code, const char* message, const char* file, uint32_t line) = 0;
+ virtual void updateCamera(const char* name, const PxVec3& origin, const PxVec3& up, const PxVec3& target) = 0;
+
+/**
+ \brief Create a new PvdDataStream.
+ \param pvd A pointer to a valid PxPvd instance. This must be non-null.
+*/
+ PX_PVDSDK_API static PvdDataStream* create(PxPvd* pvd);
+};
+#if !PX_DOXYGEN
+} // pvdsdk
+} // physx
+#endif
+
+/** @} */
+#endif // PXPVDSDK_PXPVDDATASTREAM_H