All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
riLightFilterAPI.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_RILIGHTFILTERAPI_H
25 #define USDRI_GENERATED_RILIGHTFILTERAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
31 #include "pxr/usd/usd/schemaBase.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 // RILIGHTFILTERAPI //
51 // -------------------------------------------------------------------------- //
52 
63 {
64 public:
69  static const bool IsConcrete = false;
70 
75  explicit UsdRiRiLightFilterAPI(const UsdPrim& prim=UsdPrim())
76  : UsdSchemaBase(prim)
77  {
78  }
79 
83  explicit UsdRiRiLightFilterAPI(const UsdSchemaBase& schemaObj)
84  : UsdSchemaBase(schemaObj)
85  {
86  }
87 
89  USDRI_API
90  virtual ~UsdRiRiLightFilterAPI();
91 
95  USDRI_API
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
108  USDRI_API
109  static UsdRiRiLightFilterAPI
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
112 
113 private:
114  // needs to invoke _GetStaticTfType.
115  friend class UsdSchemaRegistry;
116  USDRI_API
117  static const TfType &_GetStaticTfType();
118 
119  static bool _IsTypedSchema();
120 
121  // override SchemaBase virtuals.
122  USDRI_API
123  virtual const TfType &_GetTfType() const;
124 
125 public:
126  // --------------------------------------------------------------------- //
127  // RICOMBINEMODE
128  // --------------------------------------------------------------------- //
154  USDRI_API
156 
162  USDRI_API
163  UsdAttribute CreateRiCombineModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
164 
165 public:
166  // --------------------------------------------------------------------- //
167  // RIDENSITY
168  // --------------------------------------------------------------------- //
175  USDRI_API
177 
183  USDRI_API
184  UsdAttribute CreateRiDensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
185 
186 public:
187  // --------------------------------------------------------------------- //
188  // RIINVERT
189  // --------------------------------------------------------------------- //
196  USDRI_API
198 
204  USDRI_API
205  UsdAttribute CreateRiInvertAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
206 
207 public:
208  // --------------------------------------------------------------------- //
209  // RIINTENSITY
210  // --------------------------------------------------------------------- //
217  USDRI_API
219 
225  USDRI_API
226  UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
227 
228 public:
229  // --------------------------------------------------------------------- //
230  // RIDIFFUSE
231  // --------------------------------------------------------------------- //
239  USDRI_API
241 
247  USDRI_API
248  UsdAttribute CreateRiDiffuseAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
249 
250 public:
251  // --------------------------------------------------------------------- //
252  // RISPECULAR
253  // --------------------------------------------------------------------- //
261  USDRI_API
263 
269  USDRI_API
270  UsdAttribute CreateRiSpecularAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
271 
272 public:
273  // ===================================================================== //
274  // Feel free to add custom code below this line, it will be preserved by
275  // the code generator.
276  //
277  // Just remember to:
278  // - Close the class declaration with };
279  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
280  // - Close the include guard with #endif
281  // ===================================================================== //
282  // --(BEGIN CUSTOM CODE)--
283 };
284 
285 PXR_NAMESPACE_CLOSE_SCOPE
286 
287 #endif
USDRI_API UsdAttribute GetRiCombineModeAttr() const
Specifies how this filter combines with others.
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...
Renderman-specific attributes for light filters.
USDRI_API UsdAttribute GetRiSpecularAttr() const
A multiplier for the effect of this light on the specular response of materials.
USDRI_API UsdAttribute GetRiDensityAttr() const
Scales the strength of the filter.
USDRI_API UsdAttribute CreateRiDiffuseAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiDiffuseAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetRiInvertAttr() const
When true, inverts the output of the light filter.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
static USDRI_API UsdRiRiLightFilterAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiRiLightFilterAPI holding the prim adhering to this schema at path on stage...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
UsdRiRiLightFilterAPI(const UsdSchemaBase &schemaObj)
Construct a UsdRiRiLightFilterAPI on the prim held by schemaObj .
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
bool IsConcrete() const
Returns whether or not this class corresponds to a concrete instantiable prim type in scene descripti...
Definition: schemaBase.h:67
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...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDRI_API UsdAttribute GetRiDiffuseAttr() const
A multiplier for the effect of this light on the diffuse response of materials.
UsdRiRiLightFilterAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdRiRiLightFilterAPI on UsdPrim prim .
USDRI_API UsdAttribute CreateRiInvertAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiInvertAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
USDRI_API UsdAttribute CreateRiDensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiDensityAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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
USDRI_API UsdAttribute GetRiIntensityAttr() const
Multipier for the diffuse and specular result.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
USDRI_API UsdAttribute CreateRiSpecularAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiSpecularAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
virtual USDRI_API ~UsdRiRiLightFilterAPI()
Destructor.
USDRI_API UsdAttribute CreateRiCombineModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiCombineModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...