Loading...
Searching...
No Matches
metrics.h
Go to the documentation of this file.
1//
2// Copyright 2021 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 PXR_USD_USD_PHYSICS_METRICS_H
25#define PXR_USD_USD_PHYSICS_METRICS_H
26
27#include "pxr/pxr.h"
28#include "pxr/usd/usdPhysics/api.h"
29#include "pxr/usd/usd/common.h"
30
31PXR_NAMESPACE_OPEN_SCOPE
32
36
38USDPHYSICS_API
39double UsdPhysicsGetStageKilogramsPerUnit(const UsdStageWeakPtr &stage);
40
42USDPHYSICS_API
43bool UsdPhysicsStageHasAuthoredKilogramsPerUnit(const UsdStageWeakPtr &stage);
44
49USDPHYSICS_API
50bool UsdPhysicsSetStageKilogramsPerUnit(const UsdStageWeakPtr &stage,
51 double kilogramsPerUnit);
52
69USDPHYSICS_API
70bool UsdPhysicsMassUnitsAre(double authoredUnits, double standardUnits,
71 double epsilon = 1e-5);
72
77public:
78 static constexpr double grams = 0.001;
79 static constexpr double kilograms = 1.0;
80 static constexpr double slugs = 14.5939;
81};
82
83PXR_NAMESPACE_CLOSE_SCOPE
84
85#endif // PXR_USD_USD_PHYSICS_METRICS_H
Container class for static double-precision symbols representing common mass units of measure express...
Definition: metrics.h:76
USDPHYSICS_API bool UsdPhysicsMassUnitsAre(double authoredUnits, double standardUnits, double epsilon=1e-5)
Return true if the two given metrics are within the provided relative epsilon of each other,...
USDPHYSICS_API bool UsdPhysicsStageHasAuthoredKilogramsPerUnit(const UsdStageWeakPtr &stage)
Return whether stage has an authored kilogramsPerUnit.
USDPHYSICS_API double UsdPhysicsGetStageKilogramsPerUnit(const UsdStageWeakPtr &stage)
Return stage's authored kilogramsPerUnit, or 1.0 if unauthored.
USDPHYSICS_API bool UsdPhysicsSetStageKilogramsPerUnit(const UsdStageWeakPtr &stage, double kilogramsPerUnit)
Author stage's kilogramsPerUnit.