All Classes Files Functions Variables Pages
physxTriggerAPI.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_PHYSXTRIGGERAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXTRIGGERAPI_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 // PHYSXTRIGGERAPI //
51 // -------------------------------------------------------------------------- //
52 
62 class PhysxSchemaPhysxTriggerAPI : public UsdAPISchemaBase
63 {
64 public:
68  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
69 
74  explicit PhysxSchemaPhysxTriggerAPI(const UsdPrim& prim=UsdPrim())
75  : UsdAPISchemaBase(prim)
76  {
77  }
78 
82  explicit PhysxSchemaPhysxTriggerAPI(const UsdSchemaBase& schemaObj)
83  : UsdAPISchemaBase(schemaObj)
84  {
85  }
86 
88  PHYSXSCHEMA_API
90 
94  PHYSXSCHEMA_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  PHYSXSCHEMA_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
111 
126  PHYSXSCHEMA_API
128  Apply(const UsdPrim &prim);
129 
130 protected:
134  PHYSXSCHEMA_API
135  UsdSchemaType _GetSchemaType() const override;
136 
137 private:
138  // needs to invoke _GetStaticTfType.
139  friend class UsdSchemaRegistry;
140  PHYSXSCHEMA_API
141  static const TfType &_GetStaticTfType();
142 
143  static bool _IsTypedSchema();
144 
145  // override SchemaBase virtuals.
146  PHYSXSCHEMA_API
147  const TfType &_GetTfType() const override;
148 
149 public:
150  // --------------------------------------------------------------------- //
151  // ENTERSCRIPTTYPE
152  // --------------------------------------------------------------------- //
162  PHYSXSCHEMA_API
163  UsdAttribute GetEnterScriptTypeAttr() const;
164 
170  PHYSXSCHEMA_API
171  UsdAttribute CreateEnterScriptTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
172 
173 public:
174  // --------------------------------------------------------------------- //
175  // LEAVESCRIPTTYPE
176  // --------------------------------------------------------------------- //
186  PHYSXSCHEMA_API
187  UsdAttribute GetLeaveScriptTypeAttr() const;
188 
194  PHYSXSCHEMA_API
195  UsdAttribute CreateLeaveScriptTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
196 
197 public:
198  // --------------------------------------------------------------------- //
199  // ONENTERSCRIPT
200  // --------------------------------------------------------------------- //
209  PHYSXSCHEMA_API
210  UsdAttribute GetOnEnterScriptAttr() const;
211 
217  PHYSXSCHEMA_API
218  UsdAttribute CreateOnEnterScriptAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
219 
220 public:
221  // --------------------------------------------------------------------- //
222  // ONLEAVESCRIPT
223  // --------------------------------------------------------------------- //
232  PHYSXSCHEMA_API
233  UsdAttribute GetOnLeaveScriptAttr() const;
234 
240  PHYSXSCHEMA_API
241  UsdAttribute CreateOnLeaveScriptAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
242 
243 public:
244  // ===================================================================== //
245  // Feel free to add custom code below this line, it will be preserved by
246  // the code generator.
247  //
248  // Just remember to:
249  // - Close the class declaration with };
250  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
251  // - Close the include guard with #endif
252  // ===================================================================== //
253  // --(BEGIN CUSTOM CODE)--
254 
255  PHYSXSCHEMA_API
256  static bool UnapplyAPISchema(UsdPrim &prim, bool removeAttributes = true);
257 };
258 
259 PXR_NAMESPACE_CLOSE_SCOPE
260 
261 #endif
PhysxSchemaPhysxTriggerAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxTriggerAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateLeaveScriptTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLeaveScriptTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
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...
static PHYSXSCHEMA_API PhysxSchemaPhysxTriggerAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute GetOnEnterScriptAttr() const
Enter script.
PHYSXSCHEMA_API UsdAttribute GetLeaveScriptTypeAttr() const
Leave script type.
PHYSXSCHEMA_API UsdAttribute CreateOnEnterScriptAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetOnEnterScriptAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetOnLeaveScriptAttr() const
Leave script.
PHYSXSCHEMA_API UsdAttribute CreateOnLeaveScriptAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetOnLeaveScriptAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateEnterScriptTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEnterScriptTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxTriggerAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxTriggerAPI on the prim held by schemaObj .
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
static PHYSXSCHEMA_API PhysxSchemaPhysxTriggerAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxTriggerAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdAttribute GetEnterScriptTypeAttr() const
Enter script type.
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxTriggerAPI()
Destructor.