SnRepXCollection.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 SN_REPX_COLLECTION_H
#define SN_REPX_COLLECTION_H
 
#include "common/PxTolerancesScale.h"
#include "extensions/PxRepXSerializer.h"
 
namespace physx { namespace Sn {
    
    struct  XmlNode;
    
    struct RepXCollectionItem
    {
        PxRepXObject        liveObject;
        XmlNode*            descriptor;
        RepXCollectionItem( PxRepXObject inItem = PxRepXObject(), XmlNode* inDescriptor = NULL )
            : liveObject( inItem )
            , descriptor( inDescriptor )
        {
        }
    };
 
    struct RepXDefaultEntry
    {
        const char* name;
        const char* value;
        RepXDefaultEntry( const char* pn, const char* val ) : name( pn ), value( val ){}
    };
 
    struct RepXAddToCollectionResult
    {
        enum Enum
        {
            Success,
            SerializerNotFound,
            InvalidParameters, //Null data passed in.
            AlreadyInCollection
        };
 
        PxSerialObjectId    collectionId;
        Enum                result;
 
        RepXAddToCollectionResult( Enum inResult = Success, const PxSerialObjectId inId = 0 )
            : collectionId( inId )
            , result( inResult )
        {
        }
        bool isValid() { return result == Success && collectionId != 0; }
    };
    class RepXCollection 
    {
    protected:
        virtual ~RepXCollection(){}
 
    public:
        virtual void destroy() = 0;
 
        virtual void  setTolerancesScale( const PxTolerancesScale& inScale ) = 0;
 
        virtual PxTolerancesScale getTolerancesScale() const = 0;
 
        virtual void  setUpVector( const PxVec3& inUpVector ) = 0;
 
        virtual PxVec3  getUpVector() const = 0;
 
        virtual const char* getVersion() = 0;
        static const char* getLatestVersion();
 
        //Necessary accessor functions for translation/upgrading.
        virtual const RepXCollectionItem* begin() const = 0;
        virtual const RepXCollectionItem* end() const = 0;
 
 
        //Performs a deep copy of the repx node.
        virtual XmlNode* copyRepXNode( const XmlNode* srcNode ) = 0;
 
        virtual void addCollectionItem( RepXCollectionItem inItem ) = 0;
 
        //Create a new repx node with this name.  Its value is unset.
        virtual XmlNode& createRepXNode( const char* name ) = 0;
 
        virtual RepXCollection& createCollection( const char* inVersionStr ) = 0;
        //Release this when finished.
        virtual XmlReaderWriter& createNodeEditor() = 0;
 
        virtual PxAllocatorCallback& getAllocator() = 0;
 
        virtual bool instantiateCollection( PxRepXInstantiationArgs& inArgs, PxCollection& inPxCollection ) = 0;
 
        
        virtual RepXAddToCollectionResult addRepXObjectToCollection( const PxRepXObject& inObject, PxCollection* inCollection, PxRepXInstantiationArgs& inArgs ) = 0;
 
        virtual void save( PxOutputStream& inStream ) = 0;
    };
} }
 
#endif