Blender V5.3
populate_context.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2026 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#include "populate_context.hh"
6
7#include <pxr/imaging/hd/instancedBySchema.h>
8#include <pxr/imaging/hd/materialBindingsSchema.h>
9#include <pxr/imaging/hd/overlayContainerDataSource.h>
10#include <pxr/imaging/hd/primvarsSchema.h>
11#include <pxr/imaging/hd/retainedDataSource.h>
12#include <pxr/imaging/hd/visibilitySchema.h>
13#include <pxr/imaging/hd/xformSchema.h>
14
15#include "BLI_hash.hh"
16#include "BLI_string.hh"
17
18#include "DNA_material_types.h"
19#include "DNA_modifier_types.h"
20#include "DNA_object_types.h"
21#include "DNA_particle_types.h"
22
23#include "BKE_material.hh"
24#include "BKE_object.hh"
25
26#include "DEG_depsgraph.hh"
28
29#include "instancer.hh"
30#include "material.hh"
31#include "util.hh"
32
33namespace blender::io::hydra {
34
35/* -------------------------------------------------------------------- */
38
40{
41 return real_object && static_cast<const ID *>(real_object->data) == object_data;
42}
43
48
50{
51 /* Meta-balls are merged together. */
52 if (ob->type == OB_MBALL) {
53 return true;
54 }
55 /* Modifiers can create different geometry per object. */
56 const int settings = (mode == DAG_EVAL_VIEWPORT) ? eModifierMode_Realtime : eModifierMode_Render;
57 if ((BKE_object_is_modified(scene, ob) & settings) != 0) {
58 return true;
59 }
60 /* Object-level material links are difficult to share. */
61 const int mat_count = BKE_object_material_count_eval(ob);
62 for (int i = 0; i < mat_count; i++) {
63 if (i < ob->totcol && ob->matbits && ob->matbits[i] != 0) {
64 return true;
65 }
66 }
67 return false;
68}
69
71 const pxr::TfToken &type) const
72{
73 Scene *scene_ptr = scene;
75 const bool can_share = info.is_real_object_data() &&
76 !object_disables_geometry_sharing(scene_ptr, mode, info.real_object);
77 const ID *key_id = can_share ? info.object_data : &info.real_object->id;
78 return EmittedGeometryKey{key_id, type};
79}
80
82
83/* -------------------------------------------------------------------- */
86
87pxr::SdfPath PopulateContext::object_prim_id(const Object *object) const
88{
89 char name[32];
90 SNPRINTF(name, "O_%p", &object->id);
91 return root_path.AppendElementString(name);
92}
93
94pxr::SdfPath PopulateContext::submesh_prim_id(const Object *object, const int submesh_index) const
95{
96 char name[16];
97 SNPRINTF(name, "SM_%04d", submesh_index);
98 return object_prim_id(object).AppendElementString(name);
99}
100
101pxr::SdfPath PopulateContext::hair_prim_id(const Object *object, const ParticleSystem *psys) const
102{
103 char name[64];
104 SNPRINTF(name, "O_%p_PS_%p", &object->id, psys);
105 return root_path.AppendElementString(name);
106}
107
108pxr::SdfPath PopulateContext::material_prim_id(const Material *material) const
109{
110 char name[32];
111 SNPRINTF(name, "M_%p", &material->id);
112 return root_path.AppendElementString(name);
113}
114
116{
117 return root_path.AppendElementString("Instancer");
118}
119
120pxr::SdfPath PopulateContext::instancer_proto_root(const Object *source) const
121{
122 char name[32];
123 SNPRINTF(name, "O_%p", &source->id);
124 return instancer_prim_id().AppendElementString(name);
125}
126
128 const int submesh_index) const
129{
130 char name[16];
131 SNPRINTF(name, "SM_%04d", submesh_index);
132 return instancer_proto_root(source).AppendElementString(name);
133}
134
136 const int instance_index) const
137{
138 char name[16];
139 SNPRINTF(name, "NM_%08d", instance_index);
140 return instancer_proto_root(source).AppendElementString(name);
141}
142
144
145/* -------------------------------------------------------------------- */
148
149void PopulateContext::emit_prim(const pxr::SdfPath &path,
150 const pxr::TfToken &type,
151 const pxr::HdContainerDataSourceHandle &ds)
152{
153 new_paths.add(path);
154 to_add.push_back({path, type, ds});
155 if (emitted_paths.contains(path)) {
156 to_dirty.push_back({path, pxr::HdDataSourceLocator()});
157 }
158}
159
161 const pxr::SdfPath &path,
162 const pxr::TfToken &type,
163 const pxr::HdContainerDataSourceHandle &ds,
164 const pxr::GfMatrix4d &geometry_xform)
165{
166 EmittedObjectPrim entry;
167 entry.path = path;
168 entry.type = type;
169 entry.base_data_source = ds;
170 entry.geometry_xform = geometry_xform;
171 emitted.prims.append(entry);
172 emit_prim(path, type, ds);
173}
174
175pxr::HdContainerDataSourceHandle EmittedObjectPrim::compose() const
176{
177 if (xform_overlay) {
178 return pxr::HdOverlayContainerDataSource::New(xform_overlay, base_data_source);
179 }
180 return base_data_source;
181}
182
184
185/* -------------------------------------------------------------------- */
188
190{
191 if (!material) {
192 return nullptr;
193 }
194 used_emitted_materials.add(material);
195 if (const EmittedMaterial *existing = emitted_materials.lookup_ptr(material)) {
196 return existing;
197 }
198 new_emitted_materials.append(material);
199 emitted_materials.add_new(material, build_emitted_material(*this, material));
200 return emitted_materials.lookup_ptr(material);
201}
202
204
205/* -------------------------------------------------------------------- */
208
209pxr::HdContainerDataSourceHandle PopulateContext::proto_instanced_by(const Object *source) const
210{
211 return pxr::HdRetainedContainerDataSource::New(
212 pxr::HdInstancedBySchema::GetSchemaToken(),
214}
215
216void PopulateContext::add_instance(const Object *source, const float dupli_mat[4][4])
217{
218 const int instance_idx = int(instance_transforms.size());
219 instance_transforms.push_back(gf_matrix_from_transform(dupli_mat));
220 const IndexRange range = proto_range_by_source.lookup(source);
221 for (const int proto_idx : range) {
222 per_proto_indices[proto_idx].push_back(instance_idx);
223 }
224}
225
226pxr::HdContainerDataSourceHandle compose_gprim_data_source(
227 const EmittedGeometryPrim &gprim,
228 const pxr::GfMatrix4d &transform,
229 const bool visible,
230 const pxr::HdContainerDataSourceHandle &instanced_by_overlay)
231{
232 pxr::HdContainerDataSourceHandle xform =
233 pxr::HdXformSchema::Builder()
234 .SetMatrix(pxr::HdRetainedTypedSampledDataSource<pxr::GfMatrix4d>::New(transform))
235 .SetResetXformStack(pxr::HdRetainedTypedSampledDataSource<bool>::New(false))
236 .Build();
237 pxr::HdContainerDataSourceHandle visibility =
238 pxr::HdVisibilitySchema::Builder()
239 .SetVisibility(pxr::HdRetainedTypedSampledDataSource<bool>::New(visible))
240 .Build();
241
243 b.reserve(5);
244 b.add(gprim.schema_token, gprim.geometry);
245 b.add(pxr::HdPrimvarsSchema::GetSchemaToken(), gprim.primvars);
246 b.add(pxr::HdXformSchema::GetSchemaToken(), xform);
247 b.add(pxr::HdVisibilitySchema::GetSchemaToken(), visibility);
248 if (gprim.bindings) {
249 b.add(pxr::HdMaterialBindingsSchema::GetSchemaToken(), gprim.bindings);
250 }
251 pxr::HdContainerDataSourceHandle prim_ds = b.build();
252
253 if (instanced_by_overlay) {
254 return pxr::HdOverlayContainerDataSource::New(prim_ds, instanced_by_overlay);
255 }
256 return prim_ds;
257}
258
260
261} // namespace blender::io::hydra
General operations, lookup, etc. for materials.
General operations, lookup, etc. for blender objects.
#define SNPRINTF(dst, format,...)
Object is a sort of wrapper for general info.
bool contains(const Key &key) const
Definition BLI_set.hh:310
bool add(const Key &key)
Definition BLI_set.hh:248
#define instance_index
static bool object_disables_geometry_sharing(Scene *scene, eEvaluationMode mode, Object *ob)
pxr::GfMatrix4d gf_matrix_from_transform(const float m[4][4])
Definition util.hh:20
pxr::HdContainerDataSourceHandle compose_gprim_data_source(const EmittedGeometryPrim &gprim, const pxr::GfMatrix4d &transform, const bool visible, const pxr::HdContainerDataSourceHandle &instanced_by_overlay)
EmittedMaterial build_emitted_material(const PopulateContext &ctx, const Material *material)
pxr::HdContainerDataSourceHandle build_instanced_by_data_source(const pxr::SdfPath &instancer_path, const pxr::SdfPath &prototype_root)
Definition instancer.cc:21
int BKE_object_material_count_eval(const Object *ob)
unsigned __int64 uint64_t
Definition BKE_text.h:91
int BKE_object_is_modified(Scene *scene, Object *ob)
Definition object.cc:4932
@ DAG_EVAL_VIEWPORT
eEvaluationMode DEG_get_mode(const Depsgraph *graph)
constexpr uint64_t get_default_hash(const T &v, const Args &...args)
Definition BLI_hash.hh:252
pxr::HdContainerDataSourceHandle geometry
pxr::HdContainerDataSourceHandle bindings
pxr::HdContainerDataSourceHandle primvars
pxr::HdContainerDataSourceHandle base_data_source
pxr::HdContainerDataSourceHandle compose() const
pxr::HdContainerDataSourceHandle xform_overlay
Vector< EmittedObjectPrim > prims
pxr::SdfPath object_prim_id(const Object *object) const
void emit_object_prim(EmittedObject &emitted, const pxr::SdfPath &path, const pxr::TfToken &type, const pxr::HdContainerDataSourceHandle &ds, const pxr::GfMatrix4d &geometry_xform=pxr::GfMatrix4d(1.0))
pxr::SdfPath material_prim_id(const Material *material) const
void add_instance(const Object *source, const float dupli_mat[4][4])
pxr::SdfPath submesh_prim_id(const Object *object, int submesh_index) const
pxr::HdRetainedSceneIndex::AddedPrimEntries to_add
const Set< pxr::SdfPath > & emitted_paths
Vector< const Material * > new_emitted_materials
pxr::SdfPath instance_clone_prim_id(const Object *source, int instance_index) const
Vector< pxr::VtIntArray > per_proto_indices
const EmittedMaterial * get_or_create_material(const Material *material)
Map< const Material *, EmittedMaterial > & emitted_materials
Map< const Object *, IndexRange > proto_range_by_source
pxr::SdfPath instancer_proto_root(const Object *source) const
Set< const Material * > used_emitted_materials
pxr::HdContainerDataSourceHandle proto_instanced_by(const Object *source) const
pxr::SdfPath instancer_proto_submesh(const Object *source, int submesh_index) const
pxr::HdSceneIndexObserver::DirtiedPrimEntries to_dirty
void emit_prim(const pxr::SdfPath &path, const pxr::TfToken &type, const pxr::HdContainerDataSourceHandle &ds)
pxr::SdfPath hair_prim_id(const Object *object, const ParticleSystem *psys) const
EmittedGeometryKey emitted_geometry_key(const BObjectInfo &info, const pxr::TfToken &type) const