Ignition Physics

API Reference

2.3.0
FrameData.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 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 
18 #ifndef IGNITION_PHYSICS_FRAMEDATA_HH_
19 #define IGNITION_PHYSICS_FRAMEDATA_HH_
20 
22 
23 namespace ignition
24 {
25  namespace physics
26  {
27 
41  template <typename Scalar, std::size_t Dim>
42  struct FrameData
43  {
47 
50  public: FrameData();
51 
53  public: Pose pose;
54 
57 
60 
63 
66 
69  public: void SetToZero();
70  };
72 
73  template <typename Scalar, std::size_t Dim>
75  const FrameData<Scalar, Dim> &_frame)
76  {
77  stream
78  << "Pose:\n" << _frame.pose.matrix()
79  << "\nLinear Velocity: " << _frame.linearVelocity.transpose()
80  << "\nAngular Velocity: " << _frame.angularVelocity.transpose()
81  << "\nLinear Acceleration: " << _frame.linearAcceleration.transpose()
82  << "\nAngular Acceleration: " << _frame.angularAcceleration.transpose();
83 
84  return stream;
85  }
86  }
87 }
88 
89 #include <ignition/physics/detail/FrameData.hh>
90 
91 #endif
AngularVector angularVelocity
The current angular velocity of the frame.
Definition: FrameData.hh:59
AngularVector angularAcceleration
The current angular acceleration of the frame.
Definition: FrameData.hh:65
LinearVector linearVelocity
The current linear velocity of the frame.
Definition: FrameData.hh:56
LinearVector< Scalar, Dim > LinearVector
Definition: FrameData.hh:45
FrameData()
Constructor. This will initialize the transform with identity and all velocity and acceleration vecto...
The FrameData struct fully describes the kinematic state of a Frame with "Dim" dimensions and "Scalar...
Definition: FrameData.hh:42
Eigen::Transform< Scalar, Dim, Eigen::Isometry > Pose
This is used by ignition-physics to represent rigid body transforms in 2D or 3D simulations. The precision can be chosen as float or scalar.
Definition: Geometry.hh:44
std::size_t Dim std::ostream & operator<<(std::ostream &stream, const FrameData< Scalar, Dim > &_frame)
Definition: FrameData.hh:74
Vector< Scalar,(Dim *(Dim-1))/2 > AngularVector
Definition: Geometry.hh:56
AngularVector< Scalar, Dim > AngularVector
Definition: FrameData.hh:46
Vector< Scalar, Dim > LinearVector
Definition: Geometry.hh:52
void SetToZero()
Set the transform to identity and all velocity and acceleration vectors to zero.
Pose pose
The current SE3 transformation of the frame.
Definition: FrameData.hh:53
STL class.
LinearVector linearAcceleration
The current linear acceleration of the frame.
Definition: FrameData.hh:62
Pose< Scalar, Dim > Pose
Definition: FrameData.hh:44
IGN_PHYSICS_MAKE_ALL_TYPE_COMBOS(FrameData) template< typename Scalar