Loading...
Searching...
No Matches
Physics.hh
Go to the documentation of this file.
1/*
2 * Copyright 2018 Open Source Robotics Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16 */
17#ifndef SDF_PHYSICS_HH_
18#define SDF_PHYSICS_HH_
19
20#include <string>
21#include <gz/utils/ImplPtr.hh>
22
23#include "sdf/Element.hh"
24#include "sdf/Types.hh"
25#include "sdf/config.hh"
26#include "sdf/system_util.hh"
27
28namespace sdf
29{
30 // Inline bracket to help doxygen filtering.
31 inline namespace SDF_VERSION_NAMESPACE {
32 //
33
37 {
39 public: Physics();
40
47 public: Errors Load(ElementPtr _sdf);
48
51 public: std::string Name() const;
52
55 public: void SetName(const std::string &_name);
56
61 public: sdf::ElementPtr Element() const;
62
69 public: bool IsDefault() const;
70
73 public: void SetDefault(const bool _default);
74
79 public: std::string EngineType() const;
80
83 public: void SetEngineType(const std::string &_type);
84
89 public: double MaxStepSize() const;
90
93 public: void SetMaxStepSize(const double _step);
94
99 public: double RealTimeFactor() const;
100
103 public: void SetRealTimeFactor(const double _factor);
104
109 public: int MaxContacts() const;
110
115 public: void SetMaxContacts(int _maxContacts);
116
122 public: sdf::ElementPtr ToElement() const;
123
130 public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
131
133 GZ_UTILS_IMPL_PTR(dataPtr)
134 };
135 }
136}
137#endif
The physics element specifies the type and properties of a dynamics engine.
Definition Physics.hh:37
bool IsDefault() const
Get whether this physics profile is marked as default.
void SetMaxStepSize(const double _step)
Set the max step size in seconds.
sdf::ElementPtr ToElement(sdf::Errors &_errors) const
Create and return an SDF element filled with data from this physics.
void SetMaxContacts(int _maxContacts)
Set the maximum number of contacts allowed between two entities.
double MaxStepSize() const
Get the max step size in seconds.
std::string EngineType() const
Get the physics profile dynamics engine type.
void SetDefault(const bool _default)
Set whether this physics profile is the default.
void SetEngineType(const std::string &_type)
Set the physics profile dynamics engine type.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
Errors Load(ElementPtr _sdf)
Load the physics based on an element pointer.
int MaxContacts() const
Get the maximum number of contacts allowed between two entities.
void SetRealTimeFactor(const double _factor)
Set the target realtime factor.
double RealTimeFactor() const
Get the target real time factor.
void SetName(const std::string &_name)
Set the name of this set of physics parameters.
std::string Name() const
Get the name of this set of physics parameters.
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this physics.
std::vector< Error > Errors
A vector of Error.
Definition Types.hh:81
std::shared_ptr< Element > ElementPtr
Definition Element.hh:55
namespace for Simulation Description Format parser
Definition Actor.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition system_util.hh:25