Loading...
Searching...
No Matches
filesystemDiscovery.h
1//
2// Copyright 2018 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 PXR_USD_NDR_FILESYSTEM_DISCOVERY_H
26#define PXR_USD_NDR_FILESYSTEM_DISCOVERY_H
27
29
30#include "pxr/pxr.h"
31#include "pxr/usd/ndr/api.h"
32#include "pxr/usd/ndr/discoveryPlugin.h"
33#include <functional>
34
35PXR_NAMESPACE_OPEN_SCOPE
36
38
62{
63public:
67 using Filter = std::function<bool(NdrNodeDiscoveryResult&)>;
68
70 NDR_API
72
76 NDR_API
78
80 NDR_API
82
85 NDR_API
86 NdrNodeDiscoveryResultVec DiscoverNodes(const Context&) override;
87
89 NDR_API
90 const NdrStringVec& GetSearchURIs() const override { return _searchPaths; }
91
92private:
94 NdrStringVec _searchPaths;
95
99 NdrStringVec _allowedExtensions;
100
102 bool _followSymlinks;
103
104 // The filter to run on the results.
105 Filter _filter;
106};
107
108PXR_NAMESPACE_CLOSE_SCOPE
109
110#endif // PXR_USD_NDR_FILESYSTEM_DISCOVERY_H
Discovers nodes on the filesystem.
NDR_API _NdrFilesystemDiscoveryPlugin()
Constructor.
NDR_API _NdrFilesystemDiscoveryPlugin(Filter filter)
DiscoverNodes() will pass each result to the given function for modification.
std::function< bool(NdrNodeDiscoveryResult &)> Filter
A filter for discovered nodes.
NDR_API const NdrStringVec & GetSearchURIs() const override
Gets the paths that this plugin is searching for nodes in.
NDR_API NdrNodeDiscoveryResultVec DiscoverNodes(const Context &) override
Discover all of the nodes that appear within the the search paths provided and match the extensions p...
NDR_API ~_NdrFilesystemDiscoveryPlugin()
Destructor.
A context for discovery.
Interface for discovery plugins.
#define TF_DECLARE_WEAK_AND_REF_PTRS(type)
Define standard weak, ref, and vector pointer types.
Definition: declarePtrs.h:89
Represents the raw data of a node, and some other bits of metadata, that were determined via a NdrDis...