Loading...
Searching...
No Matches
defaultResolverContext.h
Go to the documentation of this file.
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#ifndef PXR_USD_AR_DEFAULT_RESOLVER_CONTEXT_H
25#define PXR_USD_AR_DEFAULT_RESOLVER_CONTEXT_H
26
28
29#include "pxr/pxr.h"
30#include "pxr/usd/ar/api.h"
32
33#include <string>
34#include <vector>
35
36PXR_NAMESPACE_OPEN_SCOPE
37
64{
65public:
68
72 AR_API ArDefaultResolverContext(const std::vector<std::string>& searchPath);
73
74 AR_API bool operator<(const ArDefaultResolverContext& rhs) const;
75 AR_API bool operator==(const ArDefaultResolverContext& rhs) const;
76 AR_API bool operator!=(const ArDefaultResolverContext& rhs) const;
77
79 const std::vector<std::string>& GetSearchPath() const
80 {
81 return _searchPath;
82 }
83
85 AR_API std::string GetAsString() const;
86
87private:
88 std::vector<std::string> _searchPath;
89};
90
91AR_API size_t
92hash_value(const ArDefaultResolverContext& context);
93
94inline std::string
95ArGetDebugString(const ArDefaultResolverContext& context)
96{
97 return context.GetAsString();
98}
99
101
102PXR_NAMESPACE_CLOSE_SCOPE
103
104#endif // PXR_USD_AR_DEFAULT_RESOLVER_CONTEXT_H
Resolver context object that specifies a search path to use during asset resolution.
ArDefaultResolverContext()=default
Default construct a context with no search path.
const std::vector< std::string > & GetSearchPath() const
Return this context's search path.
AR_API ArDefaultResolverContext(const std::vector< std::string > &searchPath)
Construct a context with the given searchPath.
AR_API std::string GetAsString() const
Return a string representation of this context for debugging.
Macros for defining an object for use with ArResolverContext.
#define AR_DECLARE_RESOLVER_CONTEXT(ContextObject)
Declare that the specified ContextObject type may be used as an asset resolver context object for ArR...