Blender V5.3
populate_context.hh
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#pragma once
6
7#include <pxr/base/gf/matrix4d.h>
8#include <pxr/base/tf/token.h>
9#include <pxr/base/vt/array.h>
10#include <pxr/imaging/hd/dataSource.h>
11#include <pxr/imaging/hd/retainedSceneIndex.h>
12#include <pxr/imaging/hd/sceneIndexObserver.h>
13#include <pxr/usd/sdf/path.h>
14
15#include "BLI_index_range.hh"
16#include "BLI_map.hh"
17#include "BLI_set.hh"
18#include "BLI_span.hh"
19#include "BLI_vector.hh"
20
21#include "scene_index.hh"
22
23namespace blender {
24
25struct Depsgraph;
26struct Main;
27struct Material;
28struct Object;
29struct ParticleSystem;
30struct Scene;
31struct View3D;
32
33struct ID;
34
35namespace io::hydra {
36
37/* Uniquely describes objects in a way that works with geometry set instances too. */
45
46/* Temporary state for one populate() update, to pass context and track what
47 * was add and used. */
75
76 /* Scene context. */
77 Depsgraph *depsgraph;
80 const View3D *view3d;
81 pxr::SdfPath root_path;
85
86 /* Owned by HydraSceneIndex. */
91
92 /* Materials. */
95
96 /* Geometry. */
99
100 /* Paths and prims. */
102 pxr::HdRetainedSceneIndex::AddedPrimEntries to_add;
103 pxr::HdSceneIndexObserver::DirtiedPrimEntries to_dirty;
104
105 /* Objects. */
107
108 /* Instancing and prototypes. */
111 pxr::VtMatrix4dArray instance_transforms;
114
115 /* Path naming scheme for each prim. */
116 pxr::SdfPath object_prim_id(const Object *object) const;
117 pxr::SdfPath submesh_prim_id(const Object *object, int submesh_index) const;
118 pxr::SdfPath hair_prim_id(const Object *object, const ParticleSystem *psys) const;
119 pxr::SdfPath material_prim_id(const Material *material) const;
120 pxr::SdfPath instancer_prim_id() const;
121 pxr::SdfPath instancer_proto_root(const Object *source) const;
122 pxr::SdfPath instancer_proto_submesh(const Object *source, int submesh_index) const;
123 pxr::SdfPath instance_clone_prim_id(const Object *source, int instance_index) const;
124
125 /* Look up or build the emitted material. */
126 const EmittedMaterial *get_or_create_material(const Material *material);
127
128 /* Unique geometry key for an emitted object. */
129 EmittedGeometryKey emitted_geometry_key(const BObjectInfo &info, const pxr::TfToken &type) const;
130
131 /* Emit a primitive. */
132 void emit_prim(const pxr::SdfPath &path,
133 const pxr::TfToken &type,
134 const pxr::HdContainerDataSourceHandle &ds);
135
136 /* Emit an object primitive. */
137 void emit_object_prim(EmittedObject &emitted,
138 const pxr::SdfPath &path,
139 const pxr::TfToken &type,
140 const pxr::HdContainerDataSourceHandle &ds,
141 const pxr::GfMatrix4d &geometry_xform = pxr::GfMatrix4d(1.0));
142
143 /* `instancedBy` data source binding `source` object prototype subtree to the instancer. */
144 pxr::HdContainerDataSourceHandle proto_instanced_by(const Object *source) const;
145
146 /* Add instance of a prototype for `source` object. */
147 void add_instance(const Object *source, const float dupli_mat[4][4]);
148};
149
150/* Compose a geometry primitive with per-object transform and visibility. */
151pxr::HdContainerDataSourceHandle compose_gprim_data_source(
152 const EmittedGeometryPrim &gprim,
153 const pxr::GfMatrix4d &transform,
154 bool visible,
155 const pxr::HdContainerDataSourceHandle &instanced_by_overlay = nullptr);
156
157} // namespace io::hydra
158} // namespace blender
#define instance_index
pxr::HdContainerDataSourceHandle compose_gprim_data_source(const EmittedGeometryPrim &gprim, const pxr::GfMatrix4d &transform, const bool visible, const pxr::HdContainerDataSourceHandle &instanced_by_overlay)
BMesh Iterators.
PopulateContext(Depsgraph *depsgraph, Main *bmain, Scene *scene, const View3D *view3d, const pxr::SdfPath &root_path, bool use_materialx, Span< pxr::TfToken > material_render_contexts, Span< pxr::TfToken > shader_source_types, Map< const Material *, EmittedMaterial > &emitted_materials, Map< EmittedGeometryKey, EmittedGeometry > &emitted_geometry, Map< const Object *, Vector< const ID * > > &instance_geometries_by_object, const Set< pxr::SdfPath > &current_paths)
Map< const Object *, Vector< const ID * > > & instance_geometries_by_object
Map< const Object *, int > nonmesh_instance_count
Set< EmittedGeometryKey > used_emitted_geometry
Map< const Object *, EmittedObject > new_emitted_objects
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])
Set< const Object * > used_instance_sources
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
Map< EmittedGeometryKey, EmittedGeometry > & emitted_geometry
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
Span< pxr::TfToken > material_render_contexts