//////////////////////////////////////////////////////////////////////////////
//
// Copyright 2026 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software.
//
//////////////////////////////////////////////////////////////////////////////

#pragma once
#include "../../Core/Base.h"
#include "../FusionTypeDefs.h"
#include <string>

// THIS CLASS WILL BE VISIBLE TO AN API CLIENT.
// THIS HEADER FILE WILL BE GENERATED FROM NIDL.
#include "../../Core/OSMacros.h"

#ifdef FUSIONXINTERFACE_EXPORTS
# ifdef __COMPILING_ADSK_FUSION_PIPEFEATURES_CPP__
# define ADSK_FUSION_PIPEFEATURES_API XI_EXPORT
# else
# define ADSK_FUSION_PIPEFEATURES_API
# endif
#else
# define ADSK_FUSION_PIPEFEATURES_API XI_IMPORT
#endif

namespace adsk { namespace fusion {
    class Path;
    class PipeFeature;
    class PipeFeatureInput;
}}

namespace adsk { namespace fusion {

/// Collection that provides access to all of the existing Pipe features in a design.
class PipeFeatures : public core::Base {
public:

    /// Function that returns the specified Pipe feature using an index into the collection.
    /// index : The index of the item within the collection to return. The first item in the collection has an index of 0.
    /// Returns the specified item or null if an invalid index was specified.
    core::Ptr<PipeFeature> item(size_t index) const;

    /// Function that returns the specified Pipe feature using the name of the feature.
    /// name : The name of the feature within the collection to return. This is the name seen in the timeline.
    /// Returns the specified item or null if the specified name was not found.
    core::Ptr<PipeFeature> itemByName(const std::string& name) const;

    /// The number of Pipe features in the collection.
    size_t count() const;

    /// Creates a PipeFeatureInput object for defining a simple Pipe feature with only a path.
    /// Use properties and methods on this object to define the Pipe you want to create and then use the Add method,
    /// passing in the PipeFeatureInput object.
    /// path : The path to create the Pipe.
    /// operation : The feature operation to perform.
    /// Returns the newly created PipeFeatureInput object or null if the creation failed.
    core::Ptr<PipeFeatureInput> createInput(const core::Ptr<Path>& path, FeatureOperations operation) const;

    /// Creates a new Pipe feature.
    /// input : A PipeFeatureInput object that defines the desired Pipe. Use the createInput
    /// method to create a new PipeFeatureInput object and then use methods on it
    /// (the PipeFeatureInput object) to define the Pipe.
    /// Returns the newly created PipeFeature object or null if the creation failed.
    core::Ptr<PipeFeature> add(const core::Ptr<PipeFeatureInput>& input);

    typedef PipeFeature iterable_type;
    template <class OutputIterator> void copyTo(OutputIterator result);

    ADSK_FUSION_PIPEFEATURES_API static const char* classType();
    ADSK_FUSION_PIPEFEATURES_API const char* objectType() const override;
    ADSK_FUSION_PIPEFEATURES_API void* queryInterface(const char* id) const override;
    ADSK_FUSION_PIPEFEATURES_API static const char* interfaceId() { return classType(); }

private:

    // Raw interface
    virtual PipeFeature* item_raw(size_t index) const = 0;
    virtual PipeFeature* itemByName_raw(const char* name) const = 0;
    virtual size_t count_raw() const = 0;
    virtual PipeFeatureInput* createInput_raw(Path* path, FeatureOperations operation) const = 0;
    virtual PipeFeature* add_raw(PipeFeatureInput* input) = 0;
};

// Inline wrappers

inline core::Ptr<PipeFeature> PipeFeatures::item(size_t index) const
{
    core::Ptr<PipeFeature> res = item_raw(index);
    return res;
}

inline core::Ptr<PipeFeature> PipeFeatures::itemByName(const std::string& name) const
{
    core::Ptr<PipeFeature> res = itemByName_raw(name.c_str());
    return res;
}

inline size_t PipeFeatures::count() const
{
    size_t res = count_raw();
    return res;
}

inline core::Ptr<PipeFeatureInput> PipeFeatures::createInput(const core::Ptr<Path>& path, FeatureOperations operation) const
{
    core::Ptr<PipeFeatureInput> res = createInput_raw(path.get(), operation);
    return res;
}

inline core::Ptr<PipeFeature> PipeFeatures::add(const core::Ptr<PipeFeatureInput>& input)
{
    core::Ptr<PipeFeature> res = add_raw(input.get());
    return res;
}

template <class OutputIterator> inline void PipeFeatures::copyTo(OutputIterator result)
{
    for (size_t i = 0;i < count();++i)
    {
        *result = item(i);
        ++result;
    }
}
}// namespace fusion
}// namespace adsk

#undef ADSK_FUSION_PIPEFEATURES_API