PlanarWorldIn3D
Planar world coordinate system + gravity field + default animation definition
Library
PlanarMechanics
Description
Model PlanarWorld defines all possible general parameters to make parameterization of models much more convenient. It has the following functionalites.
- It defines the global coordinate system fixed in ground and shows the x, y, z axes in animation if wanted.
- It contains all default parameters for animation, e.g. axis diameter, default joint length etc, which can still be overwritten by setting parameters in these models.
- It provides the default gravity definition and its animation.
The planar world can optionally be coupled to a 3D-Multibody connector. This will affect visualization mainly. Beware! The physics of the planar world presume the inertial system to be non-accelerated. When connecting to an accelerated MultiBody connector the physical forces going along with this acceleration are thus neglected.
For physical coupling between 2D and 3D system use Interfaces.PlanarToMultiBody
The gravity vector can be inherited from the MultiBody world component. In this case, the vector is determined once for the origin of the planar world system and then applied to all body components (if enabled there, as default).
Parameters
| Name | Label | Description | Data Type | Valid Values |
|---|---|---|---|---|
mo_inheritGravityFromMultiBody | inheritGravityFromMultiBody | =true if gravity vector shall be inherited from 3D world model | Scalar | true |
mo_constantGravity | constantGravity | Constant gravity acceleration vector resolved in world frame | Vector of size 2 | |
mo_connectToMultiBody | connectToMultiBody | = true when visualization of the planar world shall be connected to a 3D multibody system | Number | 0 |
mo_enableAnimation | enableAnimation | = true, if animation of all components is enabled | Scalar | true |
mo_animateWorld | animateWorld | = true, if world coordinate system shall be visualized | Scalar | true |
mo_animateGravity | animateGravity | = true, if gravity field shall be visualized (acceleration vector or field center) | Scalar | true |
mo_label1 | label1 | Label of horizontal axis in icon | String | |
mo_label2 | label2 | Label of vertical axis in icon | String | |
mo_ndim | ndim | Scalar | ||
mo_ndim2 | ndim2 | Scalar | ||
mo_scaledLabel | scaledLabel | Scalar | ||
mo_labelStart | labelStart | Scalar |
| Name | Label | Description | Data Type | Valid Values |
|---|---|---|---|---|
mo_axisLength | axisLength | Length of world axes arrows | Scalar | |
mo_axisDiameter | axisDiameter | Diameter of world axes arrows | Scalar | |
mo_axisShowLabels | axisShowLabels | = true, if labels shall be shown | Scalar | true |
mo_axisColor_x | axisColor_x | Color of x-arrow | Vector of size 3 | |
mo_axisColor_y | axisColor_y | Color of y-arrow | Vector of size 3 | |
mo_axisColor_z | axisColor_z | Color of z-arrow | Vector of size 3 | |
mo_gravityArrowTail | gravityArrowTail | Position vector from origin of world frame to arrow tail, resolved in world frame | Vector of size 2 | |
mo_gravityArrowLength | gravityArrowLength | Length of gravity arrow | Scalar | |
mo_gravityArrowDiameter | gravityArrowDiameter | Diameter of gravity arrow | Scalar | |
mo_gravityArrowColor | gravityArrowColor | Color of gravity arrow | Vector of size 3 |
| Name | Label | Description | Data Type | Valid Values |
|---|---|---|---|---|
mo_defaultZPosition | defaultZPosition | Default for z positions of all the elements | Scalar | |
mo_nominalLength | nominalLength | "Nominal" length of PlanarMechanics | Scalar | |
mo_defaultJointLength | defaultJointLength | Default for the fixed length of a shape representing a joint | Scalar | |
mo_defaultJointWidth | defaultJointWidth | Default for the fixed width of a shape representing a joint | Scalar | |
mo_defaultBodyDiameter | defaultBodyDiameter | Default for diameter of sphere representing the center of mass of a body | Scalar | |
mo_defaultWidthFraction | defaultWidthFraction | Default for shape width as a fraction of shape length (e.g., for Parts.FixedTranslation) | Scalar | |
mo_defaultArrowDiameter | defaultArrowDiameter | Default for arrow diameter (e.g., of forces, torques, sensors) | Scalar | |
mo_defaultForceLength | defaultForceLength | Default for the fixed length of a shape representing a force (e.g., damper) | Scalar | |
mo_defaultForceWidth | defaultForceWidth | Default for the fixed width of a shape represening a force (e.g., spring, bushing) | Scalar | |
mo_defaultFrameDiameterFraction | defaultFrameDiameterFraction | Default for arrow diameter of a coordinate system as a fraction of axis length | Scalar | |
mo_defaultSpecularCoefficient | defaultSpecularCoefficient | Default reflection of ambient light (= 0: light is completely absorbed) | Scalar | |
mo_defaultN_to_m | defaultN_to_m | Default scaling of force arrows (length = force/defaultN_to_m) | Scalar | |
mo_defaultNm_to_m | defaultNm_to_m | Default scaling of torque arrows (length = torque/defaultNm_to_m) | Scalar |
| Name | Label | Description | Data Type | Valid Values |
|---|---|---|---|---|
mo__nmodifiers | Number of Modifiers | Specifies the number of modifiers | Number | |
mo__modifiers | Modifiers | Add new modifier | Structure | |
mo__modifiers/varname | Variable name | Cell of strings | 'r_0' | |
mo__modifiers/attribute | Attribute | Cell of strings | 'start' | |
mo__modifiers/value | Value |
Ports
| Name | Type | Description | IO Type | Number |
|---|---|---|---|---|
Port 1 | implicit | input | mo_connectToMultiBody |