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 USDLUX_GENERATED_DISTANTLIGHT_H 25 #define USDLUX_GENERATED_DISTANTLIGHT_H 26 27 /// \file usdLux/distantLight.h 28 29 #include "pxr/pxr.h" 30 #include "pxr/usd/usdLux/api.h" 31 #include "pxr/usd/usdLux/nonboundableLightBase.h" 32 #include "pxr/usd/usd/prim.h" 33 #include "pxr/usd/usd/stage.h" 34 #include "pxr/usd/usdLux/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 // DISTANTLIGHT // 51 // -------------------------------------------------------------------------- // 52 53 /// \class UsdLuxDistantLight 54 /// 55 /// Light emitted from a distant source along the -Z axis. 56 /// Also known as a directional light. 57 /// 58 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below 59 /// that are text/tokens, the actual token is published and defined in \ref UsdLuxTokens. 60 /// So to set an attribute to the value "rightHanded", use UsdLuxTokens->rightHanded 61 /// as the value. 62 /// 63 class UsdLuxDistantLight : public UsdLuxNonboundableLightBase 64 { 65 public: 66 /// Compile time constant representing what kind of schema this class is. 67 /// 68 /// \sa UsdSchemaKind 69 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped; 70 71 /// Construct a UsdLuxDistantLight on UsdPrim \p prim . 72 /// Equivalent to UsdLuxDistantLight::Get(prim.GetStage(), prim.GetPath()) 73 /// for a \em valid \p prim, but will not immediately throw an error for 74 /// an invalid \p prim 75 explicit UsdLuxDistantLight(const UsdPrim& prim=UsdPrim()) UsdLuxNonboundableLightBase(prim)76 : UsdLuxNonboundableLightBase(prim) 77 { 78 } 79 80 /// Construct a UsdLuxDistantLight on the prim held by \p schemaObj . 81 /// Should be preferred over UsdLuxDistantLight(schemaObj.GetPrim()), 82 /// as it preserves SchemaBase state. UsdLuxDistantLight(const UsdSchemaBase & schemaObj)83 explicit UsdLuxDistantLight(const UsdSchemaBase& schemaObj) 84 : UsdLuxNonboundableLightBase(schemaObj) 85 { 86 } 87 88 /// Destructor. 89 USDLUX_API 90 virtual ~UsdLuxDistantLight(); 91 92 /// Return a vector of names of all pre-declared attributes for this schema 93 /// class and all its ancestor classes. Does not include attributes that 94 /// may be authored by custom/extended methods of the schemas involved. 95 USDLUX_API 96 static const TfTokenVector & 97 GetSchemaAttributeNames(bool includeInherited=true); 98 99 /// Return a UsdLuxDistantLight holding the prim adhering to this 100 /// schema at \p path on \p stage. If no prim exists at \p path on 101 /// \p stage, or if the prim at that path does not adhere to this schema, 102 /// return an invalid schema object. This is shorthand for the following: 103 /// 104 /// \code 105 /// UsdLuxDistantLight(stage->GetPrimAtPath(path)); 106 /// \endcode 107 /// 108 USDLUX_API 109 static UsdLuxDistantLight 110 Get(const UsdStagePtr &stage, const SdfPath &path); 111 112 /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path 113 /// is defined (according to UsdPrim::IsDefined()) on this stage. 114 /// 115 /// If a prim adhering to this schema at \p path is already defined on this 116 /// stage, return that prim. Otherwise author an \a SdfPrimSpec with 117 /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for 118 /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s 119 /// with \p specifier == \a SdfSpecifierDef and empty typeName at the 120 /// current EditTarget for any nonexistent, or existing but not \a Defined 121 /// ancestors. 122 /// 123 /// The given \a path must be an absolute prim path that does not contain 124 /// any variant selections. 125 /// 126 /// If it is impossible to author any of the necessary PrimSpecs, (for 127 /// example, in case \a path cannot map to the current UsdEditTarget's 128 /// namespace) issue an error and return an invalid \a UsdPrim. 129 /// 130 /// Note that this method may return a defined prim whose typeName does not 131 /// specify this schema class, in case a stronger typeName opinion overrides 132 /// the opinion at the current EditTarget. 133 /// 134 USDLUX_API 135 static UsdLuxDistantLight 136 Define(const UsdStagePtr &stage, const SdfPath &path); 137 138 protected: 139 /// Returns the kind of schema this class belongs to. 140 /// 141 /// \sa UsdSchemaKind 142 USDLUX_API 143 UsdSchemaKind _GetSchemaKind() const override; 144 145 private: 146 // needs to invoke _GetStaticTfType. 147 friend class UsdSchemaRegistry; 148 USDLUX_API 149 static const TfType &_GetStaticTfType(); 150 151 static bool _IsTypedSchema(); 152 153 // override SchemaBase virtuals. 154 USDLUX_API 155 const TfType &_GetTfType() const override; 156 157 public: 158 // --------------------------------------------------------------------- // 159 // ANGLE 160 // --------------------------------------------------------------------- // 161 /// Angular size of the light in degrees. 162 /// As an example, the Sun is approximately 0.53 degrees as seen from Earth. 163 /// Higher values broaden the light and therefore soften shadow edges. 164 /// 165 /// 166 /// | || 167 /// | -- | -- | 168 /// | Declaration | `float inputs:angle = 0.53` | 169 /// | C++ Type | float | 170 /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float | 171 USDLUX_API 172 UsdAttribute GetAngleAttr() const; 173 174 /// See GetAngleAttr(), and also 175 /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create. 176 /// If specified, author \p defaultValue as the attribute's default, 177 /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true - 178 /// the default for \p writeSparsely is \c false. 179 USDLUX_API 180 UsdAttribute CreateAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const; 181 182 public: 183 // --------------------------------------------------------------------- // 184 // INTENSITY 185 // --------------------------------------------------------------------- // 186 /// Scales the emission of the light linearly. 187 /// The DistantLight has a high default intensity to approximate the Sun. 188 /// 189 /// | || 190 /// | -- | -- | 191 /// | Declaration | `float inputs:intensity = 50000` | 192 /// | C++ Type | float | 193 /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float | 194 USDLUX_API 195 UsdAttribute GetIntensityAttr() const; 196 197 /// See GetIntensityAttr(), and also 198 /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create. 199 /// If specified, author \p defaultValue as the attribute's default, 200 /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true - 201 /// the default for \p writeSparsely is \c false. 202 USDLUX_API 203 UsdAttribute CreateIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const; 204 205 public: 206 // ===================================================================== // 207 // Feel free to add custom code below this line, it will be preserved by 208 // the code generator. 209 // 210 // Just remember to: 211 // - Close the class declaration with }; 212 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE 213 // - Close the include guard with #endif 214 // ===================================================================== // 215 // --(BEGIN CUSTOM CODE)-- 216 }; 217 218 PXR_NAMESPACE_CLOSE_SCOPE 219 220 #endif 221