All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rmanDiscovery.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 
25 #ifndef RMAN_DISCOVERYPLUGIN_H
26 #define RMAN_DISCOVERYPLUGIN_H
27 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/ndr/discoveryPlugin.h"
32 #include <functional>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
41 {
42 public:
46  using Filter = std::function<bool(NdrNodeDiscoveryResult&)>;
47 
50 
55 
58 
61  NdrNodeDiscoveryResultVec DiscoverNodes(const Context&) override;
62 
64  const NdrStringVec& GetSearchURIs() const override;
65 
66 private:
68  NdrStringVec _searchPaths;
69 
73  NdrStringVec _allowedExtensions;
74 
76  bool _followSymlinks;
77 
78  // The filter to run on the results.
79  Filter _filter;
80 };
81 
82 void
83 RmanDiscoveryPlugin_SetDefaultSearchPaths(const NdrStringVec &paths);
84 
85 void
86 RmanDiscoveryPlugin_SetDefaultFollowSymlinks(bool followSymlinks);
87 
88 PXR_NAMESPACE_CLOSE_SCOPE
89 
90 #endif // RMAN_DISCOVERYPLUGIN_H
~RmanDiscoveryPlugin()
Virtual destructor.
std::function< bool(NdrNodeDiscoveryResult &)> Filter
A filter for discovered nodes.
Definition: rmanDiscovery.h:46
RmanDiscoveryPlugin()
Constructor.
Interface for discovery plugins.
A context for discovery.
Discovers nodes supported by the HdPrman render delegate.
Definition: rmanDiscovery.h:40
const NdrStringVec & GetSearchURIs() const override
Gets the paths that this plugin is searching for nodes in.
NdrNodeDiscoveryResultVec DiscoverNodes(const Context &) override
Discover all of the nodes that appear within the the search paths provided and match the extensions p...