Loading...
Searching...
No Matches
articulationRootAPI.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDPHYSICS_GENERATED_ARTICULATIONROOTAPI_H
8#define USDPHYSICS_GENERATED_ARTICULATIONROOTAPI_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdPhysics/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
17
18#include "pxr/base/vt/value.h"
19
20#include "pxr/base/gf/vec3d.h"
21#include "pxr/base/gf/vec3f.h"
23
24#include "pxr/base/tf/token.h"
25#include "pxr/base/tf/type.h"
26
27PXR_NAMESPACE_OPEN_SCOPE
28
29class SdfAssetPath;
30
31// -------------------------------------------------------------------------- //
32// PHYSICSARTICULATIONROOTAPI //
33// -------------------------------------------------------------------------- //
34
46{
47public:
51 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
52
58 : UsdAPISchemaBase(prim)
59 {
60 }
61
66 : UsdAPISchemaBase(schemaObj)
67 {
68 }
69
71 USDPHYSICS_API
73
77 USDPHYSICS_API
78 static const TfTokenVector &
79 GetSchemaAttributeNames(bool includeInherited=true);
80
90 USDPHYSICS_API
92 Get(const UsdStagePtr &stage, const SdfPath &path);
93
94
111 USDPHYSICS_API
112 static bool
113 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
114
130 USDPHYSICS_API
132 Apply(const UsdPrim &prim);
133
134protected:
138 USDPHYSICS_API
140
141private:
142 // needs to invoke _GetStaticTfType.
143 friend class UsdSchemaRegistry;
144 USDPHYSICS_API
145 static const TfType &_GetStaticTfType();
146
147 static bool _IsTypedSchema();
148
149 // override SchemaBase virtuals.
150 USDPHYSICS_API
151 const TfType &_GetTfType() const override;
152
153public:
154 // ===================================================================== //
155 // Feel free to add custom code below this line, it will be preserved by
156 // the code generator.
157 //
158 // Just remember to:
159 // - Close the class declaration with };
160 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
161 // - Close the include guard with #endif
162 // ===================================================================== //
163 // --(BEGIN CUSTOM CODE)--
164};
165
166PXR_NAMESPACE_CLOSE_SCOPE
167
168#endif
Contains an asset path and optional evaluated and resolved paths.
Definition: assetPath.h:78
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
TfType represents a dynamic runtime type.
Definition: type.h:48
The base class for all API schemas.
Definition: apiSchemaBase.h:99
PhysicsArticulationRootAPI can be applied to a scene graph node, and marks the subtree rooted here fo...
static USDPHYSICS_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.
static USDPHYSICS_API UsdPhysicsArticulationRootAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
UsdPhysicsArticulationRootAPI(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsArticulationRootAPI on the prim held by schemaObj .
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
static USDPHYSICS_API UsdPhysicsArticulationRootAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsArticulationRootAPI holding the prim adhering to this schema at path on stage.
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...
UsdPhysicsArticulationRootAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsArticulationRootAPI on UsdPrim prim .
virtual USDPHYSICS_API ~UsdPhysicsArticulationRootAPI()
Destructor.
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
The base class for all schema types in Usd.
Definition: schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440