Loading...
Searching...
No Matches
instanceProxySchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
8
9/* ************************************************************************** */
10/* ** ** */
11/* ** This file is generated by a script. ** */
12/* ** ** */
13/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
14/* ** Edit hdSchemaDefs.py instead to make changes. ** */
15/* ** ** */
16/* ************************************************************************** */
17
18#ifndef PXR_IMAGING_HD_INSTANCE_PROXY_SCHEMA_H
19#define PXR_IMAGING_HD_INSTANCE_PROXY_SCHEMA_H
20
22
23#include "pxr/imaging/hd/api.h"
24
25#include "pxr/imaging/hd/schema.h"
26
27// --(BEGIN CUSTOM CODE: Includes)--
28// --(END CUSTOM CODE: Includes)--
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32// --(BEGIN CUSTOM CODE: Declares)--
33// --(END CUSTOM CODE: Declares)--
34
35#define HD_INSTANCE_PROXY_SCHEMA_TOKENS \
36 (instanceProxy) \
37 (prototypePath) \
38
39TF_DECLARE_PUBLIC_TOKENS(HdInstanceProxySchemaTokens, HD_API,
40 HD_INSTANCE_PROXY_SCHEMA_TOKENS);
41
42//-----------------------------------------------------------------------------
43
44
56{
57public:
60
61 HdInstanceProxySchema(HdContainerDataSourceHandle container)
62 : HdSchema(container) {}
63
69 HD_API
71 const HdContainerDataSourceHandle &fromParentContainer);
72
74
75// --(BEGIN CUSTOM CODE: Schema Methods)--
76// --(END CUSTOM CODE: Schema Methods)--
77
80
83 HD_API
84 HdPathDataSourceHandle GetPrototypePath() const;
85
87
90
93 HD_API
94 static const TfToken &GetSchemaToken();
95
98 HD_API
100
102
105
113 HD_API
114 static HdContainerDataSourceHandle
116 const HdPathDataSourceHandle &prototypePath
117 );
118
125 class Builder
126 {
127 public:
128 HD_API
129 Builder &SetPrototypePath(
130 const HdPathDataSourceHandle &prototypePath);
131
133 HD_API
134 HdContainerDataSourceHandle Build();
135
136 private:
137 HdPathDataSourceHandle _prototypePath;
138
139 };
140
142};
143
144PXR_NAMESPACE_CLOSE_SCOPE
145
146#endif
Represents an object that can identify the location of a data source.
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
A schema for marking a prim as an instance proxy.
HD_API HdPathDataSourceHandle GetPrototypePath() const
The path to the propagated prototype prim that this instance proxy prim represents.
static HD_API HdContainerDataSourceHandle BuildRetained(const HdPathDataSourceHandle &prototypePath)
static HD_API HdInstanceProxySchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
Retrieves a container data source with the schema's default name token "instanceProxy" from the paren...
static HD_API const TfToken & GetSchemaToken()
Returns a token where the container representing this schema is found in a container by default.
static HD_API const HdDataSourceLocator & GetDefaultLocator()
Returns an HdDataSourceLocator (relative to the prim-level data source) where the container represent...
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition schema.h:26
Token for efficient comparison, assignment, and hashing of known strings.
Definition token.h:71
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.