scene.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 USDPHYSICS_GENERATED_SCENE_H
25 #define USDPHYSICS_GENERATED_SCENE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdPhysics/api.h"
31 #include "pxr/usd/usd/typed.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.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 // PHYSICSSCENE //
51 // -------------------------------------------------------------------------- //
52 
57 class UsdPhysicsScene : public UsdTyped
58 {
59 public:
64 
69  explicit UsdPhysicsScene(const UsdPrim& prim=UsdPrim())
70  : UsdTyped(prim)
71  {
72  }
73 
77  explicit UsdPhysicsScene(const UsdSchemaBase& schemaObj)
78  : UsdTyped(schemaObj)
79  {
80  }
81 
83  USDPHYSICS_API
84  virtual ~UsdPhysicsScene();
85 
89  USDPHYSICS_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  USDPHYSICS_API
103  static UsdPhysicsScene
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
128  USDPHYSICS_API
129  static UsdPhysicsScene
130  Define(const UsdStagePtr &stage, const SdfPath &path);
131 
132 protected:
136  USDPHYSICS_API
137  UsdSchemaKind _GetSchemaKind() const override;
138 
139 private:
140  // needs to invoke _GetStaticTfType.
141  friend class UsdSchemaRegistry;
142  USDPHYSICS_API
143  static const TfType &_GetStaticTfType();
144 
145  static bool _IsTypedSchema();
146 
147  // override SchemaBase virtuals.
148  USDPHYSICS_API
149  const TfType &_GetTfType() const override;
150 
151 public:
152  // --------------------------------------------------------------------- //
153  // GRAVITYDIRECTION
154  // --------------------------------------------------------------------- //
164  USDPHYSICS_API
166 
172  USDPHYSICS_API
173  UsdAttribute CreateGravityDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
174 
175 public:
176  // --------------------------------------------------------------------- //
177  // GRAVITYMAGNITUDE
178  // --------------------------------------------------------------------- //
189  USDPHYSICS_API
191 
197  USDPHYSICS_API
198  UsdAttribute CreateGravityMagnitudeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199 
200 public:
201  // ===================================================================== //
202  // Feel free to add custom code below this line, it will be preserved by
203  // the code generator.
204  //
205  // Just remember to:
206  // - Close the class declaration with };
207  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
208  // - Close the include guard with #endif
209  // ===================================================================== //
210  // --(BEGIN CUSTOM CODE)--
211 };
212 
213 PXR_NAMESPACE_CLOSE_SCOPE
214 
215 #endif
USDPHYSICS_API UsdAttribute GetGravityMagnitudeAttr() const
Gravity acceleration magnitude in simulation world space.
USDPHYSICS_API UsdAttribute CreateGravityMagnitudeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGravityMagnitudeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDPHYSICS_API UsdAttribute GetGravityDirectionAttr() const
Gravity direction vector in simulation world space.
virtual USDPHYSICS_API ~UsdPhysicsScene()
Destructor.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: scene.h:63
static USDPHYSICS_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...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDPHYSICS_API UsdAttribute CreateGravityDirectionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGravityDirectionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDPHYSICS_API UsdPhysicsScene Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsScene holding the prim adhering to this schema at path on stage.
General physics simulation properties, required for simulation.
Definition: scene.h:57
static USDPHYSICS_API UsdPhysicsScene Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
Represents a concrete typed schema.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all typed schemas (those that can impart a typeName to a UsdPrim),...
Definition: typed.h:47
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
UsdPhysicsScene(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsScene on UsdPrim prim .
Definition: scene.h:69
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
UsdPhysicsScene(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsScene on the prim held by schemaObj .
Definition: scene.h:77
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...