Blender V5.3
file_reader.cpp
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2011-2022 Blender Foundation
2 *
3 * SPDX-License-Identifier: Apache-2.0 */
4
5#include "hydra/file_reader.h"
6#include "hydra/camera.h"
8
9#include "util/log.h"
10#include "util/path.h"
11#include "util/unique_ptr.h"
12
13#include "scene/scene.h"
14
15#include <pxr/base/plug/registry.h>
16#include <pxr/imaging/hd/flatteningSceneIndex.h>
17#include <pxr/imaging/hd/legacyTaskFactory.h>
18#include <pxr/imaging/hd/legacyTaskSchema.h>
19#include <pxr/imaging/hd/mergingSceneIndex.h>
20#include <pxr/imaging/hd/renderDelegate.h>
21#include <pxr/imaging/hd/renderIndex.h>
22#include <pxr/imaging/hd/retainedDataSource.h>
23#include <pxr/imaging/hd/retainedSceneIndex.h>
24#include <pxr/imaging/hd/rprimCollection.h>
25#include <pxr/imaging/hd/task.h>
26#include <pxr/imaging/hd/tokens.h>
27#include <pxr/imaging/hdsi/extComputationPrimvarPruningSceneIndex.h>
28#include <pxr/imaging/hdsi/legacyDisplayStyleOverrideSceneIndex.h>
29#include <pxr/usd/usd/primRange.h>
30#include <pxr/usd/usd/stage.h>
31#include <pxr/usd/usdGeom/camera.h>
32#include <pxr/usd/usdGeom/metrics.h>
33#include <pxr/usdImaging/usdImaging/flattenedDataSourceProviders.h>
34#include <pxr/usdImaging/usdImaging/materialBindingsResolvingSceneIndex.h>
35#include <pxr/usdImaging/usdImaging/stageSceneIndex.h>
36
38
39/* Dummy task whose only purpose is to provide render tag tokens to the render index. */
40class DummyHdTask : public HdTask {
41 public:
42 DummyHdTask(HdSceneDelegate * /*delegate*/, const SdfPath &id)
43 : HdTask(id), tags({HdRenderTagTokens->geometry, HdRenderTagTokens->render})
44 {
45 }
46
47 protected:
48 void Sync(HdSceneDelegate * /*delegate*/,
49 HdTaskContext * /*ctx*/,
50 HdDirtyBits * /*dirtyBits*/) override
51 {
52 }
53
54 void Prepare(HdTaskContext * /*ctx*/, HdRenderIndex * /*render_index*/) override {}
55
56 void Execute(HdTaskContext * /*ctx*/) override {}
57
58 const TfTokenVector &GetRenderTags() const override
59 {
60 return tags;
61 }
62
63 TfTokenVector tags;
64};
65
66void HdCyclesFileReader::read(Session *session, const char *filepath, const bool use_camera)
67{
68 /* Initialize USD. */
69 PlugRegistry::GetInstance().RegisterPlugins(path_get("usd"));
70
71 /* Open Stage. */
72 const UsdStageRefPtr stage = UsdStage::Open(filepath);
73 if (!stage) {
74 LOG_ERROR << "USD failed to read " << filepath;
75 return;
76 }
77
78 /* Init paths. */
79 const SdfPath root_path = SdfPath::AbsoluteRootPath();
80 const SdfPath task_path("/_hdCycles/DummyHdTask");
81
82 /* Create render delegate. */
83 HdRenderSettingsMap settings_map;
84 settings_map.insert(std::make_pair(HdCyclesRenderSettingsTokens->stageMetersPerUnit,
85 VtValue(UsdGeomGetStageMetersPerUnit(stage))));
86
87 HdCyclesDelegate render_delegate(settings_map, session, true);
88
89 /* Create render index. */
90 unique_ptr<HdRenderIndex> render_index(HdRenderIndex::New(&render_delegate, {}));
91
92 /* Set up scene index from USD stage for easy consumption.
93 * Do ext computation (e.g. skinning), flattening and resolve material bindings. */
94 UsdImagingStageSceneIndexRefPtr stage_si = UsdImagingStageSceneIndex::New(nullptr);
95 stage_si->SetStage(stage);
96 stage_si->SetTime(UsdTimeCode::Default());
97
98 HdSceneIndexBaseRefPtr filtered = stage_si;
99 filtered = HdSiExtComputationPrimvarPruningSceneIndex::New(filtered);
100 filtered = HdFlatteningSceneIndex::New(filtered, UsdImagingFlattenedDataSourceProviders());
101 filtered = UsdImagingMaterialBindingsResolvingSceneIndex::New(filtered, nullptr);
102
103 /* Provide DummyHdTask as a task prim to the scene index. */
104 HdRprimCollection collection(HdTokens->geometry, HdReprSelector(HdReprTokens->smoothHull));
105 collection.SetRootPath(root_path);
106
107 const TfTokenVector render_tags = {HdRenderTagTokens->geometry, HdRenderTagTokens->render};
108
109 HdContainerDataSourceHandle task_ds =
110 HdLegacyTaskSchema::Builder()
111 .SetFactory(HdRetainedTypedSampledDataSource<HdLegacyTaskFactorySharedPtr>::New(
112 HdMakeLegacyTaskFactory<DummyHdTask>()))
113 .SetCollection(HdRetainedTypedSampledDataSource<HdRprimCollection>::New(collection))
114 .SetRenderTags(HdRetainedTypedSampledDataSource<TfTokenVector>::New(render_tags))
115 .Build();
116
117 HdRetainedSceneIndexRefPtr task_si = HdRetainedSceneIndex::New();
118 task_si->AddPrims(
119 {{task_path,
120 HdPrimTypeTokens->task,
121 HdRetainedContainerDataSource::New(HdLegacyTaskSchema::GetSchemaToken(), task_ds)}});
122
123 HdMergingSceneIndexRefPtr merging_si = HdMergingSceneIndex::New();
124 merging_si->AddInputScene(filtered, root_path);
125 merging_si->AddInputScene(task_si, root_path);
126
127 const bool needs_prefixing = false;
128 render_index->InsertSceneIndex(merging_si, root_path, needs_prefixing);
129
130 stage_si->ApplyPendingUpdates();
131
132 render_index->EnqueueCollectionToSync(collection);
133
134 /* Sync prims. */
135 HdTaskContext task_context;
136 HdTaskSharedPtrVector tasks;
137 if (HdTaskSharedPtr const &task = render_index->GetTask(task_path)) {
138 tasks.push_back(task);
139 }
140
141 render_index->SyncAll(&tasks, &task_context);
142 render_delegate.CommitResources(&render_index->GetChangeTracker());
143
144 /* Use first camera in stage.
145 * TODO: get camera from UsdRender if available. */
146 if (use_camera) {
147 for (const UsdPrim &prim : stage->Traverse()) {
148 if (prim.IsA<UsdGeomCamera>()) {
149 HdSprim *sprim = render_index->GetSprim(HdPrimTypeTokens->camera, prim.GetPath());
150 if (sprim) {
151 HdCyclesCamera *camera = dynamic_cast<HdCyclesCamera *>(sprim);
152 camera->ApplyCameraSettings(render_delegate.GetRenderParam(), session->scene->camera);
153 break;
154 }
155 }
156 }
157 }
158}
159
const TfTokenVector & GetRenderTags() const override
void Execute(HdTaskContext *) override
DummyHdTask(HdSceneDelegate *, const SdfPath &id)
void Prepare(HdTaskContext *, HdRenderIndex *) override
TfTokenVector tags
void Sync(HdSceneDelegate *, HdTaskContext *, HdDirtyBits *) override
PXR_NS::HdRenderParam * GetRenderParam() const override
void CommitResources(PXR_NS::HdChangeTracker *tracker) override
static void read(Session *session, const char *filepath, const bool use_camera=true)
unique_ptr< Scene > scene
void camera(KernelGlobals &kg, const ShadingData &sd, float3 &outview, float &outdepth, float &outdist)
#define HDCYCLES_NAMESPACE_CLOSE_SCOPE
#define LOG_ERROR
Definition log.h:101
string path_get(const string &sub)
Definition path.cpp:368