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 
65 class UsdRiPxrCookieLightFilter : public UsdLuxLightFilter
66 {
67 public:
71  static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
72 
77  explicit UsdRiPxrCookieLightFilter(const UsdPrim& prim=UsdPrim())
78  : UsdLuxLightFilter(prim)
79  {
80  }
81 
85  explicit UsdRiPxrCookieLightFilter(const UsdSchemaBase& schemaObj)
86  : UsdLuxLightFilter(schemaObj)
87  {
88  }
89 
91  USDRI_API
92  virtual ~UsdRiPxrCookieLightFilter();
93 
97  USDRI_API
98  static const TfTokenVector &
99  GetSchemaAttributeNames(bool includeInherited=true);
100 
110  USDRI_API
111  static UsdRiPxrCookieLightFilter
112  Get(const UsdStagePtr &stage, const SdfPath &path);
113 
136  USDRI_API
137  static UsdRiPxrCookieLightFilter
138  Define(const UsdStagePtr &stage, const SdfPath &path);
139 
140 protected:
144  USDRI_API
145  UsdSchemaKind _GetSchemaKind() const override;
146 
147 private:
148  // needs to invoke _GetStaticTfType.
149  friend class UsdSchemaRegistry;
150  USDRI_API
151  static const TfType &_GetStaticTfType();
152 
153  static bool _IsTypedSchema();
154 
155  // override SchemaBase virtuals.
156  USDRI_API
157  const TfType &_GetTfType() const override;
158 
159 public:
160  // --------------------------------------------------------------------- //
161  // COOKIEMODE
162  // --------------------------------------------------------------------- //
179  USDRI_API
180  UsdAttribute GetCookieModeAttr() const;
181 
187  USDRI_API
188  UsdAttribute CreateCookieModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // WIDTH
193  // --------------------------------------------------------------------- //
201  USDRI_API
202  UsdAttribute GetWidthAttr() const;
203 
209  USDRI_API
210  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
211 
212 public:
213  // --------------------------------------------------------------------- //
214  // HEIGHT
215  // --------------------------------------------------------------------- //
223  USDRI_API
224  UsdAttribute GetHeightAttr() const;
225 
231  USDRI_API
232  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
233 
234 public:
235  // --------------------------------------------------------------------- //
236  // TEXTUREMAP
237  // --------------------------------------------------------------------- //
245  USDRI_API
246  UsdAttribute GetTextureMapAttr() const;
247 
253  USDRI_API
254  UsdAttribute CreateTextureMapAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
255 
256 public:
257  // --------------------------------------------------------------------- //
258  // TEXTUREWRAPMODE
259  // --------------------------------------------------------------------- //
272  USDRI_API
273  UsdAttribute GetTextureWrapModeAttr() const;
274 
280  USDRI_API
281  UsdAttribute CreateTextureWrapModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
282 
283 public:
284  // --------------------------------------------------------------------- //
285  // TEXTUREFILLCOLOR
286  // --------------------------------------------------------------------- //
295  USDRI_API
296  UsdAttribute GetTextureFillColorAttr() const;
297 
303  USDRI_API
304  UsdAttribute CreateTextureFillColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
305 
306 public:
307  // --------------------------------------------------------------------- //
308  // TEXTUREPREMULTIPLIEDALPHA
309  // --------------------------------------------------------------------- //
318  USDRI_API
319  UsdAttribute GetTexturePremultipliedAlphaAttr() const;
320 
326  USDRI_API
327  UsdAttribute CreateTexturePremultipliedAlphaAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
328 
329 public:
330  // --------------------------------------------------------------------- //
331  // TEXTUREINVERTU
332  // --------------------------------------------------------------------- //
342  USDRI_API
343  UsdAttribute GetTextureInvertUAttr() const;
344 
350  USDRI_API
351  UsdAttribute CreateTextureInvertUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
352 
353 public:
354  // --------------------------------------------------------------------- //
355  // TEXTUREINVERTV
356  // --------------------------------------------------------------------- //
366  USDRI_API
367  UsdAttribute GetTextureInvertVAttr() const;
368 
374  USDRI_API
375  UsdAttribute CreateTextureInvertVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
376 
377 public:
378  // --------------------------------------------------------------------- //
379  // TEXTURESCALEU
380  // --------------------------------------------------------------------- //
388  USDRI_API
389  UsdAttribute GetTextureScaleUAttr() const;
390 
396  USDRI_API
397  UsdAttribute CreateTextureScaleUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
398 
399 public:
400  // --------------------------------------------------------------------- //
401  // TEXTURESCALEV
402  // --------------------------------------------------------------------- //
410  USDRI_API
411  UsdAttribute GetTextureScaleVAttr() const;
412 
418  USDRI_API
419  UsdAttribute CreateTextureScaleVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
420 
421 public:
422  // --------------------------------------------------------------------- //
423  // TEXTUREOFFSETU
424  // --------------------------------------------------------------------- //
432  USDRI_API
433  UsdAttribute GetTextureOffsetUAttr() const;
434 
440  USDRI_API
441  UsdAttribute CreateTextureOffsetUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
442 
443 public:
444  // --------------------------------------------------------------------- //
445  // TEXTUREOFFSETV
446  // --------------------------------------------------------------------- //
454  USDRI_API
455  UsdAttribute GetTextureOffsetVAttr() const;
456 
462  USDRI_API
463  UsdAttribute CreateTextureOffsetVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
464 
465 public:
466  // --------------------------------------------------------------------- //
467  // ANALYTICDIRECTIONAL
468  // --------------------------------------------------------------------- //
478  USDRI_API
479  UsdAttribute GetAnalyticDirectionalAttr() const;
480 
486  USDRI_API
487  UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
488 
489 public:
490  // --------------------------------------------------------------------- //
491  // ANALYTICSHEARX
492  // --------------------------------------------------------------------- //
500  USDRI_API
501  UsdAttribute GetAnalyticShearXAttr() const;
502 
508  USDRI_API
509  UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
510 
511 public:
512  // --------------------------------------------------------------------- //
513  // ANALYTICSHEARY
514  // --------------------------------------------------------------------- //
522  USDRI_API
523  UsdAttribute GetAnalyticShearYAttr() const;
524 
530  USDRI_API
531  UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
532 
533 public:
534  // --------------------------------------------------------------------- //
535  // ANALYTICAPEX
536  // --------------------------------------------------------------------- //
544  USDRI_API
545  UsdAttribute GetAnalyticApexAttr() const;
546 
552  USDRI_API
553  UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
554 
555 public:
556  // --------------------------------------------------------------------- //
557  // ANALYTICUSELIGHTDIRECTION
558  // --------------------------------------------------------------------- //
569  USDRI_API
570  UsdAttribute GetAnalyticUseLightDirectionAttr() const;
571 
577  USDRI_API
578  UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
579 
580 public:
581  // --------------------------------------------------------------------- //
582  // ANALYTICBLURAMOUNT
583  // --------------------------------------------------------------------- //
594  USDRI_API
595  UsdAttribute GetAnalyticBlurAmountAttr() const;
596 
602  USDRI_API
603  UsdAttribute CreateAnalyticBlurAmountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
604 
605 public:
606  // --------------------------------------------------------------------- //
607  // ANALYTICBLURSMULT
608  // --------------------------------------------------------------------- //
616  USDRI_API
617  UsdAttribute GetAnalyticBlurSMultAttr() const;
618 
624  USDRI_API
625  UsdAttribute CreateAnalyticBlurSMultAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
626 
627 public:
628  // --------------------------------------------------------------------- //
629  // ANALYTICBLURTMULT
630  // --------------------------------------------------------------------- //
638  USDRI_API
639  UsdAttribute GetAnalyticBlurTMultAttr() const;
640 
646  USDRI_API
647  UsdAttribute CreateAnalyticBlurTMultAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
648 
649 public:
650  // --------------------------------------------------------------------- //
651  // ANALYTICBLURNEARDISTANCE
652  // --------------------------------------------------------------------- //
661  USDRI_API
662  UsdAttribute GetAnalyticBlurNearDistanceAttr() const;
663 
669  USDRI_API
670  UsdAttribute CreateAnalyticBlurNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
671 
672 public:
673  // --------------------------------------------------------------------- //
674  // ANALYTICBLURMIDPOINT
675  // --------------------------------------------------------------------- //
683  USDRI_API
684  UsdAttribute GetAnalyticBlurMidpointAttr() const;
685 
691  USDRI_API
692  UsdAttribute CreateAnalyticBlurMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
693 
694 public:
695  // --------------------------------------------------------------------- //
696  // ANALYTICBLURFARDISTANCE
697  // --------------------------------------------------------------------- //
705  USDRI_API
706  UsdAttribute GetAnalyticBlurFarDistanceAttr() const;
707 
713  USDRI_API
714  UsdAttribute CreateAnalyticBlurFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
715 
716 public:
717  // --------------------------------------------------------------------- //
718  // ANALYTICBLURNEARVALUE
719  // --------------------------------------------------------------------- //
727  USDRI_API
728  UsdAttribute GetAnalyticBlurNearValueAttr() const;
729 
735  USDRI_API
736  UsdAttribute CreateAnalyticBlurNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
737 
738 public:
739  // --------------------------------------------------------------------- //
740  // ANALYTICBLURMIDVALUE
741  // --------------------------------------------------------------------- //
749  USDRI_API
750  UsdAttribute GetAnalyticBlurMidValueAttr() const;
751 
757  USDRI_API
758  UsdAttribute CreateAnalyticBlurMidValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
759 
760 public:
761  // --------------------------------------------------------------------- //
762  // ANALYTICBLURFARVALUE
763  // --------------------------------------------------------------------- //
771  USDRI_API
772  UsdAttribute GetAnalyticBlurFarValueAttr() const;
773 
779  USDRI_API
780  UsdAttribute CreateAnalyticBlurFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
781 
782 public:
783  // --------------------------------------------------------------------- //
784  // ANALYTICBLUREXPONENT
785  // --------------------------------------------------------------------- //
793  USDRI_API
794  UsdAttribute GetAnalyticBlurExponentAttr() const;
795 
801  USDRI_API
802  UsdAttribute CreateAnalyticBlurExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
803 
804 public:
805  // --------------------------------------------------------------------- //
806  // ANALYTICDENSITYNEARDISTANCE
807  // --------------------------------------------------------------------- //
816  USDRI_API
817  UsdAttribute GetAnalyticDensityNearDistanceAttr() const;
818 
824  USDRI_API
825  UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
826 
827 public:
828  // --------------------------------------------------------------------- //
829  // ANALYTICDENSITYMIDPOINT
830  // --------------------------------------------------------------------- //
838  USDRI_API
839  UsdAttribute GetAnalyticDensityMidpointAttr() const;
840 
846  USDRI_API
847  UsdAttribute CreateAnalyticDensityMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
848 
849 public:
850  // --------------------------------------------------------------------- //
851  // ANALYTICDENSITYFARDISTANCE
852  // --------------------------------------------------------------------- //
861  USDRI_API
862  UsdAttribute GetAnalyticDensityFarDistanceAttr() const;
863 
869  USDRI_API
870  UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
871 
872 public:
873  // --------------------------------------------------------------------- //
874  // ANALYTICDENSITYNEARVALUE
875  // --------------------------------------------------------------------- //
883  USDRI_API
884  UsdAttribute GetAnalyticDensityNearValueAttr() const;
885 
891  USDRI_API
892  UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
893 
894 public:
895  // --------------------------------------------------------------------- //
896  // ANALYTICDENSITYMIDVALUE
897  // --------------------------------------------------------------------- //
905  USDRI_API
906  UsdAttribute GetAnalyticDensityMidValueAttr() const;
907 
913  USDRI_API
914  UsdAttribute CreateAnalyticDensityMidValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
915 
916 public:
917  // --------------------------------------------------------------------- //
918  // ANALYTICDENSITYFARVALUE
919  // --------------------------------------------------------------------- //
927  USDRI_API
928  UsdAttribute GetAnalyticDensityFarValueAttr() const;
929 
935  USDRI_API
936  UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
937 
938 public:
939  // --------------------------------------------------------------------- //
940  // ANALYTICDENSITYEXPONENT
941  // --------------------------------------------------------------------- //
949  USDRI_API
950  UsdAttribute GetAnalyticDensityExponentAttr() const;
951 
957  USDRI_API
958  UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
959 
960 public:
961  // --------------------------------------------------------------------- //
962  // COLORSATURATION
963  // --------------------------------------------------------------------- //
972  USDRI_API
973  UsdAttribute GetColorSaturationAttr() const;
974 
980  USDRI_API
981  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
982 
983 public:
984  // --------------------------------------------------------------------- //
985  // COLORMIDPOINT
986  // --------------------------------------------------------------------- //
994  USDRI_API
995  UsdAttribute GetColorMidpointAttr() const;
996 
1002  USDRI_API
1003  UsdAttribute CreateColorMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1004 
1005 public:
1006  // --------------------------------------------------------------------- //
1007  // COLORCONTRAST
1008  // --------------------------------------------------------------------- //
1017  USDRI_API
1018  UsdAttribute GetColorContrastAttr() const;
1019 
1025  USDRI_API
1026  UsdAttribute CreateColorContrastAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1027 
1028 public:
1029  // --------------------------------------------------------------------- //
1030  // COLORWHITEPOINT
1031  // --------------------------------------------------------------------- //
1039  USDRI_API
1040  UsdAttribute GetColorWhitepointAttr() const;
1041 
1047  USDRI_API
1048  UsdAttribute CreateColorWhitepointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1049 
1050 public:
1051  // --------------------------------------------------------------------- //
1052  // COLORTINT
1053  // --------------------------------------------------------------------- //
1062  USDRI_API
1063  UsdAttribute GetColorTintAttr() const;
1064 
1070  USDRI_API
1071  UsdAttribute CreateColorTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1072 
1073 public:
1074  // ===================================================================== //
1075  // Feel free to add custom code below this line, it will be preserved by
1076  // the code generator.
1077  //
1078  // Just remember to:
1079  // - Close the class declaration with };
1080  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
1081  // - Close the include guard with #endif
1082  // ===================================================================== //
1083  // --(BEGIN CUSTOM CODE)--
1084 };
1085 
1086 PXR_NAMESPACE_CLOSE_SCOPE
1087 
1088 #endif
UsdAttribute
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
UsdSchemaKind
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
UsdSchemaKind::ConcreteTyped
Represents a concrete typed schema.
UsdPrim
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
TfTokenVector
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
SdfPath
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
SdfAssetPath
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
TfType
TfType represents a dynamic runtime type.
Definition: type.h:64
UsdSchemaRegistry
Singleton registry that provides access to schema type information and the prim definitions for regis...
Definition: schemaRegistry.h:64
UsdSchemaBase
The base class for all schema types in Usd.
Definition: schemaBase.h:56
VtValue
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:168
token.h
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
UsdLuxLightFilter
A light filter modifies the effect of a light.
Definition: lightFilter.h:73