All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dynamicFileFormatContext.h
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 #ifndef PCP_DYNAMIC_FILE_FORMAT_CONTEXT_H
25 #define PCP_DYNAMIC_FILE_FORMAT_CONTEXT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/pcp/api.h"
29 #include "pxr/usd/pcp/node.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
33 class PcpPrimIndex_StackFrame;
34 class PcpCache;
35 
44 {
45 public:
46  using VtValueVector = std::vector<VtValue>;
47 
48  PCP_API
49  ~PcpDynamicFileFormatContext() = default;
50 
55  PCP_API
56  bool ComposeValue(const TfToken &field, VtValue *value) const;
57 
67  PCP_API
68  bool ComposeValueStack(const TfToken &field,
69  VtValueVector *values) const;
70 
71 private:
72  // Callback function for ComposeValue. This callback function will
73  // be passed values for the field given to ComposeValue from
74  // strongest to weakest available opinion and is free to copy or
75  // swap out the value as desired.
76  using _ComposeFunction = std::function<void(VtValue &&)>;
77 
85  const PcpNodeRef &parentNode,
86  PcpPrimIndex_StackFrame *previousFrame,
87  TfToken::Set *composedFieldNames);
89  friend PcpDynamicFileFormatContext Pcp_CreateDynamicFileFormatContext(
90  const PcpNodeRef &, PcpPrimIndex_StackFrame *, TfToken::Set *);
91 
95  bool _IsAllowedFieldForArguments(
96  const TfToken &field, bool *fieldValueIsDictionary = nullptr) const;
97 
98 private:
99  PcpNodeRef _parentNode;
100  PcpPrimIndex_StackFrame *_previousStackFrame;
101 
102  // Cached names of fields that had values composed by this context.
103  TfToken::Set *_composedFieldNames;
104 };
105 
106 PXR_NAMESPACE_CLOSE_SCOPE
107 
108 #endif // PCP_DYNAMIC_FILE_FORMAT_CONTEXT_H
PCP_API bool ComposeValue(const TfToken &field, VtValue *value) const
Compose the value of the given field and return its current strongest opinion.
Context object for the current state of a prim index that is being built that allows implementations ...
PcpNode represents a node in an expression tree for compositing scene description.
Definition: node.h:65
PcpCache is the context required to make requests of the Pcp composition algorithm and cache the resu...
Definition: cache.h:91
PCP_API bool ComposeValueStack(const TfToken &field, VtValueVector *values) const
Compose the values of the given field returning all available opinions ordered from strongest to weak...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
std::set< TfToken, TfTokenFastArbitraryLessThan > Set
Predefined type for set of tokens, for when faster lookup is desired, without paying the memory or in...
Definition: token.h:185
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182