HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
lightPortalAPI.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_LIGHTPORTALAPI_H
25 #define USDRI_GENERATED_LIGHTPORTALAPI_H
26 
27 /// \file usdRi/lightPortalAPI.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.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 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // RILIGHTPORTALAPI //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRiLightPortalAPI
54 ///
55 ///
56 /// \deprecated RenderMan-specific light portal settings will move to a
57 /// new schema in a future release.
58 ///
59 /// Renderman-specific attributes for light portals.
60 ///
62 {
63 public:
64  /// Compile time constant representing what kind of schema this class is.
65  ///
66  /// \sa UsdSchemaKind
68 
69  /// Construct a UsdRiLightPortalAPI on UsdPrim \p prim .
70  /// Equivalent to UsdRiLightPortalAPI::Get(prim.GetStage(), prim.GetPath())
71  /// for a \em valid \p prim, but will not immediately throw an error for
72  /// an invalid \p prim
73  explicit UsdRiLightPortalAPI(const UsdPrim& prim=UsdPrim())
74  : UsdAPISchemaBase(prim)
75  {
76  }
77 
78  /// Construct a UsdRiLightPortalAPI on the prim held by \p schemaObj .
79  /// Should be preferred over UsdRiLightPortalAPI(schemaObj.GetPrim()),
80  /// as it preserves SchemaBase state.
81  explicit UsdRiLightPortalAPI(const UsdSchemaBase& schemaObj)
82  : UsdAPISchemaBase(schemaObj)
83  {
84  }
85 
86  /// Destructor.
87  USDRI_API
88  virtual ~UsdRiLightPortalAPI();
89 
90  /// Return a vector of names of all pre-declared attributes for this schema
91  /// class and all its ancestor classes. Does not include attributes that
92  /// may be authored by custom/extended methods of the schemas involved.
93  USDRI_API
94  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
97  /// Return a UsdRiLightPortalAPI holding the prim adhering to this
98  /// schema at \p path on \p stage. If no prim exists at \p path on
99  /// \p stage, or if the prim at that path does not adhere to this schema,
100  /// return an invalid schema object. This is shorthand for the following:
101  ///
102  /// \code
103  /// UsdRiLightPortalAPI(stage->GetPrimAtPath(path));
104  /// \endcode
105  ///
106  USDRI_API
107  static UsdRiLightPortalAPI
108  Get(const UsdStagePtr &stage, const SdfPath &path);
109 
110 
111  /// Returns true if this <b>single-apply</b> API schema can be applied to
112  /// the given \p prim. If this schema can not be a applied to the prim,
113  /// this returns false and, if provided, populates \p whyNot with the
114  /// reason it can not be applied.
115  ///
116  /// Note that if CanApply returns false, that does not necessarily imply
117  /// that calling Apply will fail. Callers are expected to call CanApply
118  /// before calling Apply if they want to ensure that it is valid to
119  /// apply a schema.
120  ///
121  /// \sa UsdPrim::GetAppliedSchemas()
122  /// \sa UsdPrim::HasAPI()
123  /// \sa UsdPrim::CanApplyAPI()
124  /// \sa UsdPrim::ApplyAPI()
125  /// \sa UsdPrim::RemoveAPI()
126  ///
127  USDRI_API
128  static bool
129  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
130 
131  /// Applies this <b>single-apply</b> API schema to the given \p prim.
132  /// This information is stored by adding "RiLightPortalAPI" to the
133  /// token-valued, listOp metadata \em apiSchemas on the prim.
134  ///
135  /// \return A valid UsdRiLightPortalAPI object is returned upon success.
136  /// An invalid (or empty) UsdRiLightPortalAPI object is returned upon
137  /// failure. See \ref UsdPrim::ApplyAPI() for conditions
138  /// resulting in failure.
139  ///
140  /// \sa UsdPrim::GetAppliedSchemas()
141  /// \sa UsdPrim::HasAPI()
142  /// \sa UsdPrim::CanApplyAPI()
143  /// \sa UsdPrim::ApplyAPI()
144  /// \sa UsdPrim::RemoveAPI()
145  ///
146  USDRI_API
147  static UsdRiLightPortalAPI
148  Apply(const UsdPrim &prim);
149 
150 protected:
151  /// Returns the kind of schema this class belongs to.
152  ///
153  /// \sa UsdSchemaKind
154  USDRI_API
155  UsdSchemaKind _GetSchemaKind() const override;
156 
157 private:
158  // needs to invoke _GetStaticTfType.
159  friend class UsdSchemaRegistry;
160  USDRI_API
161  static const TfType &_GetStaticTfType();
162 
163  static bool _IsTypedSchema();
164 
165  // override SchemaBase virtuals.
166  USDRI_API
167  const TfType &_GetTfType() const override;
168 
169 public:
170  // --------------------------------------------------------------------- //
171  // RIPORTALINTENSITY
172  // --------------------------------------------------------------------- //
173  /// Intensity adjustment relative to the light intensity.
174  /// This gets multiplied by the light's intensity and power
175  ///
176  /// | ||
177  /// | -- | -- |
178  /// | Declaration | `float ri:portal:intensity` |
179  /// | C++ Type | float |
180  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
181  USDRI_API
183 
184  /// See GetRiPortalIntensityAttr(), and also
185  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
186  /// If specified, author \p defaultValue as the attribute's default,
187  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
188  /// the default for \p writeSparsely is \c false.
189  USDRI_API
190  UsdAttribute CreateRiPortalIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
191 
192 public:
193  // --------------------------------------------------------------------- //
194  // RIPORTALTINT
195  // --------------------------------------------------------------------- //
196  /// tint: This parameter tints the color from the dome texture.
197  ///
198  /// | ||
199  /// | -- | -- |
200  /// | Declaration | `color3f ri:portal:tint` |
201  /// | C++ Type | GfVec3f |
202  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Color3f |
203  USDRI_API
205 
206  /// See GetRiPortalTintAttr(), and also
207  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
208  /// If specified, author \p defaultValue as the attribute's default,
209  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
210  /// the default for \p writeSparsely is \c false.
211  USDRI_API
212  UsdAttribute CreateRiPortalTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // ===================================================================== //
216  // Feel free to add custom code below this line, it will be preserved by
217  // the code generator.
218  //
219  // Just remember to:
220  // - Close the class declaration with };
221  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
222  // - Close the include guard with #endif
223  // ===================================================================== //
224  // --(BEGIN CUSTOM CODE)--
225 };
226 
228 
229 #endif
UsdRiLightPortalAPI(const UsdPrim &prim=UsdPrim())
USDRI_API UsdSchemaKind _GetSchemaKind() const override
USDRI_API UsdAttribute CreateRiPortalTintAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetRiPortalTintAttr() const
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
static const UsdSchemaKind schemaKind
UsdSchemaKind
Definition: common.h:127
Single Apply API schema.
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
static USDRI_API UsdRiLightPortalAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Definition: prim.h:132
static USDRI_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
static USDRI_API UsdRiLightPortalAPI Apply(const UsdPrim &prim)
#define USDRI_API
Definition: api.h:40
USDRI_API UsdAttribute CreateRiPortalIntensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Definition: path.h:288
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual USDRI_API ~UsdRiLightPortalAPI()
Destructor.
Definition: type.h:64
UsdRiLightPortalAPI(const UsdSchemaBase &schemaObj)
Definition: value.h:168
USDRI_API UsdAttribute GetRiPortalIntensityAttr() const