HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
houdiniViewportLightAPI.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 USDHOUDINI_GENERATED_HOUDINIVIEWPORTLIGHTAPI_H
25 #define USDHOUDINI_GENERATED_HOUDINIVIEWPORTLIGHTAPI_H
26 
27 /// \file usdHoudini/houdiniViewportLightAPI.h
28 
29 #include "pxr/pxr.h"
30 #include "./api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "./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 // HOUDINIVIEWPORTLIGHTAPI //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdHoudiniHoudiniViewportLightAPI
54 ///
55 ///
56 class
59 {
60 public:
61  /// Compile time constant representing what kind of schema this class is.
62  ///
63  /// \sa UsdSchemaKind
64  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
65 
66  /// Construct a UsdHoudiniHoudiniViewportLightAPI on UsdPrim \p prim .
67  /// Equivalent to UsdHoudiniHoudiniViewportLightAPI::Get(prim.GetStage(), prim.GetPath())
68  /// for a \em valid \p prim, but will not immediately throw an error for
69  /// an invalid \p prim
71  : UsdAPISchemaBase(prim)
72  {
73  }
74 
75  /// Construct a UsdHoudiniHoudiniViewportLightAPI on the prim held by \p schemaObj .
76  /// Should be preferred over UsdHoudiniHoudiniViewportLightAPI(schemaObj.GetPrim()),
77  /// as it preserves SchemaBase state.
79  : UsdAPISchemaBase(schemaObj)
80  {
81  }
82 
83  /// Destructor.
84  virtual ~UsdHoudiniHoudiniViewportLightAPI() override;
85 
86  /// Return a vector of names of all pre-declared attributes for this schema
87  /// class and all its ancestor classes. Does not include attributes that
88  /// may be authored by custom/extended methods of the schemas involved.
89  static const TfTokenVector &
90  GetSchemaAttributeNames(bool includeInherited=true);
91 
92  /// Return a UsdHoudiniHoudiniViewportLightAPI holding the prim adhering to this
93  /// schema at \p path on \p stage. If no prim exists at \p path on
94  /// \p stage, or if the prim at that path does not adhere to this schema,
95  /// return an invalid schema object. This is shorthand for the following:
96  ///
97  /// \code
98  /// UsdHoudiniHoudiniViewportLightAPI(stage->GetPrimAtPath(path));
99  /// \endcode
100  ///
102  Get(const UsdStagePtr &stage, const SdfPath &path);
103 
104 
105  /// Returns true if this <b>single-apply</b> API schema can be applied to
106  /// the given \p prim. If this schema can not be a applied to the prim,
107  /// this returns false and, if provided, populates \p whyNot with the
108  /// reason it can not be applied.
109  ///
110  /// Note that if CanApply returns false, that does not necessarily imply
111  /// that calling Apply will fail. Callers are expected to call CanApply
112  /// before calling Apply if they want to ensure that it is valid to
113  /// apply a schema.
114  ///
115  /// \sa UsdPrim::GetAppliedSchemas()
116  /// \sa UsdPrim::HasAPI()
117  /// \sa UsdPrim::CanApplyAPI()
118  /// \sa UsdPrim::ApplyAPI()
119  /// \sa UsdPrim::RemoveAPI()
120  ///
121  static bool
122  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
123 
124  /// Applies this <b>single-apply</b> API schema to the given \p prim.
125  /// This information is stored by adding "HoudiniViewportLightAPI" to the
126  /// token-valued, listOp metadata \em apiSchemas on the prim.
127  ///
128  /// \return A valid UsdHoudiniHoudiniViewportLightAPI object is returned upon success.
129  /// An invalid (or empty) UsdHoudiniHoudiniViewportLightAPI object is returned upon
130  /// failure. See \ref UsdPrim::ApplyAPI() for conditions
131  /// resulting in failure.
132  ///
133  /// \sa UsdPrim::GetAppliedSchemas()
134  /// \sa UsdPrim::HasAPI()
135  /// \sa UsdPrim::CanApplyAPI()
136  /// \sa UsdPrim::ApplyAPI()
137  /// \sa UsdPrim::RemoveAPI()
138  ///
140  Apply(const UsdPrim &prim);
141 
142 protected:
143  /// Returns the kind of schema this class belongs to.
144  ///
145  /// \sa UsdSchemaKind
146  UsdSchemaKind _GetSchemaKind() const override;
147 
148 private:
149  // needs to invoke _GetStaticTfType.
150  friend class UsdSchemaRegistry;
151  static const TfType &_GetStaticTfType();
152 
153  static bool _IsTypedSchema();
154 
155  // override SchemaBase virtuals.
156  const TfType &_GetTfType() const override;
157 
158 public:
159  // --------------------------------------------------------------------- //
160  // HOUDINICLIPPINGRANGE
161  // --------------------------------------------------------------------- //
162  /// Near and far clipping distances in scene units.
163  ///
164  /// | ||
165  /// | -- | -- |
166  /// | Declaration | `float2 houdini:clippingRange = (1, 1000000)` |
167  /// | C++ Type | GfVec2f |
168  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float2 |
169  UsdAttribute GetHoudiniClippingRangeAttr() const;
170 
171  /// See GetHoudiniClippingRangeAttr(), and also
172  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
173  /// If specified, author \p defaultValue as the attribute's default,
174  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
175  /// the default for \p writeSparsely is \c false.
176  UsdAttribute CreateHoudiniClippingRangeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
177 
178 public:
179  // ===================================================================== //
180  // Feel free to add custom code below this line, it will be preserved by
181  // the code generator.
182  //
183  // Just remember to:
184  // - Close the class declaration with };
185  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
186  // - Close the include guard with #endif
187  // ===================================================================== //
188  // --(BEGIN CUSTOM CODE)--
189 };
190 
192 
193 #endif
#define USDHOUDINI_API
Definition: api.h:47
Single Apply API schema.
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
UsdHoudiniHoudiniViewportLightAPI(const UsdSchemaBase &schemaObj)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
Definition: prim.h:133
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457
Definition: path.h:290
UsdSchemaKind
Definition: common.h:129
UsdHoudiniHoudiniViewportLightAPI(const UsdPrim &prim=UsdPrim())
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
Definition: value.h:164