PxActor.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, 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.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_PHYSICS_NX_ACTOR
#define PX_PHYSICS_NX_ACTOR

#include "PxPhysXConfig.h"
#include "foundation/PxBounds3.h"
#include "PxClient.h"
#include "common/PxBase.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxRigidActor;
class PxRigidBody;
class PxRigidStatic;
class PxRigidDynamic;
class PxParticleBase;
class PxParticleSystem;
class PxParticleFluid;
class PxArticulation;
class PxArticulationLink;


typedef PxU8 PxDominanceGroup;      // Must be < 32, PxU8.

struct PxActorFlag
{
    enum Enum
    {
        eVISUALIZATION                  = (1<<0),

        eDISABLE_GRAVITY                = (1<<1),

        eSEND_SLEEP_NOTIFIES            = (1<<2),

        eDISABLE_SIMULATION             = (1<<3)

    };
};

typedef PxFlags<PxActorFlag::Enum,PxU16> PxActorFlags;
PX_FLAGS_OPERATORS(PxActorFlag::Enum,PxU16)


struct PxActorType
{
    enum Enum
    {
        eRIGID_STATIC,

        eRIGID_DYNAMIC,

#if PX_USE_PARTICLE_SYSTEM_API

        ePARTICLE_SYSTEM,

        ePARTICLE_FLUID,
#endif
        
        eARTICULATION_LINK,

#if PX_USE_CLOTH_API

        eCLOTH,
#endif

        //brief internal use only!
        eACTOR_COUNT,

        eACTOR_FORCE_DWORD = 0x7fffffff
    };
};

class PxActor : public PxBase
{
public:
    virtual     void            release() = 0;

    virtual     PxActorType::Enum   getType()   const = 0;


    PX_DEPRECATED   PX_INLINE   PxRigidStatic*              isRigidStatic();
    PX_DEPRECATED   PX_INLINE   const PxRigidStatic*        isRigidStatic()         const;
    PX_DEPRECATED   PX_INLINE   PxRigidDynamic*             isRigidDynamic();
    PX_DEPRECATED   PX_INLINE   const PxRigidDynamic*       isRigidDynamic()        const;
    PX_DEPRECATED   PX_INLINE   PxParticleSystem*           isParticleSystem();
    PX_DEPRECATED   PX_INLINE   const PxParticleSystem*     isParticleSystem()      const;
    PX_DEPRECATED   PX_INLINE   PxParticleFluid*            isParticleFluid();
    PX_DEPRECATED   PX_INLINE   const PxParticleFluid*      isParticleFluid()       const;
    PX_DEPRECATED   PX_INLINE   PxArticulationLink*         isArticulationLink();
    PX_DEPRECATED   PX_INLINE   const PxArticulationLink*   isArticulationLink()    const;
    PX_DEPRECATED   PX_INLINE   PxCloth*                    isCloth();
    PX_DEPRECATED   PX_INLINE   const PxCloth*              isCloth()               const;

    PX_DEPRECATED   PX_INLINE   PxRigidActor*               isRigidActor();
    PX_DEPRECATED   PX_INLINE   const PxRigidActor*         isRigidActor()          const;
    PX_DEPRECATED   PX_INLINE   PxRigidBody*                isRigidBody();
    PX_DEPRECATED   PX_INLINE   const PxRigidBody*          isRigidBody()           const;
    PX_DEPRECATED   PX_INLINE   PxParticleBase*             isParticleBase();
    PX_DEPRECATED   PX_INLINE   const PxParticleBase*       isParticleBase()        const;

    virtual     PxScene*        getScene()  const = 0;

    // Runtime modifications

    virtual     void            setName(const char* name)       = 0;

    virtual     const char*     getName()           const   = 0;

    virtual     PxBounds3       getWorldBounds(float inflation=1.01f) const = 0;

    virtual     void            setActorFlag(PxActorFlag::Enum flag, bool value) = 0;
    virtual     void            setActorFlags( PxActorFlags inFlags ) = 0;

    virtual     PxActorFlags    getActorFlags() const = 0;

    virtual     void            setDominanceGroup(PxDominanceGroup dominanceGroup)       = 0;
    
    virtual     PxDominanceGroup    getDominanceGroup() const = 0;

    
    virtual     void            setOwnerClient( PxClientID inClient ) = 0;

    virtual     PxClientID      getOwnerClient() const = 0;

    virtual     void            setClientBehaviorFlags(PxActorClientBehaviorFlags) = 0;

    virtual     PxActorClientBehaviorFlags  getClientBehaviorFlags()    const = 0;

    virtual     PxAggregate*    getAggregate()  const = 0;

    //public variables:
                void*           userData;   


protected:
    PX_INLINE                   PxActor(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags), userData(NULL) {}
    PX_INLINE                   PxActor(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
    virtual                     ~PxActor()  {}
    virtual     bool            isKindOf(const char* name)  const       {   return !strcmp("PxActor", name) || PxBase::isKindOf(name); }


};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif