Loading...
Searching...
No Matches
dynamicFileFormatInterface.h
1//
2// Copyright 2019 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_USD_PCP_DYNAMIC_FILE_FORMAT_INTERFACE_H
8#define PXR_USD_PCP_DYNAMIC_FILE_FORMAT_INTERFACE_H
9
10#include "pxr/pxr.h"
11#include "pxr/usd/pcp/api.h"
13
14PXR_NAMESPACE_OPEN_SCOPE
15
17class VtValue;
18
31{
32public:
34 PCP_API
36
56 PCP_API
58 const std::string &assetPath,
59 const PcpDynamicFileFormatContext &context,
61 VtValue *dependencyContextData) const = 0;
62
82 PCP_API
84 const TfToken &field,
85 const VtValue &oldValue,
86 const VtValue &newValue,
87 const VtValue &dependencyContextData) const;
88
108 PCP_API
110 const TfToken &attributeName,
111 const VtValue &oldValue,
112 const VtValue &newValue,
113 const VtValue &dependencyContextData) const;
114};
115
116PXR_NAMESPACE_CLOSE_SCOPE
117
118#endif // PXR_USD_PCP_DYNAMIC_FILE_FORMAT_INTERFACE_H
Context object for the current state of a prim index that is being built that allows implementations ...
Interface mixin that can be included by SdfFileFormat subclasses to enable dynamic file format argume...
virtual PCP_API bool CanFieldChangeAffectFileFormatArguments(const TfToken &field, const VtValue &oldValue, const VtValue &newValue, const VtValue &dependencyContextData) const
Return true if the change to scene description of the field named field can affect the dynamic file f...
virtual PCP_API void ComposeFieldsForFileFormatArguments(const std::string &assetPath, const PcpDynamicFileFormatContext &context, SdfFileFormat::FileFormatArguments *args, VtValue *dependencyContextData) const =0
Derived classes must implement this function to compose prim metadata fields and/or attribute default...
virtual PCP_API bool CanAttributeDefaultValueChangeAffectFileFormatArguments(const TfToken &attributeName, const VtValue &oldValue, const VtValue &newValue, const VtValue &dependencyContextData) const
Return true if the change to scene description of the default field for the attribute named attribute...
virtual PCP_API ~PcpDynamicFileFormatInterface()
Empty virtual destructor to prevent build errors with some compilers.
std::map< std::string, std::string > FileFormatArguments
Type for specifying additional file format-specific arguments to the various API below.
Definition: fileFormat.h:102
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:90