NxParamUtils.h

// 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-2014 NVIDIA Corporation. All rights reserved.

#ifndef NX_PARAM_UTILS_H
#define NX_PARAM_UTILS_H

#include "NxParameterized.h"

// utility methods to operate on NxParameterized data.

namespace NxParameterized
{

PX_INLINE const Interface * findParam(const Interface &i,const char *longName, Handle &outHandle);


PX_INLINE Interface * findParam(Interface &i,const char *longName, Handle &outHandle);

struct ParamResult
{
public:
    ParamResult(const char *name,
                const char *longName,
                const char *className,
                const char *instanceName,
                const Handle &handle,
                physx::PxI32 arraySize,
                DataType type)
        : mArraySize(arraySize),
        mInstanceName(instanceName),
        mClassName(className),
        mName(name),
        mLongName(longName),
        mHandle(handle),
        mDataType(type)
    {}

    physx::PxI32 mArraySize;

    const char *mInstanceName;

    const char *mClassName;

    const char *mName;

    const char *mLongName;

    Handle mHandle;

    DataType mDataType;
};

PX_INLINE const ParamResult * getParamList(const Interface &i,
                                 const char *className, // name of class to match
                                 const char *paramName, // name of parameter to match
                                 physx::PxU32 &count,
                                 bool recursive,
                                 bool classesOnly,
                                 NxParameterized::Traits *traits);

PX_INLINE void              releaseParamList(physx::PxU32 resultCount,const ParamResult *results,NxParameterized::Traits *traits);

PX_INLINE bool getParamArraySize(const Interface &pm, const char *name, physx::PxI32 &arraySize);

PX_INLINE bool resizeParamArray(Interface &pm, const char *name, physx::PxI32 newSize);

class NamedReferenceInterface
{
public:
    virtual const char * namedReferenceCallback(const char *className,const char *namedReference,Handle &handle) = 0;
};

PX_INLINE physx::PxU32 getNamedReferences(const Interface &i,
                                          NamedReferenceInterface &namedReference,
                                          bool recursive);

class ReferenceInterface
{
public:
    virtual void referenceCallback(Handle &handle) = 0;
};

PX_INLINE void getReferences(const Interface &iface,
                                          ReferenceInterface &cb,
                                          bool named,
                                          bool included,
                                          bool recursive);

PX_INLINE bool getParamBool(const Interface &pm, const char *name, bool &val);
PX_INLINE bool setParamBool(Interface &pm, const char *name, bool val) ;

PX_INLINE bool getParamString(const Interface &pm, const char *name, const char *&val);
PX_INLINE bool setParamString(Interface &pm, const char *name, const char *val) ;

PX_INLINE bool getParamEnum(const Interface &pm, const char *name, const char *&val);
PX_INLINE bool setParamEnum(Interface &pm, const char *name, const char *val) ;

PX_INLINE bool getParamRef(const Interface &pm, const char *name, NxParameterized::Interface *&val);
PX_INLINE bool setParamRef(Interface &pm, const char *name, NxParameterized::Interface *val, bool doDestroyOld = false) ;

PX_INLINE bool initParamRef(Interface &pm, const char *name, const char *className, bool doDestroyOld = false);
PX_INLINE bool initParamRef(Interface &pm, const char *name, const char *className, const char *objName, bool doDestroyOld = false);

PX_INLINE bool getParamI8(const Interface &pm, const char *name, physx::PxI8 &val);
PX_INLINE bool setParamI8(Interface &pm, const char *name, physx::PxI8 val) ;

PX_INLINE bool getParamI16(const Interface &pm, const char *name, physx::PxI16 &val);
PX_INLINE bool setParamI16(Interface &pm, const char *name, physx::PxI16 val) ;

PX_INLINE bool getParamI32(const Interface &pm, const char *name, physx::PxI32 &val);
PX_INLINE bool setParamI32(Interface &pm, const char *name, physx::PxI32 val) ;

PX_INLINE bool getParamI64(const Interface &pm, const char *name, physx::PxI64 &val);
PX_INLINE bool setParamI64(Interface &pm, const char *name, physx::PxI64 val) ;

PX_INLINE bool getParamU8(const Interface &pm, const char *name, physx::PxU8 &val);
PX_INLINE bool setParamU8(Interface &pm, const char *name, physx::PxU8 val) ;

PX_INLINE bool getParamU16(const Interface &pm, const char *name, physx::PxU16 &val);
PX_INLINE bool setParamU16(Interface &pm, const char *name, physx::PxU16 val) ;

PX_INLINE bool getParamU32(const Interface &pm, const char *name, physx::PxU32 &val);
PX_INLINE bool setParamU32(Interface &pm, const char *name, physx::PxU32 val) ;

PX_INLINE bool getParamU64(const Interface &pm, const char *name, physx::PxU64 &val);
PX_INLINE bool setParamU64(Interface &pm, const char *name, physx::PxU64 val) ;

PX_INLINE bool getParamF32(const Interface &pm, const char *name, physx::PxF32 &val);
PX_INLINE bool setParamF32(Interface &pm, const char *name, physx::PxF32 val) ;

PX_INLINE bool getParamF64(const Interface &pm, const char *name, physx::PxF64 &val);
PX_INLINE bool setParamF64(Interface &pm, const char *name, physx::PxF64 val) ;

PX_INLINE bool getParamVec2(const Interface &pm, const char *name, physx::PxVec2 &val);
PX_INLINE bool setParamVec2(Interface &pm, const char *name, const physx::PxVec2 &val) ;

PX_INLINE bool getParamVec3(const Interface &pm, const char *name, physx::PxVec3 &val);
PX_INLINE bool setParamVec3(Interface &pm, const char *name, const physx::PxVec3 &val) ;

PX_INLINE bool getParamVec4(const Interface &pm, const char *name, physx::PxVec4 &val);
PX_INLINE bool setParamVec4(Interface &pm, const char *name, const physx::PxVec4 &val) ;

PX_INLINE bool getParamQuat(const Interface &pm, const char *name, physx::PxQuat &val);
PX_INLINE bool setParamQuat(Interface &pm, const char *name, const physx::PxQuat &val) ;

PX_INLINE bool getParamMat33(const Interface &pm, const char *name, physx::PxMat33 &val);
PX_INLINE bool setParamMat33(Interface &pm, const char *name, const physx::PxMat33 &val) ;

PX_INLINE bool getParamMat34(const Interface &pm, const char *name, physx::PxMat44 &val);
PX_INLINE bool setParamMat34(Interface &pm, const char *name, const physx::PxMat44 &val) ;

PX_INLINE bool getParamMat44(const Interface &pm, const char *name, physx::PxMat44 &val);
PX_INLINE bool setParamMat44(Interface &pm, const char *name, const physx::PxMat44 &val) ;

PX_INLINE bool getParamBounds3(const Interface &pm, const char *name, physx::PxBounds3 &val);
PX_INLINE bool setParamBounds3(Interface &pm, const char *name, const physx::PxBounds3 &val) ;

PX_INLINE bool getParamTransform(const Interface &pm, const char *name, physx::PxTransform &val);
PX_INLINE bool setParamTransform(Interface &pm, const char *name, const physx::PxTransform &val) ;

} // namespace NxParameterized


#include "NxParamUtils.inl"

#endif // NX_PARAM_UTILS_H