HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrRodLightFilter.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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 USDRI_GENERATED_PXRRODLIGHTFILTER_H
25 #define USDRI_GENERATED_PXRRODLIGHTFILTER_H
26 
27 /// \file usdRi/pxrRodLightFilter.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdRi/tokens.h"
35 
37 
38 
39 #include "pxr/base/vt/value.h"
40 
41 #include "pxr/base/gf/vec3d.h"
42 #include "pxr/base/gf/vec3f.h"
43 #include "pxr/base/gf/matrix4d.h"
44 
45 #include "pxr/base/tf/token.h"
46 #include "pxr/base/tf/type.h"
47 
49 
50 class SdfAssetPath;
51 
52 // -------------------------------------------------------------------------- //
53 // PXRRODLIGHTFILTER //
54 // -------------------------------------------------------------------------- //
55 
56 /// \class UsdRiPxrRodLightFilter
57 ///
58 ///
59 /// \deprecated This schema will be replaced in a future release.
60 /// Simulates a rod or capsule-shaped region to modulate light.
61 ///
62 ///
63 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below
64 /// that are text/tokens, the actual token is published and defined in \ref UsdRiTokens.
65 /// So to set an attribute to the value "rightHanded", use UsdRiTokens->rightHanded
66 /// as the value.
67 ///
69 {
70 public:
71  /// Compile time constant representing what kind of schema this class is.
72  ///
73  /// \sa UsdSchemaKind
75 
76  /// Construct a UsdRiPxrRodLightFilter on UsdPrim \p prim .
77  /// Equivalent to UsdRiPxrRodLightFilter::Get(prim.GetStage(), prim.GetPath())
78  /// for a \em valid \p prim, but will not immediately throw an error for
79  /// an invalid \p prim
80  explicit UsdRiPxrRodLightFilter(const UsdPrim& prim=UsdPrim())
81  : UsdLuxLightFilter(prim)
82  {
83  }
84 
85  /// Construct a UsdRiPxrRodLightFilter on the prim held by \p schemaObj .
86  /// Should be preferred over UsdRiPxrRodLightFilter(schemaObj.GetPrim()),
87  /// as it preserves SchemaBase state.
88  explicit UsdRiPxrRodLightFilter(const UsdSchemaBase& schemaObj)
89  : UsdLuxLightFilter(schemaObj)
90  {
91  }
92 
93  /// Destructor.
94  USDRI_API
95  virtual ~UsdRiPxrRodLightFilter();
96 
97  /// Return a vector of names of all pre-declared attributes for this schema
98  /// class and all its ancestor classes. Does not include attributes that
99  /// may be authored by custom/extended methods of the schemas involved.
100  USDRI_API
101  static const TfTokenVector &
102  GetSchemaAttributeNames(bool includeInherited=true);
103 
104  /// Return a UsdRiPxrRodLightFilter holding the prim adhering to this
105  /// schema at \p path on \p stage. If no prim exists at \p path on
106  /// \p stage, or if the prim at that path does not adhere to this schema,
107  /// return an invalid schema object. This is shorthand for the following:
108  ///
109  /// \code
110  /// UsdRiPxrRodLightFilter(stage->GetPrimAtPath(path));
111  /// \endcode
112  ///
113  USDRI_API
115  Get(const UsdStagePtr &stage, const SdfPath &path);
116 
117  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
118  /// is defined (according to UsdPrim::IsDefined()) on this stage.
119  ///
120  /// If a prim adhering to this schema at \p path is already defined on this
121  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
122  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
123  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
124  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
125  /// current EditTarget for any nonexistent, or existing but not \a Defined
126  /// ancestors.
127  ///
128  /// The given \a path must be an absolute prim path that does not contain
129  /// any variant selections.
130  ///
131  /// If it is impossible to author any of the necessary PrimSpecs, (for
132  /// example, in case \a path cannot map to the current UsdEditTarget's
133  /// namespace) issue an error and return an invalid \a UsdPrim.
134  ///
135  /// Note that this method may return a defined prim whose typeName does not
136  /// specify this schema class, in case a stronger typeName opinion overrides
137  /// the opinion at the current EditTarget.
138  ///
139  USDRI_API
141  Define(const UsdStagePtr &stage, const SdfPath &path);
142 
143 protected:
144  /// Returns the kind of schema this class belongs to.
145  ///
146  /// \sa UsdSchemaKind
147  USDRI_API
148  UsdSchemaKind _GetSchemaKind() const override;
149 
150 private:
151  // needs to invoke _GetStaticTfType.
152  friend class UsdSchemaRegistry;
153  USDRI_API
154  static const TfType &_GetStaticTfType();
155 
156  static bool _IsTypedSchema();
157 
158  // override SchemaBase virtuals.
159  USDRI_API
160  const TfType &_GetTfType() const override;
161 
162 public:
163  // --------------------------------------------------------------------- //
164  // WIDTH
165  // --------------------------------------------------------------------- //
166  /// Width of the inner region of the rod (X axis).
167  ///
168  /// | ||
169  /// | -- | -- |
170  /// | Declaration | `float width = 0` |
171  /// | C++ Type | float |
172  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
173  USDRI_API
174  UsdAttribute GetWidthAttr() const;
175 
176  /// See GetWidthAttr(), and also
177  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
178  /// If specified, author \p defaultValue as the attribute's default,
179  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
180  /// the default for \p writeSparsely is \c false.
181  USDRI_API
182  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
183 
184 public:
185  // --------------------------------------------------------------------- //
186  // HEIGHT
187  // --------------------------------------------------------------------- //
188  /// Height of the inner region of the rod (Y axis).
189  ///
190  /// | ||
191  /// | -- | -- |
192  /// | Declaration | `float height = 0` |
193  /// | C++ Type | float |
194  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
195  USDRI_API
196  UsdAttribute GetHeightAttr() const;
197 
198  /// See GetHeightAttr(), and also
199  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
200  /// If specified, author \p defaultValue as the attribute's default,
201  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
202  /// the default for \p writeSparsely is \c false.
203  USDRI_API
204  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
205 
206 public:
207  // --------------------------------------------------------------------- //
208  // DEPTH
209  // --------------------------------------------------------------------- //
210  /// Depth of the inner region of the rod (Z axis).
211  ///
212  /// | ||
213  /// | -- | -- |
214  /// | Declaration | `float depth = 0` |
215  /// | C++ Type | float |
216  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
217  USDRI_API
218  UsdAttribute GetDepthAttr() const;
219 
220  /// See GetDepthAttr(), and also
221  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
222  /// If specified, author \p defaultValue as the attribute's default,
223  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
224  /// the default for \p writeSparsely is \c false.
225  USDRI_API
226  UsdAttribute CreateDepthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
227 
228 public:
229  // --------------------------------------------------------------------- //
230  // RADIUS
231  // --------------------------------------------------------------------- //
232  /// Radius of the corners of the inner rod box.
233  ///
234  /// | ||
235  /// | -- | -- |
236  /// | Declaration | `float radius = 1` |
237  /// | C++ Type | float |
238  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
239  USDRI_API
240  UsdAttribute GetRadiusAttr() const;
241 
242  /// See GetRadiusAttr(), and also
243  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
244  /// If specified, author \p defaultValue as the attribute's default,
245  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
246  /// the default for \p writeSparsely is \c false.
247  USDRI_API
248  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
249 
250 public:
251  // --------------------------------------------------------------------- //
252  // EDGETHICKNESS
253  // --------------------------------------------------------------------- //
254  /// Thickness of the edge region. Larger values will
255  /// soften the edge shape.
256  ///
257  /// | ||
258  /// | -- | -- |
259  /// | Declaration | `float edgeThickness = 0.25` |
260  /// | C++ Type | float |
261  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
262  USDRI_API
264 
265  /// See GetEdgeThicknessAttr(), and also
266  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
267  /// If specified, author \p defaultValue as the attribute's default,
268  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
269  /// the default for \p writeSparsely is \c false.
270  USDRI_API
271  UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
272 
273 public:
274  // --------------------------------------------------------------------- //
275  // SCALEWIDTH
276  // --------------------------------------------------------------------- //
277  /// Scale the width of the inner rod shape.
278  ///
279  /// | ||
280  /// | -- | -- |
281  /// | Declaration | `float scale:width = 1` |
282  /// | C++ Type | float |
283  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
284  USDRI_API
286 
287  /// See GetScaleWidthAttr(), and also
288  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
289  /// If specified, author \p defaultValue as the attribute's default,
290  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
291  /// the default for \p writeSparsely is \c false.
292  USDRI_API
293  UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
294 
295 public:
296  // --------------------------------------------------------------------- //
297  // SCALEHEIGHT
298  // --------------------------------------------------------------------- //
299  /// Scale the height of the inner rod shape.
300  ///
301  /// | ||
302  /// | -- | -- |
303  /// | Declaration | `float scale:height = 1` |
304  /// | C++ Type | float |
305  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
306  USDRI_API
308 
309  /// See GetScaleHeightAttr(), and also
310  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
311  /// If specified, author \p defaultValue as the attribute's default,
312  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
313  /// the default for \p writeSparsely is \c false.
314  USDRI_API
315  UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
316 
317 public:
318  // --------------------------------------------------------------------- //
319  // SCALEDEPTH
320  // --------------------------------------------------------------------- //
321  /// Scale the depth of the inner rod shape.
322  ///
323  /// | ||
324  /// | -- | -- |
325  /// | Declaration | `float scale:depth = 1` |
326  /// | C++ Type | float |
327  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
328  USDRI_API
330 
331  /// See GetScaleDepthAttr(), and also
332  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
333  /// If specified, author \p defaultValue as the attribute's default,
334  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
335  /// the default for \p writeSparsely is \c false.
336  USDRI_API
337  UsdAttribute CreateScaleDepthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
338 
339 public:
340  // --------------------------------------------------------------------- //
341  // REFINETOP
342  // --------------------------------------------------------------------- //
343  /// Additional offset adjustment to the top region.
344  ///
345  /// | ||
346  /// | -- | -- |
347  /// | Declaration | `float refine:top = 0` |
348  /// | C++ Type | float |
349  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
350  USDRI_API
352 
353  /// See GetRefineTopAttr(), and also
354  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
355  /// If specified, author \p defaultValue as the attribute's default,
356  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
357  /// the default for \p writeSparsely is \c false.
358  USDRI_API
359  UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
360 
361 public:
362  // --------------------------------------------------------------------- //
363  // REFINEBOTTOM
364  // --------------------------------------------------------------------- //
365  /// Additional offset adjustment to the top region.
366  ///
367  /// | ||
368  /// | -- | -- |
369  /// | Declaration | `float refine:bottom = 0` |
370  /// | C++ Type | float |
371  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
372  USDRI_API
374 
375  /// See GetRefineBottomAttr(), and also
376  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
377  /// If specified, author \p defaultValue as the attribute's default,
378  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
379  /// the default for \p writeSparsely is \c false.
380  USDRI_API
381  UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
382 
383 public:
384  // --------------------------------------------------------------------- //
385  // REFINELEFT
386  // --------------------------------------------------------------------- //
387  /// Additional offset adjustment to the left region.
388  ///
389  /// | ||
390  /// | -- | -- |
391  /// | Declaration | `float refine:left = 0` |
392  /// | C++ Type | float |
393  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
394  USDRI_API
396 
397  /// See GetRefineLeftAttr(), and also
398  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
399  /// If specified, author \p defaultValue as the attribute's default,
400  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
401  /// the default for \p writeSparsely is \c false.
402  USDRI_API
403  UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
404 
405 public:
406  // --------------------------------------------------------------------- //
407  // REFINERIGHT
408  // --------------------------------------------------------------------- //
409  /// Additional offset adjustment to the left region.
410  ///
411  /// | ||
412  /// | -- | -- |
413  /// | Declaration | `float refine:right = 0` |
414  /// | C++ Type | float |
415  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
416  USDRI_API
418 
419  /// See GetRefineRightAttr(), and also
420  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
421  /// If specified, author \p defaultValue as the attribute's default,
422  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
423  /// the default for \p writeSparsely is \c false.
424  USDRI_API
425  UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
426 
427 public:
428  // --------------------------------------------------------------------- //
429  // REFINEFRONT
430  // --------------------------------------------------------------------- //
431  /// Additional offset adjustment to the front region.
432  ///
433  /// | ||
434  /// | -- | -- |
435  /// | Declaration | `float refine:front = 0` |
436  /// | C++ Type | float |
437  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
438  USDRI_API
440 
441  /// See GetRefineFrontAttr(), and also
442  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
443  /// If specified, author \p defaultValue as the attribute's default,
444  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
445  /// the default for \p writeSparsely is \c false.
446  USDRI_API
447  UsdAttribute CreateRefineFrontAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
448 
449 public:
450  // --------------------------------------------------------------------- //
451  // REFINEBACK
452  // --------------------------------------------------------------------- //
453  /// Additional offset adjustment to the back region.
454  ///
455  /// | ||
456  /// | -- | -- |
457  /// | Declaration | `float refine:back = 0` |
458  /// | C++ Type | float |
459  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
460  USDRI_API
462 
463  /// See GetRefineBackAttr(), and also
464  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
465  /// If specified, author \p defaultValue as the attribute's default,
466  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
467  /// the default for \p writeSparsely is \c false.
468  USDRI_API
469  UsdAttribute CreateRefineBackAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
470 
471 public:
472  // --------------------------------------------------------------------- //
473  // EDGESCALETOP
474  // --------------------------------------------------------------------- //
475  /// Additional edge scale adjustment to the top region.
476  ///
477  /// | ||
478  /// | -- | -- |
479  /// | Declaration | `float edgeScale:top = 1` |
480  /// | C++ Type | float |
481  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
482  USDRI_API
484 
485  /// See GetEdgeScaleTopAttr(), and also
486  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
487  /// If specified, author \p defaultValue as the attribute's default,
488  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
489  /// the default for \p writeSparsely is \c false.
490  USDRI_API
491  UsdAttribute CreateEdgeScaleTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
492 
493 public:
494  // --------------------------------------------------------------------- //
495  // EDGESCALEBOTTOM
496  // --------------------------------------------------------------------- //
497  /// Additional edge scale adjustment to the top region.
498  ///
499  /// | ||
500  /// | -- | -- |
501  /// | Declaration | `float edgeScale:bottom = 1` |
502  /// | C++ Type | float |
503  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
504  USDRI_API
506 
507  /// See GetEdgeScaleBottomAttr(), and also
508  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
509  /// If specified, author \p defaultValue as the attribute's default,
510  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
511  /// the default for \p writeSparsely is \c false.
512  USDRI_API
513  UsdAttribute CreateEdgeScaleBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
514 
515 public:
516  // --------------------------------------------------------------------- //
517  // EDGESCALELEFT
518  // --------------------------------------------------------------------- //
519  /// Additional edge scale adjustment to the left region.
520  ///
521  /// | ||
522  /// | -- | -- |
523  /// | Declaration | `float edgeScale:left = 1` |
524  /// | C++ Type | float |
525  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
526  USDRI_API
528 
529  /// See GetEdgeScaleLeftAttr(), and also
530  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
531  /// If specified, author \p defaultValue as the attribute's default,
532  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
533  /// the default for \p writeSparsely is \c false.
534  USDRI_API
535  UsdAttribute CreateEdgeScaleLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
536 
537 public:
538  // --------------------------------------------------------------------- //
539  // EDGESCALERIGHT
540  // --------------------------------------------------------------------- //
541  /// Additional edge scale adjustment to the left region.
542  ///
543  /// | ||
544  /// | -- | -- |
545  /// | Declaration | `float edgeScale:right = 1` |
546  /// | C++ Type | float |
547  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
548  USDRI_API
550 
551  /// See GetEdgeScaleRightAttr(), and also
552  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
553  /// If specified, author \p defaultValue as the attribute's default,
554  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
555  /// the default for \p writeSparsely is \c false.
556  USDRI_API
557  UsdAttribute CreateEdgeScaleRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
558 
559 public:
560  // --------------------------------------------------------------------- //
561  // EDGESCALEFRONT
562  // --------------------------------------------------------------------- //
563  /// Additional edge scale adjustment to the front region.
564  ///
565  /// | ||
566  /// | -- | -- |
567  /// | Declaration | `float edgeScale:front = 1` |
568  /// | C++ Type | float |
569  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
570  USDRI_API
572 
573  /// See GetEdgeScaleFrontAttr(), and also
574  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
575  /// If specified, author \p defaultValue as the attribute's default,
576  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
577  /// the default for \p writeSparsely is \c false.
578  USDRI_API
579  UsdAttribute CreateEdgeScaleFrontAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
580 
581 public:
582  // --------------------------------------------------------------------- //
583  // EDGESCALEBACK
584  // --------------------------------------------------------------------- //
585  /// Additional edge scale adjustment to the back region.
586  ///
587  /// | ||
588  /// | -- | -- |
589  /// | Declaration | `float edgeScale:back = 1` |
590  /// | C++ Type | float |
591  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
592  USDRI_API
594 
595  /// See GetEdgeScaleBackAttr(), and also
596  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
597  /// If specified, author \p defaultValue as the attribute's default,
598  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
599  /// the default for \p writeSparsely is \c false.
600  USDRI_API
601  UsdAttribute CreateEdgeScaleBackAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
602 
603 public:
604  // --------------------------------------------------------------------- //
605  // COLORSATURATION
606  // --------------------------------------------------------------------- //
607  /// Saturation of the result (0=greyscale, 1=normal,
608  /// >1=boosted colors).
609  ///
610  /// | ||
611  /// | -- | -- |
612  /// | Declaration | `float color:saturation = 1` |
613  /// | C++ Type | float |
614  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
615  USDRI_API
617 
618  /// See GetColorSaturationAttr(), and also
619  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
620  /// If specified, author \p defaultValue as the attribute's default,
621  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
622  /// the default for \p writeSparsely is \c false.
623  USDRI_API
624  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
625 
626 public:
627  // --------------------------------------------------------------------- //
628  // FALLOFF
629  // --------------------------------------------------------------------- //
630  /// Controls the transition from the core to the edge.
631  ///
632  /// | ||
633  /// | -- | -- |
634  /// | Declaration | `int falloff = 6` |
635  /// | C++ Type | int |
636  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Int |
637  USDRI_API
639 
640  /// See GetFalloffAttr(), and also
641  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
642  /// If specified, author \p defaultValue as the attribute's default,
643  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
644  /// the default for \p writeSparsely is \c false.
645  USDRI_API
646  UsdAttribute CreateFalloffAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
647 
648 public:
649  // --------------------------------------------------------------------- //
650  // FALLOFFKNOTS
651  // --------------------------------------------------------------------- //
652  /// Knots of the falloff spline.
653  ///
654  /// | ||
655  /// | -- | -- |
656  /// | Declaration | `float[] falloff:knots = [0, 0, 0.3, 0.7, 1, 1]` |
657  /// | C++ Type | VtArray<float> |
658  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->FloatArray |
659  USDRI_API
661 
662  /// See GetFalloffKnotsAttr(), and also
663  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
664  /// If specified, author \p defaultValue as the attribute's default,
665  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
666  /// the default for \p writeSparsely is \c false.
667  USDRI_API
668  UsdAttribute CreateFalloffKnotsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
669 
670 public:
671  // --------------------------------------------------------------------- //
672  // FALLOFFFLOATS
673  // --------------------------------------------------------------------- //
674  /// Float values of the falloff spline.
675  ///
676  /// | ||
677  /// | -- | -- |
678  /// | Declaration | `float[] falloff:floats = [0, 0, 0.2, 0.8, 1, 1]` |
679  /// | C++ Type | VtArray<float> |
680  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->FloatArray |
681  USDRI_API
683 
684  /// See GetFalloffFloatsAttr(), and also
685  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
686  /// If specified, author \p defaultValue as the attribute's default,
687  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
688  /// the default for \p writeSparsely is \c false.
689  USDRI_API
690  UsdAttribute CreateFalloffFloatsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
691 
692 public:
693  // --------------------------------------------------------------------- //
694  // FALLOFFINTERPOLATION
695  // --------------------------------------------------------------------- //
696  /// Falloff spline type.
697  ///
698  /// | ||
699  /// | -- | -- |
700  /// | Declaration | `token falloff:interpolation = "bspline"` |
701  /// | C++ Type | TfToken |
702  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
703  /// | \ref UsdRiTokens "Allowed Values" | linear, catmull-rom, bspline, constant |
704  USDRI_API
706 
707  /// See GetFalloffInterpolationAttr(), and also
708  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
709  /// If specified, author \p defaultValue as the attribute's default,
710  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
711  /// the default for \p writeSparsely is \c false.
712  USDRI_API
713  UsdAttribute CreateFalloffInterpolationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
714 
715 public:
716  // --------------------------------------------------------------------- //
717  // COLORRAMP
718  // --------------------------------------------------------------------- //
719  /// Controls the color gradient for the transition.
720  ///
721  /// | ||
722  /// | -- | -- |
723  /// | Declaration | `int colorRamp = 4` |
724  /// | C++ Type | int |
725  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Int |
726  USDRI_API
728 
729  /// See GetColorRampAttr(), and also
730  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
731  /// If specified, author \p defaultValue as the attribute's default,
732  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
733  /// the default for \p writeSparsely is \c false.
734  USDRI_API
735  UsdAttribute CreateColorRampAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
736 
737 public:
738  // --------------------------------------------------------------------- //
739  // COLORRAMPKNOTS
740  // --------------------------------------------------------------------- //
741  /// Knots of the colorRamp spline.
742  ///
743  /// | ||
744  /// | -- | -- |
745  /// | Declaration | `float[] colorRamp:knots = [0, 0, 1, 1]` |
746  /// | C++ Type | VtArray<float> |
747  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->FloatArray |
748  USDRI_API
750 
751  /// See GetColorRampKnotsAttr(), and also
752  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
753  /// If specified, author \p defaultValue as the attribute's default,
754  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
755  /// the default for \p writeSparsely is \c false.
756  USDRI_API
757  UsdAttribute CreateColorRampKnotsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
758 
759 public:
760  // --------------------------------------------------------------------- //
761  // COLORRAMPCOLORS
762  // --------------------------------------------------------------------- //
763  /// Color values of the colorRamp spline.
764  ///
765  /// | ||
766  /// | -- | -- |
767  /// | Declaration | `color3f[] colorRamp:colors = [(1, 1, 1), (1, 1, 1), (1, 1, 1), (1, 1, 1)]` |
768  /// | C++ Type | VtArray<GfVec3f> |
769  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Color3fArray |
770  USDRI_API
772 
773  /// See GetColorRampColorsAttr(), and also
774  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
775  /// If specified, author \p defaultValue as the attribute's default,
776  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
777  /// the default for \p writeSparsely is \c false.
778  USDRI_API
779  UsdAttribute CreateColorRampColorsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
780 
781 public:
782  // --------------------------------------------------------------------- //
783  // COLORRAMPINTERPOLATION
784  // --------------------------------------------------------------------- //
785  /// ColorRamp spline type.
786  ///
787  /// | ||
788  /// | -- | -- |
789  /// | Declaration | `token colorRamp:interpolation = "linear"` |
790  /// | C++ Type | TfToken |
791  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
792  /// | \ref UsdRiTokens "Allowed Values" | linear, catmull-rom, bspline, constant |
793  USDRI_API
795 
796  /// See GetColorRampInterpolationAttr(), and also
797  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
798  /// If specified, author \p defaultValue as the attribute's default,
799  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
800  /// the default for \p writeSparsely is \c false.
801  USDRI_API
802  UsdAttribute CreateColorRampInterpolationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
803 
804 public:
805  // ===================================================================== //
806  // Feel free to add custom code below this line, it will be preserved by
807  // the code generator.
808  //
809  // Just remember to:
810  // - Close the class declaration with };
811  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
812  // - Close the include guard with #endif
813  // ===================================================================== //
814  // --(BEGIN CUSTOM CODE)--
815 
816  /// Return the UsdRiSplineAPI interface used for examining and modifying
817  /// the falloff ramp. The values of the spline knots are of type float.
818  USDRI_API
820 
821  /// Return the UsdRiSplineAPI interface used for examining and modifying
822  /// the color ramp. The values of the spline knots are of type GfVec3f,
823  /// representing RGB colors.
824  USDRI_API
826 };
827 
829 
830 #endif
USDRI_API UsdAttribute GetFalloffKnotsAttr() const
USDRI_API UsdAttribute GetEdgeScaleBackAttr() const
UsdRiPxrRodLightFilter(const UsdSchemaBase &schemaObj)
USDRI_API UsdAttribute CreateDepthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateEdgeScaleLeftAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateFalloffFloatsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetEdgeScaleFrontAttr() const
USDRI_API UsdAttribute CreateRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateEdgeScaleFrontAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
static USDRI_API UsdRiPxrRodLightFilter Define(const UsdStagePtr &stage, const SdfPath &path)
static USDRI_API UsdRiPxrRodLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
USDRI_API UsdAttribute GetEdgeScaleBottomAttr() const
USDRI_API UsdAttribute CreateWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
USDRI_API UsdAttribute CreateRefineFrontAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetEdgeScaleLeftAttr() const
USDRI_API UsdAttribute CreateColorRampKnotsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetRefineBottomAttr() const
USDRI_API UsdRiSplineAPI GetFalloffRampAPI() const
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
UsdRiPxrRodLightFilter(const UsdPrim &prim=UsdPrim())
USDRI_API UsdAttribute GetRefineLeftAttr() const
UsdSchemaKind
Definition: common.h:127
USDRI_API UsdAttribute GetEdgeScaleRightAttr() const
USDRI_API UsdAttribute CreateFalloffInterpolationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetRefineRightAttr() const
USDRI_API UsdAttribute GetRefineFrontAttr() const
USDRI_API UsdAttribute GetColorSaturationAttr() const
USDRI_API UsdAttribute GetScaleHeightAttr() const
USDRI_API UsdAttribute GetScaleDepthAttr() const
USDRI_API UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetEdgeThicknessAttr() const
USDRI_API UsdAttribute CreateScaleDepthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Represents a concrete typed schema.
USDRI_API UsdAttribute CreateEdgeScaleBackAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
USDRI_API UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetHeightAttr() const
#define USDRI_API
Definition: api.h:40
Definition: path.h:288
USDRI_API UsdAttribute CreateColorRampInterpolationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateRefineBackAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateEdgeScaleRightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetRefineTopAttr() const
USDRI_API UsdAttribute CreateFalloffKnotsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetScaleWidthAttr() const
USDRI_API UsdAttribute CreateHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateColorRampColorsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetFalloffAttr() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
USDRI_API UsdAttribute GetFalloffFloatsAttr() const
USDRI_API UsdAttribute GetFalloffInterpolationAttr() const
USDRI_API UsdAttribute GetRefineBackAttr() const
virtual USDRI_API ~UsdRiPxrRodLightFilter()
Destructor.
USDRI_API UsdAttribute GetColorRampColorsAttr() const
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
USDRI_API UsdAttribute GetRadiusAttr() const
USDRI_API UsdAttribute CreateFalloffAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Definition: type.h:64
USDRI_API UsdAttribute GetDepthAttr() const
USDRI_API UsdAttribute CreateEdgeScaleTopAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdRiSplineAPI GetColorRampAPI() const
USDRI_API UsdAttribute GetColorRampAttr() const
USDRI_API UsdAttribute CreateEdgeScaleBottomAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetColorRampKnotsAttr() const
USDRI_API UsdSchemaKind _GetSchemaKind() const override
USDRI_API UsdAttribute GetEdgeScaleTopAttr() const
Definition: value.h:168
static const UsdSchemaKind schemaKind
USDRI_API UsdAttribute GetWidthAttr() const
USDRI_API UsdAttribute GetColorRampInterpolationAttr() const
USDRI_API UsdAttribute CreateColorRampAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const