Loading...
Searching...
No Matches
generativeProceduralFilteringSceneIndex.h
1//
2// Copyright 2024 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_GP_GENERATIVE_PROCEDURAL_FILTERING_SCENE_INDEX_H
25#define PXR_IMAGING_HD_GP_GENERATIVE_PROCEDURAL_FILTERING_SCENE_INDEX_H
26
27#include "pxr/imaging/hdGp/generativeProcedural.h"
28#include "pxr/imaging/hd/filteringSceneIndex.h"
29#include "pxr/usd/sdf/pathTable.h"
30
31PXR_NAMESPACE_OPEN_SCOPE
32
35
52{
53public:
54 static HdGpGenerativeProceduralFilteringSceneIndexRefPtr New(
55 const HdSceneIndexBaseRefPtr &inputScene,
56 const TfTokenVector &allowedProceduralTypes) {
57 return TfCreateRefPtr(
59 inputScene, allowedProceduralTypes));
60 }
61 static HdGpGenerativeProceduralFilteringSceneIndexRefPtr New(
62 const HdSceneIndexBaseRefPtr &inputScene,
63 const TfTokenVector &allowedProceduralTypes,
64 const TfToken &targetPrimTypeName) {
65 return TfCreateRefPtr(
67 inputScene, allowedProceduralTypes, targetPrimTypeName));
68 }
69
70 HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
71 SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
72
73private:
75 const HdSceneIndexBaseRefPtr &inputScene,
76 const TfTokenVector &allowedProceduralTypes);
78 const HdSceneIndexBaseRefPtr &inputScene,
79 const TfTokenVector &allowedProceduralTypes,
80 const TfToken &targetPrimTypeName);
81
82 void _PrimsAdded(
83 const HdSceneIndexBase &sender,
84 const HdSceneIndexObserver::AddedPrimEntries &entries) override;
85 void _PrimsRemoved(
86 const HdSceneIndexBase &sender,
87 const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
88 void _PrimsDirtied(
89 const HdSceneIndexBase &sender,
90 const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
91
92 TfToken _GetProceduralType(HdSceneIndexPrim const& prim) const;
93 bool _ShouldSkipPrim(HdSceneIndexPrim const& prim) const;
94
95 const TfTokenVector _allowedProceduralTypes;
96 const TfToken _targetPrimTypeName;
97};
98
99PXR_NAMESPACE_CLOSE_SCOPE
100
101#endif
HdGpGenerativeProceduralFilteringSceneIndex is a scene index which filters prims representing generat...
HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override
Returns a pair of (prim type, datasource) for the object at primPath.
SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override
Returns the paths of all scene index prims located immediately below primPath.
Abstract interface to scene data.
Definition: sceneIndex.h:65
An abstract base class for a filtering scene index that observes a single input scene index.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
Definition: declarePtrs.h:75
Small struct representing a 'prim' in the Hydra scene index.
Definition: sceneIndex.h:52
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457