Loading...
Searching...
No Matches
extComputationContextInternal.h
1//
2// Copyright 2017 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_IMAGING_HD_EXT_COMPUTATION_CONTEXT_INTERNAL_H
25#define PXR_IMAGING_HD_EXT_COMPUTATION_CONTEXT_INTERNAL_H
26
27#include "pxr/pxr.h"
28
29#include "pxr/imaging/hd/api.h"
30#include "pxr/imaging/hd/extComputationContext.h"
31
32#include <map>
33
34PXR_NAMESPACE_OPEN_SCOPE
35
41public:
42 HD_API
44
45 HD_API
47
54 HD_API
55 virtual const VtValue &GetInputValue(const TfToken &name) const override;
56
62 HD_API
64 const TfToken &name) const override;
68 HD_API
69 virtual void SetOutputValue(const TfToken &name,
70 const VtValue &output) override;
71
72
75 HD_API
76 void SetInputValue(const TfToken &name, const VtValue &input);
77
80 HD_API
81 bool GetOutputValue(const TfToken &name, VtValue *output) const;
82
85 HD_API
87
92 HD_API
93 virtual void RaiseComputationError() override;
94
95private:
96 typedef std::map<TfToken, VtValue> ValueMap;
97
98 ValueMap m_inputs;
99 ValueMap m_outputs;
100 bool m_compuationError;
101
102
104 = delete;
106 const HdExtComputationContextInternal &) = delete;
107
108};
109
110PXR_NAMESPACE_CLOSE_SCOPE
111
112#endif // PXR_IMAGING_HD_EXT_COMPUTATION_CONTEXT_INTERNAL_H
Interface class that defines the execution environment for the client to run a computation.
Hydra implementation of the HdExtComputationContext public interface.
virtual HD_API void SetOutputValue(const TfToken &name, const VtValue &output) override
Sets the value of the specified output.
virtual HD_API const VtValue * GetOptionalInputValuePtr(const TfToken &name) const override
Obtains the value of an named input to the computation.
virtual HD_API void RaiseComputationError() override
Called to indicate an error occurred while executing a computation so that it's output are invalid.
HD_API void SetInputValue(const TfToken &name, const VtValue &input)
Adds the named input to the execution environment.
HD_API bool GetOutputValue(const TfToken &name, VtValue *output) const
Fetches the named output from the execution environment.
HD_API bool HasComputationError()
returns true is an error occur in processing, such that the outputs are invalid.
virtual HD_API const VtValue & GetInputValue(const TfToken &name) const override
Obtains the value of an named input to the computation.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:165