ufe  4.2
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
codeWrapper.h
Go to the documentation of this file.
1 #line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/codeWrapper.h"
2 #ifndef _ufeCodeWrapper
3 #define _ufeCodeWrapper
4 // ===========================================================================
5 // Copyright 2023 Autodesk, Inc. All rights reserved.
6 //
7 // Use of this software is subject to the terms of the Autodesk license
8 // agreement provided at the time of installation or download, or which
9 // otherwise accompanies this software in either electronic or hard copy form.
10 // ===========================================================================
11 
12 #include "common/ufeExport.h"
13 
14 #include <memory>
15 #include <string>
16 #include <vector>
17 
18 UFE_NS_DEF {
19 
20 class Selection;
21 
29 {
30 public:
31  using Ptr = std::shared_ptr<CodeWrapper>;
32 
33  virtual ~CodeWrapper();
34 
37  virtual void prelude(const std::string& subOperation) = 0;
38 
41  virtual void cleanup(const std::string& subOperation) = 0;
42 };
43 
48 {
49 public:
50  using Container = std::vector<CodeWrapper::Ptr>;
51 
56  const Selection& selection,
57  const std::string& operationName
58  );
59 
61  const Container& codeWrappers() const {
62  return fWrappers;
63  }
64 
65 private:
67 };
68 
69 }
70 
71 #endif /* _ufeCodeWrapper */
std::string string(const Path &path)
std::shared_ptr< CodeWrapper > Ptr
Definition: codeWrapper.h:31
Definition of macros for symbol visibility.
A container of multiple CodeWrapper, one per UFE run-time that is involved in an operation.
Definition: codeWrapper.h:47
Wrap the execution of some other function, called sub-operation, with arbitrary prelude and cleanup v...
Definition: codeWrapper.h:28
Selection list for objects in the scene.
Definition: selection.h:27
#define UFE_NS_DEF
Definition: ufe.h:35
const Container & codeWrappers() const
Retrieves the code wrappers that were created in the constructor.
Definition: codeWrapper.h:61
#define UFE_SDK_DECL
Definition: ufeExport.h:36
std::vector< CodeWrapper::Ptr > Container
Definition: codeWrapper.h:50