PxCoreUtilityTypes.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2022 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  
 
#ifndef PX_CORE_UTILITY_TYPES_H
#define PX_CORE_UTILITY_TYPES_H
#include "foundation/PxAssert.h"
#include "foundation/PxMemory.h"
 
#if !PX_DOXYGEN
namespace physx
{
#endif
 
 
struct PxStridedData
{
    PxU32 stride;
    const void* data;
 
    PxStridedData() : stride( 0 ), data( NULL ) {}
 
    template<typename TDataType>
    PX_INLINE const TDataType& at( PxU32 idx ) const
    {
        PxU32 theStride( stride );
        if ( theStride == 0 )
            theStride = sizeof( TDataType );
        PxU32 offset( theStride * idx );
        return *(reinterpret_cast<const TDataType*>( reinterpret_cast< const PxU8* >( data ) + offset ));
    }
};
 
template<typename TDataType>
struct PxTypedStridedData
{
    PxU32 stride;
    const TDataType* data;
 
    PxTypedStridedData()
        : stride( 0 )
        , data( NULL )
    {
    }
 
    PxTypedStridedData(const TDataType* data_, PxU32 stride_ = 0)
        : stride(stride_)
        , data(data_)
    {
    }
    
    PX_INLINE const TDataType& at(PxU32 idx) const
    {
        PxU32 theStride(stride);
        if (theStride == 0)
            theStride = sizeof(TDataType);
        PxU32 offset(theStride * idx);
        return *(reinterpret_cast<const TDataType*>(reinterpret_cast<const PxU8*>(data) + offset));
    }
};
 
struct PxBoundedData : public PxStridedData
{
    PxU32 count;
    PxBoundedData() : count( 0 ) {}
};
 
template<PxU8 TNumBytes>
struct PxPadding
{
    PxU8 mPadding[TNumBytes];
    PxPadding()
    {
        for ( PxU8 idx =0; idx < TNumBytes; ++idx )
            mPadding[idx] = 0;
    }
};
 
template <PxU32 NB_ELEMENTS> class PxFixedSizeLookupTable
{
//= ATTENTION! =====================================================================================
// Changing the data layout of this class breaks the binary serialization format.  See comments for 
// PX_BINARY_SERIAL_VERSION.  If a modification is required, please adjust the getBinaryMetaData 
// function.  If the modification is made on a custom branch, please change PX_BINARY_SERIAL_VERSION
// accordingly.
//==================================================================================================
public:
    
    PxFixedSizeLookupTable() 
        : mNbDataPairs(0)
    {
    }
 
    PxFixedSizeLookupTable(const PxEMPTY) {}
 
    PxFixedSizeLookupTable(const PxReal* dataPairs, const PxU32 numDataPairs)
    {
        PxMemCopy(mDataPairs,dataPairs,sizeof(PxReal)*2*numDataPairs);
        mNbDataPairs=numDataPairs;
    }
 
    PxFixedSizeLookupTable(const PxFixedSizeLookupTable& src)
    {
        PxMemCopy(mDataPairs,src.mDataPairs,sizeof(PxReal)*2*src.mNbDataPairs);
        mNbDataPairs=src.mNbDataPairs;
    }
 
    ~PxFixedSizeLookupTable()
    {
    }
 
    PxFixedSizeLookupTable& operator=(const PxFixedSizeLookupTable& src)
    {
        PxMemCopy(mDataPairs,src.mDataPairs,sizeof(PxReal)*2*src.mNbDataPairs);
        mNbDataPairs=src.mNbDataPairs;
        return *this;
    }
 
    PX_FORCE_INLINE void addPair(const PxReal x, const PxReal y)
    {
        PX_ASSERT(mNbDataPairs<NB_ELEMENTS);
        mDataPairs[2*mNbDataPairs+0]=x;
        mDataPairs[2*mNbDataPairs+1]=y;
        mNbDataPairs++;
    }
 
    PX_FORCE_INLINE PxReal getYVal(const PxReal x) const
    {
        if(0==mNbDataPairs)
        {
            PX_ASSERT(false);
            return 0;
        }
 
        if(1==mNbDataPairs || x<getX(0))
        {
            return getY(0);
        }
 
        PxReal x0=getX(0);
        PxReal y0=getY(0);
 
        for(PxU32 i=1;i<mNbDataPairs;i++)
        {
            const PxReal x1=getX(i);
            const PxReal y1=getY(i);
 
            if((x>=x0)&&(x<x1))
            {
                return (y0+(y1-y0)*(x-x0)/(x1-x0));
            }
 
            x0=x1;
            y0=y1;
        }
 
        PX_ASSERT(x>=getX(mNbDataPairs-1));
        return getY(mNbDataPairs-1);
    }
 
    PxU32 getNbDataPairs() const {return mNbDataPairs;}
    
    void clear()
    {
        PxMemSet(mDataPairs, 0, NB_ELEMENTS*2*sizeof(PxReal));
        mNbDataPairs = 0;
    }
 
    PX_FORCE_INLINE PxReal getX(const PxU32 i) const
    {
        return mDataPairs[2*i];
    }
    PX_FORCE_INLINE PxReal getY(const PxU32 i) const
    {
        return mDataPairs[2*i+1];
    }
 
    PxReal mDataPairs[2*NB_ELEMENTS];
    PxU32 mNbDataPairs;
    PxU32 mPad[3];
 
    
};
 
#if !PX_DOXYGEN
} // namespace physx
#endif
 
#endif