NxApexPhysXObjectDesc.h

Go to the documentation of this file.

// 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_APEX_PHYS_XOBJECT_DESC_H
#define NX_APEX_PHYS_XOBJECT_DESC_H

#include "NxApexUsingNamespace.h"

namespace physx
{
namespace apex
{

class NxApexActor;

PX_PUSH_PACK_DEFAULT

class NxApexPhysXObjectDesc
{
protected:
    physx::PxU32                mFlags;

    enum
    {
        TRANSFORM   = (1U << 31),   
        RAYCASTS    = (1U << 30), 
        CONTACTS    = (1U << 29) 
    };


public:
    virtual physx::PxU32                getApexActorCount() const = 0;
    virtual const NxApexActor*  getApexActor(physx::PxU32 i) const = 0;

    bool ignoreTransform() const
    {
        return (mFlags & (physx::PxU32)TRANSFORM) ? true : false;
    }
    bool ignoreRaycasts() const
    {
        return (mFlags & (physx::PxU32)RAYCASTS) ? true : false;
    }
    bool ignoreContacts() const
    {
        return (mFlags & (physx::PxU32)CONTACTS) ? true : false;
    }
    bool getUserDefinedFlag(physx::PxU32 index) const
    {
        return (mFlags & (physx::PxU32)(1 << index)) ? true : false;
    }

    void*               userData;
};

// To get owning NxApexActor's authorable object type name:
//      getActor()->getOwner()->getAuthObjName();
// To get owning NxApexActor's authorable object type ID:
//      getActor()->getOwner()->getAuthObjType();

PX_POP_PACK

}
} // end namespace physx::apex

#endif // NX_APEX_PHYS_XOBJECT_DESC_H