nodeDef.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/nodeDef.h"
#ifndef _ufeNodeDef
#define _ufeNodeDef
// =======================================================================
// Copyright 2022 Autodesk, Inc. All rights reserved.
//
// This computer source code and related instructions and comments are the
// unpublished confidential  and proprietary information of Autodesk, Inc.
// and are protected under applicable copyright and trade secret law. They
// may not be disclosed to, copied  or used by any third party without the
// prior written consent of Autodesk, Inc.
// =======================================================================

#include "common/ufeExport.h"
#include "attributeDef.h"
#include "rtid.h"
#include "sceneItem.h"
#include "undoableCommand.h"
#include "value.h"

#include <memory>
#include <string>
#include <vector>

UFE_NS_DEF {

typedef std::vector<AttributeDef::ConstPtr> ConstAttributeDefs;

class UFE_SDK_DECL NodeDef
{
public:
    typedef std::shared_ptr<NodeDef> Ptr;

    virtual ~NodeDef();

    virtual std::string type() const = 0;

    virtual std::size_t nbClassifications() const = 0;

    virtual std::string classification(std::size_t level) const = 0;

    virtual std::vector<std::string> inputNames() const = 0;

    virtual bool hasInput(const std::string& name) const = 0;

    virtual AttributeDef::ConstPtr input(const std::string& name) const = 0;

    virtual ConstAttributeDefs inputs() const = 0;

    virtual std::vector<std::string> outputNames() const = 0;

    virtual bool hasOutput(const std::string& name) const = 0;

    virtual AttributeDef::ConstPtr output(const std::string& name) const = 0;

    virtual ConstAttributeDefs outputs() const = 0;

    static Ptr definition(const Rtid& id, const std::string& type);

    virtual Value getMetadata(const std::string& key) const = 0;

    virtual bool hasMetadata(const std::string& key) const = 0;

    virtual SceneItem::Ptr createNode(
        const SceneItem::Ptr& parent, const PathComponent& name) const = 0;

    virtual InsertChildCommand::Ptr createNodeCmd(
        const SceneItem::Ptr& parent, const PathComponent& name) const = 0;

protected:
    NodeDef();
}; // end class

typedef std::vector<NodeDef::Ptr> NodeDefs;

} // end namespace

#endif /* _ufeNodeDef */