All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
distanceJoint.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_DISTANCEJOINT_H
8#define USDPHYSICS_GENERATED_DISTANCEJOINT_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"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// PHYSICSDISTANCEJOINT //
34// -------------------------------------------------------------------------- //
35
42{
43public:
47 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
48
53 explicit UsdPhysicsDistanceJoint(const UsdPrim& prim=UsdPrim())
54 : UsdPhysicsJoint(prim)
55 {
56 }
57
61 explicit UsdPhysicsDistanceJoint(const UsdSchemaBase& schemaObj)
62 : UsdPhysicsJoint(schemaObj)
63 {
64 }
65
67 USDPHYSICS_API
69
73 USDPHYSICS_API
74 static const TfTokenVector &
75 GetSchemaAttributeNames(bool includeInherited=true);
76
86 USDPHYSICS_API
88 Get(const UsdStagePtr &stage, const SdfPath &path);
89
112 USDPHYSICS_API
114 Define(const UsdStagePtr &stage, const SdfPath &path);
115
116protected:
120 USDPHYSICS_API
122
123private:
124 // needs to invoke _GetStaticTfType.
125 friend class UsdSchemaRegistry;
126 USDPHYSICS_API
127 static const TfType &_GetStaticTfType();
128
129 static bool _IsTypedSchema();
130
131 // override SchemaBase virtuals.
132 USDPHYSICS_API
133 const TfType &_GetTfType() const override;
134
135public:
136 // --------------------------------------------------------------------- //
137 // MINDISTANCE
138 // --------------------------------------------------------------------- //
147 USDPHYSICS_API
149
155 USDPHYSICS_API
156 UsdAttribute CreateMinDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
157
158public:
159 // --------------------------------------------------------------------- //
160 // MAXDISTANCE
161 // --------------------------------------------------------------------- //
170 USDPHYSICS_API
172
178 USDPHYSICS_API
179 UsdAttribute CreateMaxDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
180
181public:
182 // ===================================================================== //
183 // Feel free to add custom code below this line, it will be preserved by
184 // the code generator.
185 //
186 // Just remember to:
187 // - Close the class declaration with };
188 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
189 // - Close the include guard with #endif
190 // ===================================================================== //
191 // --(BEGIN CUSTOM CODE)--
192};
193
194PXR_NAMESPACE_CLOSE_SCOPE
195
196#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
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
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:160
Predefined distance joint type (Distance between rigid bodies may be limited to given minimum or maxi...
Definition: distanceJoint.h:42
virtual USDPHYSICS_API ~UsdPhysicsDistanceJoint()
Destructor.
USDPHYSICS_API UsdAttribute GetMinDistanceAttr() const
Minimum distance.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: distanceJoint.h:47
USDPHYSICS_API UsdAttribute CreateMaxDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDPHYSICS_API UsdAttribute CreateMinDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMinDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdPhysicsDistanceJoint(const UsdSchemaBase &schemaObj)
Construct a UsdPhysicsDistanceJoint on the prim held by schemaObj .
Definition: distanceJoint.h:61
static USDPHYSICS_API UsdPhysicsDistanceJoint Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsDistanceJoint holding the prim adhering to this schema at path on stage.
static USDPHYSICS_API UsdPhysicsDistanceJoint Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
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...
USDPHYSICS_API UsdAttribute GetMaxDistanceAttr() const
Maximum distance.
UsdPhysicsDistanceJoint(const UsdPrim &prim=UsdPrim())
Construct a UsdPhysicsDistanceJoint on UsdPrim prim .
Definition: distanceJoint.h:53
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
A joint constrains the movement of rigid bodies.
Definition: joint.h:46
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...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:147
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