Inheritance diagram for OmniPvdReaderImpl:

Collaboration diagram for OmniPvdReaderImpl:

Public Member Functions
void OMNI_PVD_CALL	setLogFunction (OmniPvdLogFunction logFunction)
	Sets the log function to print the internal debug messages of the OmniPVD Reader instance.

void OMNI_PVD_CALL	setReadStream (OmniPvdReadStream *stream)
	Sets the read stream that contains the OmniPVD API command stream.

bool OMNI_PVD_CALL	startReading (OmniPvdVersionType majorVersion, OmniPvdVersionType minorVersion, OmniPvdVersionType *patch)
	Extracts the versions from the binary file ro read and tests if the file is older or equal to that of the reader.

OmniPvdCommandEnum::Enum OMNI_PVD_CALL	getNextCommand ()
	The heartbeat function of the reader class. As long as the command that is returned is not equal to OmniPvdCommandEnum::eOmniPvdInvalid, then one can safely extract the data fields from the command.

OmniPvdCommandEnum::Enum OMNI_PVD_CALL	getCommandType ()
	Returns the command type as an enumerator of the latest command.

OmniPvdVersionType OMNI_PVD_CALL	getMajorVersion ()
	Returns the major version of the stream.

OmniPvdVersionType OMNI_PVD_CALL	getMinorVersion ()
	Returns the minor version of the stream.

OmniPvdVersionType OMNI_PVD_CALL	getPatch ()
	Returns the patch number of the stream.

OmniPvdContextHandle OMNI_PVD_CALL	getContextHandle ()
	Returns the context handle of the latest commmnd, if it had one, else 0.

OmniPvdObjectHandle OMNI_PVD_CALL	getObjectHandle ()
	Returns the object handle of the latest commmnd, if it had one, else 0.

OmniPvdClassHandle OMNI_PVD_CALL	getClassHandle ()
	Returns the class handle of the latest commmnd, if it had one, else 0.

OmniPvdClassHandle OMNI_PVD_CALL	getBaseClassHandle ()
	Returns the base class handle of the latest commmnd, if it had one, else 0.

OmniPvdAttributeHandle OMNI_PVD_CALL	getAttributeHandle ()
	Returns the attribute handle of the latest commmnd, if it had one, else 0.

char *OMNI_PVD_CALL	getClassName ()
	Returns the class name of the latest commmnd, if it had one, else a null terminated string of length 0.

char *OMNI_PVD_CALL	getAttributeName ()
	Returns the attribute name of the latest commmnd, if it had one, else a null terminated string of length 0.

char *OMNI_PVD_CALL	getObjectName ()
	Returns the object name of the latest commmnd, if it had one, else a null terminated string of length 0.

uint8_t *OMNI_PVD_CALL	getAttributeDataPointer ()
	Returns the attribute data pointer, the data is undefined if the last command did not contain attribute data.

OmniPvdAttributeDataType OMNI_PVD_CALL	getAttributeDataType ()
	Returns the attribute data type, the data is undefined if the last command did not contain attribute data.

uint32_t OMNI_PVD_CALL	getAttributeDataLength ()
	Returns the attribute data length, the data length of the last command.

uint32_t OMNI_PVD_CALL	getAttributeNumberElements ()
	Returns the number of elements contained in the last set operation.

OmniPvdClassHandle OMNI_PVD_CALL	getAttributeClassHandle ()
	Returns the numberclass handle of the attribute class.

uint8_t OMNI_PVD_CALL	getAttributeNumberHandles ()

OmniPvdAttributeHandle *OMNI_PVD_CALL	getAttributeHandles ()

uint64_t OMNI_PVD_CALL	getFrameTimeStart ()
	Returns the frame start value.

uint64_t OMNI_PVD_CALL	getFrameTimeStop ()
	Returns the frame stop value.

OmniPvdClassHandle OMNI_PVD_CALL	getEnumClassHandle ()
	Returns the class handle containing the enum values.

uint32_t OMNI_PVD_CALL	getEnumValue ()
	Returns the enum value for a specific flag.

void	readLongDataFromStream (uint32_t streamByteLen)

Public Attributes
OmniPvdLog	mLog

OmniPvdReadStream *	mStream

OmniPvdVersionType	mMajorVersion

OmniPvdVersionType	mMinorVersion

OmniPvdVersionType	mPatch

OmniPvdCommandEnum::Enum	mCmdType

OmniPvdVersionType	mCmdMajorVersion

OmniPvdVersionType	mCmdMinorVersion

OmniPvdVersionType	mCmdPatch

OmniPvdContextHandle	mCmdContextHandle

OmniPvdObjectHandle	mCmdObjectHandle

uint32_t	mCmdClassHandle

uint32_t	mCmdBaseClassHandle

uint32_t	mCmdAttributeHandle

char	mCmdClassName [1000]

char	mCmdAttributeName [1000]

char	mCmdObjectName [1000]

uint16_t	mCmdClassNameLen

uint16_t	mCmdAttributeNameLen

uint16_t	mCmdObjectNameLen

uint8_t *	mCmdAttributeDataPtr

OmniPvdAttributeDataType	mCmdAttributeDataType

uint32_t	mCmdAttributeDataLen

uint32_t	mCmdAttributeNbrFields

uint32_t	mCmdEnumValue

OmniPvdClassHandle	mCmdEnumClassHandle

OmniPvdClassHandle	mCmdAttributeClassHandle

OmniPvdAttributeHandle	mCmdAttributeHandleStack [32]

uint8_t	mCmdAttributeHandleDepth

uint64_t	mCmdFrameTimeStart

uint64_t	mCmdFrameTimeStop

uint8_t *	mDataBuffer

uint32_t	mDataBuffAllocatedLen

bool	mIsReadingStarted

uint8_t	mReadBaseClassHandle

Member Function Documentation

◆ getAttributeClassHandle()

OmniPvdClassHandle OMNI_PVD_CALL OmniPvdReaderImpl::getAttributeClassHandle ( )

virtual

Returns the numberclass handle of the attribute class.

Returns: The attibute class handle

Implements OmniPvdReader.

◆ getAttributeDataLength()

uint32_t OMNI_PVD_CALL OmniPvdReaderImpl::getAttributeDataLength ( )

virtual

Returns the attribute data length, the data length of the last command.

Returns: The attribute data length

Implements OmniPvdReader.

◆ getAttributeDataPointer()

uint8_t *OMNI_PVD_CALL OmniPvdReaderImpl::getAttributeDataPointer ( )

virtual

Returns the attribute data pointer, the data is undefined if the last command did not contain attribute data.

Returns: The array containing the attribute data

Implements OmniPvdReader.

◆ getAttributeDataType()

uint16_t OMNI_PVD_CALL OmniPvdReaderImpl::getAttributeDataType ( )

virtual

Returns the attribute data type, the data is undefined if the last command did not contain attribute data.

Returns: The attribute data type

Implements OmniPvdReader.

◆ getAttributeHandle()

uint32_t OMNI_PVD_CALL OmniPvdReaderImpl::getAttributeHandle ( )

virtual

Returns the attribute handle of the latest commmnd, if it had one, else 0.

Returns: The attribute handle of the latest command

Implements OmniPvdReader.

◆ getAttributeName()

char *OMNI_PVD_CALL OmniPvdReaderImpl::getAttributeName ( )

virtual

Returns the attribute name of the latest commmnd, if it had one, else a null terminated string of length 0.

Returns: The string containing the attribute name

Implements OmniPvdReader.

◆ getAttributeNumberElements()

uint32_t OMNI_PVD_CALL OmniPvdReaderImpl::getAttributeNumberElements ( )

virtual

Returns the number of elements contained in the last set operation.

Returns: The number of elements

Implements OmniPvdReader.

◆ getBaseClassHandle()

OmniPvdClassHandle OMNI_PVD_CALL OmniPvdReaderImpl::getBaseClassHandle ( )

virtual

Returns the base class handle of the latest commmnd, if it had one, else 0.

Returns: The base class handle of the latest command

Implements OmniPvdReader.

◆ getClassHandle()

OmniPvdClassHandle OMNI_PVD_CALL OmniPvdReaderImpl::getClassHandle ( )

virtual

Returns the class handle of the latest commmnd, if it had one, else 0.

Returns: The class handle of the latest command

Implements OmniPvdReader.

◆ getClassName()

char *OMNI_PVD_CALL OmniPvdReaderImpl::getClassName ( )

virtual

Returns the class name of the latest commmnd, if it had one, else a null terminated string of length 0.

Returns: The string containing the class name

Implements OmniPvdReader.

◆ getCommandType()

OmniPvdCommandEnum::Enum OMNI_PVD_CALL OmniPvdReaderImpl::getCommandType ( )

virtual

Returns the command type as an enumerator of the latest command.

Returns: The latest command enum type

Implements OmniPvdReader.

◆ getContextHandle()

uint64_t OMNI_PVD_CALL OmniPvdReaderImpl::getContextHandle ( )

virtual

Returns the context handle of the latest commmnd, if it had one, else 0.

Returns: The context handle of the latest command

Implements OmniPvdReader.

◆ getEnumClassHandle()

OmniPvdClassHandle OMNI_PVD_CALL OmniPvdReaderImpl::getEnumClassHandle ( )

virtual

Returns the class handle containing the enum values.

Returns: The enum class handle

Implements OmniPvdReader.

◆ getEnumValue()

uint32_t OMNI_PVD_CALL OmniPvdReaderImpl::getEnumValue ( )

virtual

Returns the enum value for a specific flag.

Returns: The enum value

Implements OmniPvdReader.

◆ getFrameTimeStart()

uint64_t OMNI_PVD_CALL OmniPvdReaderImpl::getFrameTimeStart ( )

virtual

Returns the frame start value.

Returns: The frame ID value

Implements OmniPvdReader.

◆ getFrameTimeStop()

uint64_t OMNI_PVD_CALL OmniPvdReaderImpl::getFrameTimeStop ( )

virtual

Returns the frame stop value.

Returns: The frame ID value

Implements OmniPvdReader.

◆ getMajorVersion()

uint32_t OMNI_PVD_CALL OmniPvdReaderImpl::getMajorVersion ( )

virtual

Returns the major version of the stream.

Returns: The major version

Implements OmniPvdReader.

◆ getMinorVersion()

uint32_t OMNI_PVD_CALL OmniPvdReaderImpl::getMinorVersion ( )

virtual

Returns the minor version of the stream.

Returns: The minor version

Implements OmniPvdReader.

◆ getNextCommand()

OmniPvdCommandEnum::Enum OMNI_PVD_CALL OmniPvdReaderImpl::getNextCommand ( )

virtual

The heartbeat function of the reader class. As long as the command that is returned is not equal to OmniPvdCommandEnum::eOmniPvdInvalid, then one can safely extract the data fields from the command.

Returns: The command enum type

Implements OmniPvdReader.

◆ getObjectHandle()

uint64_t OMNI_PVD_CALL OmniPvdReaderImpl::getObjectHandle ( )

virtual

Returns the object handle of the latest commmnd, if it had one, else 0.

Returns: The object handle of the latest command

Implements OmniPvdReader.

◆ getObjectName()

char *OMNI_PVD_CALL OmniPvdReaderImpl::getObjectName ( )

virtual

Returns the object name of the latest commmnd, if it had one, else a null terminated string of length 0.

Returns: The string containing the object name

Implements OmniPvdReader.

◆ getPatch()

uint32_t OMNI_PVD_CALL OmniPvdReaderImpl::getPatch ( )

virtual

Returns the patch number of the stream.

Returns: The patch value

Implements OmniPvdReader.

◆ setLogFunction()

void OMNI_PVD_CALL OmniPvdReaderImpl::setLogFunction ( OmniPvdLogFunction logFunction )

virtual

Sets the log function to print the internal debug messages of the OmniPVD Reader instance.

Parameters

logFunction The function pointer to receive the log messages

Implements OmniPvdReader.

◆ setReadStream()

void OMNI_PVD_CALL OmniPvdReaderImpl::setReadStream ( OmniPvdReadStream * stream )

virtual

Sets the read stream that contains the OmniPVD API command stream.

Parameters

stream The OmniPvdReadStream that holds the stream of API calls/notifications

Implements OmniPvdReader.

◆ startReading()

bool OMNI_PVD_CALL OmniPvdReaderImpl::startReading	(	OmniPvdVersionType *	majorVersion,
		OmniPvdVersionType *	minorVersion,
		OmniPvdVersionType *	patch
	)

virtual

Extracts the versions from the binary file ro read and tests if the file is older or equal to that of the reader.

Parameters

majorVersion	The major versions of the stream
minorVersion	The minor versions of the stream
patch	The patch number of the stream

Returns: If the reading was possible to start or not

Implements OmniPvdReader.

The documentation for this class was generated from the following files:

RavEngine/deps/physx/physx/pvdruntime/src/OmniPvdReaderImpl.h
RavEngine/deps/physx/physx/pvdruntime/src/OmniPvdReaderImpl.cpp

Public Member Functions

Public Attributes

Member Function Documentation

◆ getAttributeClassHandle()

◆ getAttributeDataLength()

◆ getAttributeDataPointer()

◆ getAttributeDataType()

◆ getAttributeHandle()

◆ getAttributeName()

◆ getAttributeNumberElements()

◆ getBaseClassHandle()

◆ getClassHandle()

◆ getClassName()

◆ getCommandType()

◆ getContextHandle()

◆ getEnumClassHandle()

◆ getEnumValue()

◆ getFrameTimeStart()

◆ getFrameTimeStop()

◆ getMajorVersion()

◆ getMinorVersion()

◆ getNextCommand()

◆ getObjectHandle()

◆ getObjectName()

◆ getPatch()

◆ setLogFunction()

◆ setReadStream()

◆ startReading()