All Classes Files Functions Variables Pages
physxCameraAPI.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 PHYSXSCHEMA_GENERATED_PHYSXCAMERAAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXCAMERAAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include "pxr/usd/usd/apiSchemaBase.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 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PHYSXCAMERAAPI //
51 // -------------------------------------------------------------------------- //
52 
57 class PhysxSchemaPhysxCameraAPI : public UsdAPISchemaBase
58 {
59 public:
63  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxCameraAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit PhysxSchemaPhysxCameraAPI(const UsdSchemaBase& schemaObj)
78  : UsdAPISchemaBase(schemaObj)
79  {
80  }
81 
83  PHYSXSCHEMA_API
85 
89  PHYSXSCHEMA_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  PHYSXSCHEMA_API
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
106 
123  PHYSXSCHEMA_API
124  static bool
125  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
126 
142  PHYSXSCHEMA_API
144  Apply(const UsdPrim &prim);
145 
146 protected:
150  PHYSXSCHEMA_API
151  UsdSchemaKind _GetSchemaKind() const override;
152 
153 private:
154  // needs to invoke _GetStaticTfType.
155  friend class UsdSchemaRegistry;
156  PHYSXSCHEMA_API
157  static const TfType &_GetStaticTfType();
158 
159  static bool _IsTypedSchema();
160 
161  // override SchemaBase virtuals.
162  PHYSXSCHEMA_API
163  const TfType &_GetTfType() const override;
164 
165 public:
166  // --------------------------------------------------------------------- //
167  // ALWAYSUPDATEENABLED
168  // --------------------------------------------------------------------- //
177  PHYSXSCHEMA_API
178  UsdAttribute GetAlwaysUpdateEnabledAttr() const;
179 
185  PHYSXSCHEMA_API
186  UsdAttribute CreateAlwaysUpdateEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
187 
188 public:
189  // --------------------------------------------------------------------- //
190  // PHYSXCAMERASUBJECT
191  // --------------------------------------------------------------------- //
194  PHYSXSCHEMA_API
195  UsdRelationship GetPhysxCameraSubjectRel() const;
196 
199  PHYSXSCHEMA_API
200  UsdRelationship CreatePhysxCameraSubjectRel() const;
201 
202 public:
203  // ===================================================================== //
204  // Feel free to add custom code below this line, it will be preserved by
205  // the code generator.
206  //
207  // Just remember to:
208  // - Close the class declaration with };
209  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
210  // - Close the include guard with #endif
211  // ===================================================================== //
212  // --(BEGIN CUSTOM CODE)--
213 };
214 
215 PXR_NAMESPACE_CLOSE_SCOPE
216 
217 #endif
static PHYSXSCHEMA_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
PHYSXSCHEMA_API UsdRelationship CreatePhysxCameraSubjectRel() const
See GetPhysxCameraSubjectRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCameraAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateAlwaysUpdateEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAlwaysUpdateEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdRelationship GetPhysxCameraSubjectRel() const
Reference to the subject this camera is to track.
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PhysxSchemaPhysxCameraAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxCameraAPI on UsdPrim prim .
static PHYSXSCHEMA_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...
PHYSXSCHEMA_API UsdAttribute GetAlwaysUpdateEnabledAttr() const
When enabled, always update this camera whether it is the active camera or not.
PhysxSchemaPhysxCameraAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxCameraAPI on the prim held by schemaObj .
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxCameraAPI holding the prim adhering to this schema at path on stage...