All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrCookieLightFilter.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_PXRCOOKIELIGHTFILTER_H
25 #define USDRI_GENERATED_PXRCOOKIELIGHTFILTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
31 #include "pxr/usd/usdLux/lightFilter.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdRi/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PXRCOOKIELIGHTFILTER //
51 // -------------------------------------------------------------------------- //
52 
63 {
64 public:
69 
74  explicit UsdRiPxrCookieLightFilter(const UsdPrim& prim=UsdPrim())
75  : UsdLuxLightFilter(prim)
76  {
77  }
78 
82  explicit UsdRiPxrCookieLightFilter(const UsdSchemaBase& schemaObj)
83  : UsdLuxLightFilter(schemaObj)
84  {
85  }
86 
88  USDRI_API
90 
94  USDRI_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  USDRI_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
133  USDRI_API
135  Define(const UsdStagePtr &stage, const SdfPath &path);
136 
137 protected:
141  USDRI_API
142  UsdSchemaType _GetSchemaType() const override;
143 
144 private:
145  // needs to invoke _GetStaticTfType.
146  friend class UsdSchemaRegistry;
147  USDRI_API
148  static const TfType &_GetStaticTfType();
149 
150  static bool _IsTypedSchema();
151 
152  // override SchemaBase virtuals.
153  USDRI_API
154  const TfType &_GetTfType() const override;
155 
156 public:
157  // --------------------------------------------------------------------- //
158  // COOKIEMODE
159  // --------------------------------------------------------------------- //
175  USDRI_API
177 
183  USDRI_API
184  UsdAttribute CreateCookieModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
185 
186 public:
187  // --------------------------------------------------------------------- //
188  // WIDTH
189  // --------------------------------------------------------------------- //
196  USDRI_API
197  UsdAttribute GetWidthAttr() const;
198 
204  USDRI_API
205  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
206 
207 public:
208  // --------------------------------------------------------------------- //
209  // HEIGHT
210  // --------------------------------------------------------------------- //
217  USDRI_API
218  UsdAttribute GetHeightAttr() const;
219 
225  USDRI_API
226  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
227 
228 public:
229  // --------------------------------------------------------------------- //
230  // TEXTUREMAP
231  // --------------------------------------------------------------------- //
238  USDRI_API
240 
246  USDRI_API
247  UsdAttribute CreateTextureMapAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
248 
249 public:
250  // --------------------------------------------------------------------- //
251  // TEXTUREWRAPMODE
252  // --------------------------------------------------------------------- //
264  USDRI_API
266 
272  USDRI_API
273  UsdAttribute CreateTextureWrapModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
274 
275 public:
276  // --------------------------------------------------------------------- //
277  // TEXTUREFILLCOLOR
278  // --------------------------------------------------------------------- //
286  USDRI_API
288 
294  USDRI_API
295  UsdAttribute CreateTextureFillColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
296 
297 public:
298  // --------------------------------------------------------------------- //
299  // TEXTUREINVERTU
300  // --------------------------------------------------------------------- //
309  USDRI_API
311 
317  USDRI_API
318  UsdAttribute CreateTextureInvertUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
319 
320 public:
321  // --------------------------------------------------------------------- //
322  // TEXTUREINVERTV
323  // --------------------------------------------------------------------- //
332  USDRI_API
334 
340  USDRI_API
341  UsdAttribute CreateTextureInvertVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
342 
343 public:
344  // --------------------------------------------------------------------- //
345  // TEXTURESCALEU
346  // --------------------------------------------------------------------- //
353  USDRI_API
355 
361  USDRI_API
362  UsdAttribute CreateTextureScaleUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
363 
364 public:
365  // --------------------------------------------------------------------- //
366  // TEXTURESCALEV
367  // --------------------------------------------------------------------- //
374  USDRI_API
376 
382  USDRI_API
383  UsdAttribute CreateTextureScaleVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
384 
385 public:
386  // --------------------------------------------------------------------- //
387  // TEXTUREOFFSETU
388  // --------------------------------------------------------------------- //
395  USDRI_API
397 
403  USDRI_API
404  UsdAttribute CreateTextureOffsetUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
405 
406 public:
407  // --------------------------------------------------------------------- //
408  // TEXTUREOFFSETV
409  // --------------------------------------------------------------------- //
416  USDRI_API
418 
424  USDRI_API
425  UsdAttribute CreateTextureOffsetVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
426 
427 public:
428  // --------------------------------------------------------------------- //
429  // ANALYTICDIRECTIONAL
430  // --------------------------------------------------------------------- //
439  USDRI_API
441 
447  USDRI_API
448  UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
449 
450 public:
451  // --------------------------------------------------------------------- //
452  // ANALYTICSHEARX
453  // --------------------------------------------------------------------- //
460  USDRI_API
462 
468  USDRI_API
469  UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
470 
471 public:
472  // --------------------------------------------------------------------- //
473  // ANALYTICSHEARY
474  // --------------------------------------------------------------------- //
481  USDRI_API
483 
489  USDRI_API
490  UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
491 
492 public:
493  // --------------------------------------------------------------------- //
494  // ANALYTICAPEX
495  // --------------------------------------------------------------------- //
502  USDRI_API
504 
510  USDRI_API
511  UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
512 
513 public:
514  // --------------------------------------------------------------------- //
515  // ANALYTICUSELIGHTDIRECTION
516  // --------------------------------------------------------------------- //
526  USDRI_API
528 
534  USDRI_API
535  UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
536 
537 public:
538  // --------------------------------------------------------------------- //
539  // ANALYTICBLURAMOUNT
540  // --------------------------------------------------------------------- //
550  USDRI_API
552 
558  USDRI_API
559  UsdAttribute CreateAnalyticBlurAmountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
560 
561 public:
562  // --------------------------------------------------------------------- //
563  // ANALYTICBLURSMULT
564  // --------------------------------------------------------------------- //
571  USDRI_API
573 
579  USDRI_API
580  UsdAttribute CreateAnalyticBlurSMultAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
581 
582 public:
583  // --------------------------------------------------------------------- //
584  // ANALYTICBLURTMULT
585  // --------------------------------------------------------------------- //
592  USDRI_API
594 
600  USDRI_API
601  UsdAttribute CreateAnalyticBlurTMultAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
602 
603 public:
604  // --------------------------------------------------------------------- //
605  // ANALYTICBLURNEARDISTANCE
606  // --------------------------------------------------------------------- //
614  USDRI_API
616 
622  USDRI_API
623  UsdAttribute CreateAnalyticBlurNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
624 
625 public:
626  // --------------------------------------------------------------------- //
627  // ANALYTICBLURMIDPOINT
628  // --------------------------------------------------------------------- //
635  USDRI_API
637 
643  USDRI_API
644  UsdAttribute CreateAnalyticBlurMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
645 
646 public:
647  // --------------------------------------------------------------------- //
648  // ANALYTICBLURFARDISTANCE
649  // --------------------------------------------------------------------- //
656  USDRI_API
658 
664  USDRI_API
665  UsdAttribute CreateAnalyticBlurFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
666 
667 public:
668  // --------------------------------------------------------------------- //
669  // ANALYTICBLURNEARVALUE
670  // --------------------------------------------------------------------- //
677  USDRI_API
679 
685  USDRI_API
686  UsdAttribute CreateAnalyticBlurNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
687 
688 public:
689  // --------------------------------------------------------------------- //
690  // ANALYTICBLURMIDVALUE
691  // --------------------------------------------------------------------- //
698  USDRI_API
700 
706  USDRI_API
707  UsdAttribute CreateAnalyticBlurMidValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
708 
709 public:
710  // --------------------------------------------------------------------- //
711  // ANALYTICBLURFARVALUE
712  // --------------------------------------------------------------------- //
719  USDRI_API
721 
727  USDRI_API
728  UsdAttribute CreateAnalyticBlurFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
729 
730 public:
731  // --------------------------------------------------------------------- //
732  // ANALYTICBLUREXPONENT
733  // --------------------------------------------------------------------- //
740  USDRI_API
742 
748  USDRI_API
749  UsdAttribute CreateAnalyticBlurExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
750 
751 public:
752  // --------------------------------------------------------------------- //
753  // ANALYTICDENSITYNEARDISTANCE
754  // --------------------------------------------------------------------- //
762  USDRI_API
764 
770  USDRI_API
771  UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
772 
773 public:
774  // --------------------------------------------------------------------- //
775  // ANALYTICDENSITYMIDPOINT
776  // --------------------------------------------------------------------- //
783  USDRI_API
785 
791  USDRI_API
792  UsdAttribute CreateAnalyticDensityMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
793 
794 public:
795  // --------------------------------------------------------------------- //
796  // ANALYTICDENSITYFARDISTANCE
797  // --------------------------------------------------------------------- //
805  USDRI_API
807 
813  USDRI_API
814  UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
815 
816 public:
817  // --------------------------------------------------------------------- //
818  // ANALYTICDENSITYNEARVALUE
819  // --------------------------------------------------------------------- //
826  USDRI_API
828 
834  USDRI_API
835  UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
836 
837 public:
838  // --------------------------------------------------------------------- //
839  // ANALYTICDENSITYMIDVALUE
840  // --------------------------------------------------------------------- //
847  USDRI_API
849 
855  USDRI_API
856  UsdAttribute CreateAnalyticDensityMidValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
857 
858 public:
859  // --------------------------------------------------------------------- //
860  // ANALYTICDENSITYFARVALUE
861  // --------------------------------------------------------------------- //
868  USDRI_API
870 
876  USDRI_API
877  UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
878 
879 public:
880  // --------------------------------------------------------------------- //
881  // ANALYTICDENSITYEXPONENT
882  // --------------------------------------------------------------------- //
889  USDRI_API
891 
897  USDRI_API
898  UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
899 
900 public:
901  // --------------------------------------------------------------------- //
902  // COLORSATURATION
903  // --------------------------------------------------------------------- //
911  USDRI_API
913 
919  USDRI_API
920  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
921 
922 public:
923  // --------------------------------------------------------------------- //
924  // COLORMIDPOINT
925  // --------------------------------------------------------------------- //
932  USDRI_API
934 
940  USDRI_API
941  UsdAttribute CreateColorMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
942 
943 public:
944  // --------------------------------------------------------------------- //
945  // COLORCONTRAST
946  // --------------------------------------------------------------------- //
954  USDRI_API
956 
962  USDRI_API
963  UsdAttribute CreateColorContrastAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
964 
965 public:
966  // --------------------------------------------------------------------- //
967  // COLORWHITEPOINT
968  // --------------------------------------------------------------------- //
975  USDRI_API
977 
983  USDRI_API
984  UsdAttribute CreateColorWhitepointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
985 
986 public:
987  // --------------------------------------------------------------------- //
988  // COLORTINT
989  // --------------------------------------------------------------------- //
997  USDRI_API
999 
1005  USDRI_API
1006  UsdAttribute CreateColorTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1007 
1008 public:
1009  // ===================================================================== //
1010  // Feel free to add custom code below this line, it will be preserved by
1011  // the code generator.
1012  //
1013  // Just remember to:
1014  // - Close the class declaration with };
1015  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
1016  // - Close the include guard with #endif
1017  // ===================================================================== //
1018  // --(BEGIN CUSTOM CODE)--
1019 };
1020 
1021 PXR_NAMESPACE_CLOSE_SCOPE
1022 
1023 #endif
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
A light filter modifies the effect of a light.
Definition: lightFilter.h:76