All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrIntMultLightFilter.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_PXRINTMULTLIGHTFILTER_H
25 #define USDRI_GENERATED_PXRINTMULTLIGHTFILTER_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 // PXRINTMULTLIGHTFILTER //
51 // -------------------------------------------------------------------------- //
52 
58 {
59 public:
64 
69  explicit UsdRiPxrIntMultLightFilter(const UsdPrim& prim=UsdPrim())
70  : UsdLuxLightFilter(prim)
71  {
72  }
73 
77  explicit UsdRiPxrIntMultLightFilter(const UsdSchemaBase& schemaObj)
78  : UsdLuxLightFilter(schemaObj)
79  {
80  }
81 
83  USDRI_API
85 
89  USDRI_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  USDRI_API
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
128  USDRI_API
130  Define(const UsdStagePtr &stage, const SdfPath &path);
131 
132 protected:
136  USDRI_API
137  UsdSchemaType _GetSchemaType() const override;
138 
139 private:
140  // needs to invoke _GetStaticTfType.
141  friend class UsdSchemaRegistry;
142  USDRI_API
143  static const TfType &_GetStaticTfType();
144 
145  static bool _IsTypedSchema();
146 
147  // override SchemaBase virtuals.
148  USDRI_API
149  const TfType &_GetTfType() const override;
150 
151 public:
152  // --------------------------------------------------------------------- //
153  // RIINTENSITY
154  // --------------------------------------------------------------------- //
163  USDRI_API
165 
171  USDRI_API
172  UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
173 
174 public:
175  // --------------------------------------------------------------------- //
176  // COLORSATURATION
177  // --------------------------------------------------------------------- //
186  USDRI_API
188 
194  USDRI_API
195  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
196 
197 public:
198  // ===================================================================== //
199  // Feel free to add custom code below this line, it will be preserved by
200  // the code generator.
201  //
202  // Just remember to:
203  // - Close the class declaration with };
204  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
205  // - Close the include guard with #endif
206  // ===================================================================== //
207  // --(BEGIN CUSTOM CODE)--
208 };
209 
210 PXR_NAMESPACE_CLOSE_SCOPE
211 
212 #endif
USDRI_API UsdAttribute GetRiIntensityAttr() const
Multipier for the light intensity.
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
UsdRiPxrIntMultLightFilter(const UsdSchemaBase &schemaObj)
Construct a UsdRiPxrIntMultLightFilter on the prim held by schemaObj .
virtual USDRI_API ~UsdRiPxrIntMultLightFilter()
Destructor.
USDRI_API UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetColorSaturationAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
USDRI_API UsdAttribute GetColorSaturationAttr() const
Saturation of the light before hitting the surface (0=greyscale,1=normal, >1=boosted colors)...
UsdRiPxrIntMultLightFilter(const UsdPrim &prim=UsdPrim())
Construct a UsdRiPxrIntMultLightFilter on UsdPrim prim .
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
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
Multiplies the intensity of a given light.
static USDRI_API UsdRiPxrIntMultLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiPxrIntMultLightFilter holding the prim adhering to this schema at path on stage...
TfType represents a dynamic runtime type.
Definition: type.h:70
USDRI_API UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiIntensityAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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
static USDRI_API UsdRiPxrIntMultLightFilter Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
A light filter modifies the effect of a light.
Definition: lightFilter.h:76