Loading...
Searching...
No Matches
particleFieldSchema.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_PARTICLE_FIELD_SCHEMA_H
19#define PXR_IMAGING_HD_PARTICLE_FIELD_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_PARTICLE_FIELD_SCHEMA_TOKENS \
36 (particleField) \
37 (kernelType) \
38
39TF_DECLARE_PUBLIC_TOKENS(HdParticleFieldSchemaTokens, HD_API,
40 HD_PARTICLE_FIELD_SCHEMA_TOKENS);
41
42//-----------------------------------------------------------------------------
43
44
51{
52public:
55
56 HdParticleFieldSchema(HdContainerDataSourceHandle container)
57 : HdSchema(container) {}
58
64 HD_API
66 const HdContainerDataSourceHandle &fromParentContainer);
67
69
70// --(BEGIN CUSTOM CODE: Schema Methods)--
71// --(END CUSTOM CODE: Schema Methods)--
72
75
76 HD_API
77 HdTokenDataSourceHandle GetKernelType() const;
78
80
83
86 HD_API
87 static const TfToken &GetSchemaToken();
88
91 HD_API
93
95
98
106 HD_API
107 static HdContainerDataSourceHandle
109 const HdTokenDataSourceHandle &kernelType
110 );
111
118 class Builder
119 {
120 public:
121 HD_API
122 Builder &SetKernelType(
123 const HdTokenDataSourceHandle &kernelType);
124
126 HD_API
127 HdContainerDataSourceHandle Build();
128
129 private:
130 HdTokenDataSourceHandle _kernelType;
131
132 };
133
135};
136
137PXR_NAMESPACE_CLOSE_SCOPE
138
139#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.
Schema for representing configuration information about particleField prims.
static HD_API HdContainerDataSourceHandle BuildRetained(const HdTokenDataSourceHandle &kernelType)
static HD_API HdParticleFieldSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
Retrieves a container data source with the schema's default name token "particleField" 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:81
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.