PxCollection.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_PX_COLLECTION
#define PX_PHYSICS_PX_COLLECTION

#include "PxSerialFramework.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxBase;

class PxCollection
{
public: 

    virtual void                        add(PxBase& object, PxSerialObjectId id = PX_SERIAL_OBJECT_ID_INVALID) = 0;

    virtual void                        remove(PxBase& object) = 0;

    PX_DEPRECATED PX_INLINE  void       addRequired(PxBase& object) { if(!contains(object)) add(object); }
            
    virtual bool                        contains(PxBase& object) const = 0;

    virtual void                        addId(PxBase& object, PxSerialObjectId id) = 0;

    virtual void                        removeId(PxSerialObjectId id) = 0;
    
    virtual void                        add(PxCollection& collection) = 0;

    virtual void                        remove(PxCollection& collection) = 0;

    virtual PxU32                       getNbObjects() const = 0;

    virtual PxBase&                     getObject(PxU32 index) const = 0;

    virtual PxU32                       getObjects(PxBase** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;

    virtual PxBase*                     find(PxSerialObjectId id) const = 0;
    
    virtual PxU32                       getNbIds() const = 0;

    virtual PxU32                       getIds(PxSerialObjectId* userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;

    virtual PxSerialObjectId            getId(const PxBase& object) const = 0;  

    virtual void                        release() = 0;

protected:
                                        PxCollection()  {}
    virtual                             ~PxCollection() {}
};
    
#ifndef PX_DOXYGEN
} // namespace physx
#endif

PX_PHYSX_COMMON_API physx::PxCollection* PX_CALL_CONV PxCreateCollection();


#endif