Simbody  3.5
MobilizedBody_FreeLine.h
Go to the documentation of this file.
1 #ifndef SimTK_SIMBODY_MOBILIZED_BODY_FREELINE_H_
2 #define SimTK_SIMBODY_MOBILIZED_BODY_FREELINE_H_
3 
4 /* -------------------------------------------------------------------------- *
5  * Simbody(tm) *
6  * -------------------------------------------------------------------------- *
7  * This is part of the SimTK biosimulation toolkit originating from *
8  * Simbios, the NIH National Center for Physics-Based Simulation of *
9  * Biological Structures at Stanford, funded under the NIH Roadmap for *
10  * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody. *
11  * *
12  * Portions copyright (c) 2007-13 Stanford University and the Authors. *
13  * Authors: Michael Sherman *
14  * Contributors: Paul Mitiguy *
15  * *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may *
17  * not use this file except in compliance with the License. You may obtain a *
18  * copy of the License at http://www.apache.org/licenses/LICENSE-2.0. *
19  * *
20  * Unless required by applicable law or agreed to in writing, software *
21  * distributed under the License is distributed on an "AS IS" BASIS, *
22  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
23  * See the License for the specific language governing permissions and *
24  * limitations under the License. *
25  * -------------------------------------------------------------------------- */
26 
31 
32 namespace SimTK {
33 
59 public:
62  FreeLine() {}
63 
69  FreeLine(MobilizedBody& parent, const Transform& X_PF,
70  const Body& bodyInfo, const Transform& X_BM, Direction=Forward);
71 
74  FreeLine(MobilizedBody& parent, const Body& bodyInfo, Direction=Forward);
75 
77  (void)MobilizedBody::addBodyDecoration(X_BD,g); return *this;
78  }
80  (void)MobilizedBody::addOutboardDecoration(X_MD,g); return *this;
81  }
83  (void)MobilizedBody::addInboardDecoration(X_FD,g); return *this;
84  }
85 
87  (void)MobilizedBody::setDefaultInboardFrame(X_PF); return *this;
88  }
89 
91  (void)MobilizedBody::setDefaultOutboardFrame(X_BM); return *this;
92  }
93  // hide from Doxygen
98 };
99 
100 } // namespace SimTK
101 
102 #endif // SimTK_SIMBODY_MOBILIZED_BODY_FREELINE_H_
103 
104 
105 
MobilizedBody & setDefaultOutboardFrame(const Transform &X_BM)
Change this mobilizer's frame M fixed on this (the outboard) body B.
int addInboardDecoration(const Transform &X_FD, const DecorativeGeometry &geometry)
Add decorative geometry specified relative to the inboard mobilizer frame F attached to the parent bo...
Five mobilities, representing unrestricted motion for a body which is inertialess along its own z axi...
Definition: MobilizedBody_FreeLine.h:58
The Body class represents a reference frame that can be used to describe mass properties and geometry...
Definition: Body.h:55
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with o...
Definition: Assembler.h:37
FreeLine()
Default constructor provides an empty handle that can be assigned to reference any MobilizedBody::Bal...
Definition: MobilizedBody_FreeLine.h:62
MobilizedBody & setDefaultInboardFrame(const Transform &X_PF)
Change this mobilizer's frame F on the parent body P.
int addBodyDecoration(const Transform &X_BD, const DecorativeGeometry &geometry)
Add decorative geometry specified relative to the new (outboard) body's reference frame B...
Definition: MobilizedBody.h:1501
FreeLine & setDefaultOutboardFrame(const Transform &X_BM)
Definition: MobilizedBody_FreeLine.h:90
#define SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS(DERIVED, DERIVED_IMPL, PARENT)
Definition: PrivateImplementation.h:343
int addOutboardDecoration(const Transform &X_MD, const DecorativeGeometry &geometry)
Add decorative geometry specified relative to the outboard mobilizer frame M attached to body B...
FreeLine & setDefaultInboardFrame(const Transform &X_PF)
Definition: MobilizedBody_FreeLine.h:86
Direction
Constructors can take an argument of this type to indicate that the mobilizer is being defined in the...
Definition: MobilizedBody.h:180
FreeLine & addBodyDecoration(const Transform &X_BD, const DecorativeGeometry &g)
Definition: MobilizedBody_FreeLine.h:76
This is the client-side interface to an implementation-independent representation of "Decorations" su...
Definition: DecorativeGeometry.h:86
This defines the MobilizedBody class, which associates a new body (the "child", "outboard", or "successor" body) with a mobilizer and a reference frame on an existing body (the "parent", "inboard", or "predecessor" body) that is already part of a SimbodyMatterSubsystem.
FreeLine & addInboardDecoration(const Transform &X_FD, const DecorativeGeometry &g)
Definition: MobilizedBody_FreeLine.h:82
FreeLine & addOutboardDecoration(const Transform &X_MD, const DecorativeGeometry &g)
Definition: MobilizedBody_FreeLine.h:79
#define SimTK_SIMBODY_EXPORT
Definition: Simbody/include/simbody/internal/common.h:72
A MobilizedBody is Simbody's fundamental body-and-joint object used to parameterize a system's motion...
Definition: MobilizedBody.h:167