Loading...
Searching...
No Matches
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 PXR_USD_PCP_DYNAMIC_FILE_FORMAT_CONTEXT_H
25#define PXR_USD_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
31PXR_NAMESPACE_OPEN_SCOPE
32
33class PcpPrimIndex_StackFrame;
34class PcpCache;
35
44{
45public:
46 using VtValueVector = std::vector<VtValue>;
47
48 PCP_API
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
74 PCP_API
76 const TfToken &attributeName, VtValue *value) const;
77
78private:
86 const PcpNodeRef &parentNode,
87 PcpPrimIndex_StackFrame *previousFrame,
88 TfToken::Set *composedFieldNames,
89 TfToken::Set *composedAttributeNames);
90
92 friend PcpDynamicFileFormatContext Pcp_CreateDynamicFileFormatContext(
93 const PcpNodeRef &, PcpPrimIndex_StackFrame *,
95
99 bool _IsAllowedFieldForArguments(
100 const TfToken &field, bool *fieldValueIsDictionary = nullptr) const;
101
102private:
103 PcpNodeRef _parentNode;
104 PcpPrimIndex_StackFrame *_previousStackFrame;
105
106 // Cached names of fields that had values composed by this context.
107 TfToken::Set *_composedFieldNames;
108
109 // Cached names of attributes that had default values composed by this
110 // context.
111 TfToken::Set *_composedAttributeNames;
112
113 // Declare private helper.
114 class _ComposeValueHelper;
115};
116
117PXR_NAMESPACE_CLOSE_SCOPE
118
119#endif // PXR_USD_PCP_DYNAMIC_FILE_FORMAT_CONTEXT_H
PcpCache is the context required to make requests of the Pcp composition algorithm and cache the resu...
Definition: cache.h:94
Context object for the current state of a prim index that is being built that allows implementations ...
PCP_API bool ComposeValue(const TfToken &field, VtValue *value) const
Compose the value of the given field and return its current strongest opinion.
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...
PCP_API bool ComposeAttributeDefaultValue(const TfToken &attributeName, VtValue *value) const
Compose the value of the default field of the attribute with the given attributeName and return its c...
PcpNode represents a node in an expression tree for compositing scene description.
Definition: node.h:64
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
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:183
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:165