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  // --------------------------------------------------------------------- //
176  USDRI_API
178 
184  USDRI_API
185  UsdAttribute CreateCookieModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
186 
187 public:
188  // --------------------------------------------------------------------- //
189  // WIDTH
190  // --------------------------------------------------------------------- //
198  USDRI_API
199  UsdAttribute GetWidthAttr() const;
200 
206  USDRI_API
207  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
208 
209 public:
210  // --------------------------------------------------------------------- //
211  // HEIGHT
212  // --------------------------------------------------------------------- //
220  USDRI_API
221  UsdAttribute GetHeightAttr() const;
222 
228  USDRI_API
229  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
230 
231 public:
232  // --------------------------------------------------------------------- //
233  // TEXTUREMAP
234  // --------------------------------------------------------------------- //
242  USDRI_API
244 
250  USDRI_API
251  UsdAttribute CreateTextureMapAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
252 
253 public:
254  // --------------------------------------------------------------------- //
255  // TEXTUREWRAPMODE
256  // --------------------------------------------------------------------- //
269  USDRI_API
271 
277  USDRI_API
278  UsdAttribute CreateTextureWrapModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
279 
280 public:
281  // --------------------------------------------------------------------- //
282  // TEXTUREFILLCOLOR
283  // --------------------------------------------------------------------- //
292  USDRI_API
294 
300  USDRI_API
301  UsdAttribute CreateTextureFillColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
302 
303 public:
304  // --------------------------------------------------------------------- //
305  // TEXTUREPREMULTIPLIEDALPHA
306  // --------------------------------------------------------------------- //
315  USDRI_API
317 
323  USDRI_API
324  UsdAttribute CreateTexturePremultipliedAlphaAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
325 
326 public:
327  // --------------------------------------------------------------------- //
328  // TEXTUREINVERTU
329  // --------------------------------------------------------------------- //
339  USDRI_API
341 
347  USDRI_API
348  UsdAttribute CreateTextureInvertUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
349 
350 public:
351  // --------------------------------------------------------------------- //
352  // TEXTUREINVERTV
353  // --------------------------------------------------------------------- //
363  USDRI_API
365 
371  USDRI_API
372  UsdAttribute CreateTextureInvertVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
373 
374 public:
375  // --------------------------------------------------------------------- //
376  // TEXTURESCALEU
377  // --------------------------------------------------------------------- //
385  USDRI_API
387 
393  USDRI_API
394  UsdAttribute CreateTextureScaleUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
395 
396 public:
397  // --------------------------------------------------------------------- //
398  // TEXTURESCALEV
399  // --------------------------------------------------------------------- //
407  USDRI_API
409 
415  USDRI_API
416  UsdAttribute CreateTextureScaleVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
417 
418 public:
419  // --------------------------------------------------------------------- //
420  // TEXTUREOFFSETU
421  // --------------------------------------------------------------------- //
429  USDRI_API
431 
437  USDRI_API
438  UsdAttribute CreateTextureOffsetUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
439 
440 public:
441  // --------------------------------------------------------------------- //
442  // TEXTUREOFFSETV
443  // --------------------------------------------------------------------- //
451  USDRI_API
453 
459  USDRI_API
460  UsdAttribute CreateTextureOffsetVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
461 
462 public:
463  // --------------------------------------------------------------------- //
464  // ANALYTICDIRECTIONAL
465  // --------------------------------------------------------------------- //
475  USDRI_API
477 
483  USDRI_API
484  UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
485 
486 public:
487  // --------------------------------------------------------------------- //
488  // ANALYTICSHEARX
489  // --------------------------------------------------------------------- //
497  USDRI_API
499 
505  USDRI_API
506  UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
507 
508 public:
509  // --------------------------------------------------------------------- //
510  // ANALYTICSHEARY
511  // --------------------------------------------------------------------- //
519  USDRI_API
521 
527  USDRI_API
528  UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
529 
530 public:
531  // --------------------------------------------------------------------- //
532  // ANALYTICAPEX
533  // --------------------------------------------------------------------- //
541  USDRI_API
543 
549  USDRI_API
550  UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
551 
552 public:
553  // --------------------------------------------------------------------- //
554  // ANALYTICUSELIGHTDIRECTION
555  // --------------------------------------------------------------------- //
566  USDRI_API
568 
574  USDRI_API
575  UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
576 
577 public:
578  // --------------------------------------------------------------------- //
579  // ANALYTICBLURAMOUNT
580  // --------------------------------------------------------------------- //
591  USDRI_API
593 
599  USDRI_API
600  UsdAttribute CreateAnalyticBlurAmountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
601 
602 public:
603  // --------------------------------------------------------------------- //
604  // ANALYTICBLURSMULT
605  // --------------------------------------------------------------------- //
613  USDRI_API
615 
621  USDRI_API
622  UsdAttribute CreateAnalyticBlurSMultAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
623 
624 public:
625  // --------------------------------------------------------------------- //
626  // ANALYTICBLURTMULT
627  // --------------------------------------------------------------------- //
635  USDRI_API
637 
643  USDRI_API
644  UsdAttribute CreateAnalyticBlurTMultAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
645 
646 public:
647  // --------------------------------------------------------------------- //
648  // ANALYTICBLURNEARDISTANCE
649  // --------------------------------------------------------------------- //
658  USDRI_API
660 
666  USDRI_API
667  UsdAttribute CreateAnalyticBlurNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
668 
669 public:
670  // --------------------------------------------------------------------- //
671  // ANALYTICBLURMIDPOINT
672  // --------------------------------------------------------------------- //
680  USDRI_API
682 
688  USDRI_API
689  UsdAttribute CreateAnalyticBlurMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
690 
691 public:
692  // --------------------------------------------------------------------- //
693  // ANALYTICBLURFARDISTANCE
694  // --------------------------------------------------------------------- //
702  USDRI_API
704 
710  USDRI_API
711  UsdAttribute CreateAnalyticBlurFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
712 
713 public:
714  // --------------------------------------------------------------------- //
715  // ANALYTICBLURNEARVALUE
716  // --------------------------------------------------------------------- //
724  USDRI_API
726 
732  USDRI_API
733  UsdAttribute CreateAnalyticBlurNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
734 
735 public:
736  // --------------------------------------------------------------------- //
737  // ANALYTICBLURMIDVALUE
738  // --------------------------------------------------------------------- //
746  USDRI_API
748 
754  USDRI_API
755  UsdAttribute CreateAnalyticBlurMidValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
756 
757 public:
758  // --------------------------------------------------------------------- //
759  // ANALYTICBLURFARVALUE
760  // --------------------------------------------------------------------- //
768  USDRI_API
770 
776  USDRI_API
777  UsdAttribute CreateAnalyticBlurFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
778 
779 public:
780  // --------------------------------------------------------------------- //
781  // ANALYTICBLUREXPONENT
782  // --------------------------------------------------------------------- //
790  USDRI_API
792 
798  USDRI_API
799  UsdAttribute CreateAnalyticBlurExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
800 
801 public:
802  // --------------------------------------------------------------------- //
803  // ANALYTICDENSITYNEARDISTANCE
804  // --------------------------------------------------------------------- //
813  USDRI_API
815 
821  USDRI_API
822  UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
823 
824 public:
825  // --------------------------------------------------------------------- //
826  // ANALYTICDENSITYMIDPOINT
827  // --------------------------------------------------------------------- //
835  USDRI_API
837 
843  USDRI_API
844  UsdAttribute CreateAnalyticDensityMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
845 
846 public:
847  // --------------------------------------------------------------------- //
848  // ANALYTICDENSITYFARDISTANCE
849  // --------------------------------------------------------------------- //
858  USDRI_API
860 
866  USDRI_API
867  UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
868 
869 public:
870  // --------------------------------------------------------------------- //
871  // ANALYTICDENSITYNEARVALUE
872  // --------------------------------------------------------------------- //
880  USDRI_API
882 
888  USDRI_API
889  UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
890 
891 public:
892  // --------------------------------------------------------------------- //
893  // ANALYTICDENSITYMIDVALUE
894  // --------------------------------------------------------------------- //
902  USDRI_API
904 
910  USDRI_API
911  UsdAttribute CreateAnalyticDensityMidValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
912 
913 public:
914  // --------------------------------------------------------------------- //
915  // ANALYTICDENSITYFARVALUE
916  // --------------------------------------------------------------------- //
924  USDRI_API
926 
932  USDRI_API
933  UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
934 
935 public:
936  // --------------------------------------------------------------------- //
937  // ANALYTICDENSITYEXPONENT
938  // --------------------------------------------------------------------- //
946  USDRI_API
948 
954  USDRI_API
955  UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
956 
957 public:
958  // --------------------------------------------------------------------- //
959  // COLORSATURATION
960  // --------------------------------------------------------------------- //
969  USDRI_API
971 
977  USDRI_API
978  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
979 
980 public:
981  // --------------------------------------------------------------------- //
982  // COLORMIDPOINT
983  // --------------------------------------------------------------------- //
991  USDRI_API
993 
999  USDRI_API
1000  UsdAttribute CreateColorMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1001 
1002 public:
1003  // --------------------------------------------------------------------- //
1004  // COLORCONTRAST
1005  // --------------------------------------------------------------------- //
1014  USDRI_API
1016 
1022  USDRI_API
1023  UsdAttribute CreateColorContrastAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1024 
1025 public:
1026  // --------------------------------------------------------------------- //
1027  // COLORWHITEPOINT
1028  // --------------------------------------------------------------------- //
1036  USDRI_API
1038 
1044  USDRI_API
1045  UsdAttribute CreateColorWhitepointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1046 
1047 public:
1048  // --------------------------------------------------------------------- //
1049  // COLORTINT
1050  // --------------------------------------------------------------------- //
1059  USDRI_API
1061 
1067  USDRI_API
1068  UsdAttribute CreateColorTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1069 
1070 public:
1071  // ===================================================================== //
1072  // Feel free to add custom code below this line, it will be preserved by
1073  // the code generator.
1074  //
1075  // Just remember to:
1076  // - Close the class declaration with };
1077  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
1078  // - Close the include guard with #endif
1079  // ===================================================================== //
1080  // --(BEGIN CUSTOM CODE)--
1081 };
1082 
1083 PXR_NAMESPACE_CLOSE_SCOPE
1084 
1085 #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:127
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:433
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