88 lines
3.2 KiB
C++
88 lines
3.2 KiB
C++
//////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright 2016 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_CUSTOMFEATUREPARAMETERS_CPP__
|
|
# define ADSK_FUSION_CUSTOMFEATUREPARAMETERS_API XI_EXPORT
|
|
# else
|
|
# define ADSK_FUSION_CUSTOMFEATUREPARAMETERS_API
|
|
# endif
|
|
#else
|
|
# define ADSK_FUSION_CUSTOMFEATUREPARAMETERS_API XI_IMPORT
|
|
#endif
|
|
|
|
namespace adsk { namespace fusion {
|
|
class CustomFeatureParameter;
|
|
}}
|
|
|
|
namespace adsk { namespace fusion {
|
|
|
|
/// A collection of custom parameters associated with a particular custom feature.
|
|
class CustomFeatureParameters : public core::Base {
|
|
public:
|
|
|
|
/// Function that returns the specified custom parameter 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<CustomFeatureParameter> item(size_t index) const;
|
|
|
|
/// The number of CustomFeatureParameter objects in the collection.
|
|
size_t count() const;
|
|
|
|
/// Function that returns the specified CustomParameter object given its ID.
|
|
/// id : The ID of the custom parameter, which was assigned when the parameter was defined and the custom feature was created.
|
|
/// Returns the specified item or null if the specified ID was not found.
|
|
core::Ptr<CustomFeatureParameter> itemById(const std::string& id) const;
|
|
|
|
ADSK_FUSION_CUSTOMFEATUREPARAMETERS_API static const char* classType();
|
|
ADSK_FUSION_CUSTOMFEATUREPARAMETERS_API const char* objectType() const override;
|
|
ADSK_FUSION_CUSTOMFEATUREPARAMETERS_API void* queryInterface(const char* id) const override;
|
|
ADSK_FUSION_CUSTOMFEATUREPARAMETERS_API static const char* interfaceId() { return classType(); }
|
|
|
|
private:
|
|
|
|
// Raw interface
|
|
virtual CustomFeatureParameter* item_raw(size_t index) const = 0;
|
|
virtual size_t count_raw() const = 0;
|
|
virtual CustomFeatureParameter* itemById_raw(const char * id) const = 0;
|
|
};
|
|
|
|
// Inline wrappers
|
|
|
|
inline core::Ptr<CustomFeatureParameter> CustomFeatureParameters::item(size_t index) const
|
|
{
|
|
core::Ptr<CustomFeatureParameter> res = item_raw(index);
|
|
return res;
|
|
}
|
|
|
|
inline size_t CustomFeatureParameters::count() const
|
|
{
|
|
size_t res = count_raw();
|
|
return res;
|
|
}
|
|
|
|
inline core::Ptr<CustomFeatureParameter> CustomFeatureParameters::itemById(const std::string& id) const
|
|
{
|
|
core::Ptr<CustomFeatureParameter> res = itemById_raw(id.c_str());
|
|
return res;
|
|
}
|
|
}// namespace fusion
|
|
}// namespace adsk
|
|
|
|
#undef ADSK_FUSION_CUSTOMFEATUREPARAMETERS_API |