Ellipsoidal Solid
Solid ellipsoidal element with geometry, inertia, and color
Description
The Ellipsoidal Solid block is a three-dimensional extension of the
ellipse with geometry center coincident with the reference frame origin and
semi-principal axes coincident with the reference frame x, y, and z axes.
The Ellipsoidal Solid block adds to the attached frame a solid element
with geometry, inertia, and color. The solid element can be a simple rigid body or part
of a compound rigid body—a group of rigidly connected solids, often separated in
space through rigid transformations. Combine Ellipsoidal Solid and
other solid blocks with the Rigid Transform
blocks to model a compound rigid body.
Geometry parameters include shape and size. You can choose from a list of preset
shapes or import a custom shape from an external file in STL or STEP format. By default,
for all but STL-derived shapes, the block automatically computes the mass properties of
the solid from the specified geometry and either mass or mass density. You can change
this setting in the > block parameter.
A reference frame encodes the position and orientation of the solid. In the default
configuration, the block provides only the reference frame. A frame-creation interface
provides the means to define additional frames based on solid geometry features. You
access this interface by selecting the Create button
in the Frames expandable area.
Derived Properties
You can view the calculated values of the solid mass properties directly in the
block dialog box. Setting the > parameter to Calculate from Geometry
causes
the block to expose a new node, Derived Values. Click the
Update button provided under this node to calculate the
mass properties and display their values in the fields below the button.
Visualization Pane
The block dialog box contains a collapsible visualization pane. This pane provides
instant visual feedback on the solid you are modeling. Use it to find and fix any
issues with the shape and color of the solid. You can examine the solid from
different perspectives by selecting a standard view or by rotating, panning, and
zooming the solid.
Select the Update Visualization button
to view the latest changes to the solid geometry
in the visualization pane. Select Apply or
OK to commit your changes to the solid. Closing the block
dialog box without first selecting Apply or
OK causes the block to discard those changes.
Right-click the visualization pane to access the visualization context-sensitive
menu. This menu provides additional options so that you can change the background
color, split the visualization pane into multiple tiles, and modify the view
convention from the default +Z up (XY Top) setting.
Ports
Frame
expand all
R
— Reference frame
frame
Local reference frame of the solid. This frame is fixed with respect
to the solid geometry. Connect this port to a frame entity—port, line,
or junction—to resolve the placement of the reference frame in a model.
For more information, see Working with Frames.
Parameters
expand all
Geometry
Radii
— Ellipsoid radii along the x, y,
and z semiprincipal axes
[1,1,1] m
(default) | scalar with units of length
Ellipsoid radii along the x, y,
and z axes of the solid reference frame. The
ellipsoid becomes a sphere if all radii are equal.
Entire Geometry
— Export the true geometry of the block
off
(default) | on
Select to export the true
geometry of the Ellipsoidal Solid block
which can be used for other blocks, such as the Spatial
Contact Force block.
Dependencies
To enable this option, select under the
.
Inertia
Type
— Inertia parameterization to use
Calculate from
Geometry
(default) | Point Mass
| Custom
Inertia parameterization to use. Select Point
Mass
to model a concentrated mass with negligible
rotational inertia. Select Custom
to model a
distributed mass with the specified moments and products of inertia. The
default setting, Calculate from Geometry
,
enables the block to automatically calculate the rotational inertia
properties from the solid geometry and specified mass or mass
density.
Based on
— Parameter to base inertia calculation on
Density
(default) | Mass
Parameter to use in inertia calculation. The block obtains the inertia
tensor from the solid geometry and the parameter selected. Use
Density
if the material properties are
known. Use Mass
if the total solid mass if
known.
Density
— Mass per unit volume of material
1000 kg/m^3
(default)
Mass per unit volume of material. The mass density can take on a
positive or negative value. Specify a negative mass density to model the
effects of a void or cavity in a solid body.
Mass
— Total mass of the solid element
1 kg
(default) | scalar with units of mass
Total mass to attribute to the solid element. This parameter can be positive or
negative. Use a negative value to capture the effect of a void or cavity in a compound
body (one comprising multiple solids and inertias), being careful to ensure that the
mass of the body is on the whole positive.
Custom: Center of Mass
— Center-of-mass coordinates
[0 0 0] m
(default) | three-element vector with units of length
[x y z] coordinates of the center of mass relative to the block
reference frame. The center of mass coincides with the center of gravity
in uniform gravitational fields only.
Custom: Moments of Inertia
— Diagonal elements of inertia tensor
[1 1 1] kg*m^2
(default) | three-element vector with units of mass*length^2
Three-element vector with the [Ixx Iyy
Izz] moments of inertia specified relative to a frame with
origin at the center of mass and axes parallel to the block reference frame. The moments
of inertia are the diagonal elements of the inertia tensor
where:
Custom: Products of Inertia
— Off-diagonal elements of inertia tensor
[0 0 0] kg*m^2
(default) | three-element vector with units of mass*length^2
Three-element vector with the [Iyz Izx Ixy]
products of inertia specified relative to a frame with origin at the
center of mass and axes parallel to the block reference frame. The
products of inertia are the off-diagonal elements of the inertia tensor
where:
Calculate from Geometry: Derived Values
— Display of calculated values of mass properties
button
Display of the calculated values of the solid mass properties—mass,
center of mass, moments of inertia, and products of inertia. Click the
Update button to calculate and display the mass
properties of the solid. Click this button following any changes to the
block parameters to ensure that the displayed values are still
current.
The center of mass is resolved in the local reference frame of the
solid. The moments and products of inertia are each resolved in the
inertia frame of resolution—a frame whose axes are parallel to those of
the reference frame but whose origin coincides with the solid center of
mass.
Dependencies
The option to calculate and display the mass properties is active
when the > block parameter is set to Calculate from
Geometry
.
Graphic
Type
— Graphic to use in the visualization of the solid
From Geometry
(default) | Marker
| None
Choice of graphic to use in the visualization of the solid. The
graphic is by default the geometry specified for the solid. Select
Marker
to show instead a simple graphic
marker, such as a sphere or cube. Change this parameter to
None
to eliminate this solid altogether
from the model visualization.
Marker: Shape
— Shape of the marker to assign to the solid
Sphere
(default) | Cube
| Frame
Shape of the marker by means of which to visualize the solid. The
motion of the marker reflects the motion of the solid itself.
Marker: Size
— Width of the marker in pixels
10
(default) | scalar with units of pixels
Width of the marker in pixels. This width does not scale with zoom
level. Note that the apparent size of the marker depends partly on
screen resolution, with higher resolutions packing more pixels per unit
length, and therefore producing smaller icons.
Visual Properties
— Parameterizations for color and opacity
Simple
(default) | Advanced
Parameterization for specifying visual properties. Select Simple
to
specify color and opacity. Select Advanced
to
add specular highlights, ambient shadows, and self-illumination effects.
Dependencies
To enable this parameter, set Type to From
Geometry
or Marker
.
Color
— True color as [R,G,B] vector on 0–1 scale
[0.5 0.5 0.5]
(default) | three-element vector with values constrained to 0–1
RGB color vector with red (R), green (G), and blue (B) color amounts specified on a
0–1 scale. A color picker provides an alternative interactive means of specifying a
color. If you change the Visual Properties setting to
Advanced
, the color specified in this parameter becomes
the Diffuse Color vector.
Dependencies
To enable this parameter, set :
Type to Marker
.
Visual Properties to
Simple
.
Opacity
— Surface opacity as scalar number on 0–1 scale
1.0
(default) | scalar with value constrained to 0–1
Graphic opacity specified on a scale of 0–1. An opacity of 0
corresponds to a completely transparent graphic and an opacity of 1
to a completely opaque graphic.
Dependencies
To enable this parameter, set :
Type to Marker
.
Visual Properties to
Simple
.
Diffuse Color
— True color as [R,G,B,A] vector on 0–1 scale
[0.5 0.5 0.5]
(default) | three- or four-element vector with values constrained to 0–1
True color under direct white light specified as an [R,G,B] or [R,G,B,A] vector on a
0–1 scale. An optional fourth element specifies the color opacity also on a scale of
0–1. Omitting the opacity element is equivalent to specifying a value of
1
.
Dependencies
To enable this parameter, set :
Type to Marker
.
Visual Properties to
Advanced
.
Specular Color
— Highlight color as [R,G,B,A] vector on 0–1 scale
[0.5 0.5 0.5 1.0]
(default) | three- or four-element vector with values constrained to 0–1
Color of specular highlights specified as an [R,G,B] or [R,G,B,A] vector on a 0–1
scale. The optional fourth element specifies the color opacity. Omitting the opacity
element is equivalent to specifying a value of 1
.
Dependencies
To enable this parameter, set :
Type to Marker
.
Visual Properties to
Advanced
.
Ambient Color
— Shadow color as [R,G,B,A] vector on 0–1 scale
[0.15 0.15 0.15 1.0]
(default) | three- or four-element vector with values constrained to 0–1
Color of shadow areas in diffuse ambient light, specified as an [R,G,B] or [R,G,B,A]
vector on a 0–1 scale. The optional fourth element specifies the color opacity. Omitting
the opacity element is equivalent to specifying a value of 1
.
Dependencies
To enable this parameter, set :
Type to Marker
.
Visual Properties to
Advanced
.
Emissive Color
— Self-illumination color as [R,G,B,A] vector on 0–1 scale
[0.0 0.0 0.0 1.0]
(default) | three- or four-element vector with values constrained to 0–1
Surface color due to self illumination, specified as an [R,G,B] or [R,G,B,A] vector on
a 0–1 scale. The optional fourth element specifies the color opacity. Omitting the
opacity element is equivalent to specifying a value of 1
.
Dependencies
To enable this parameter, set :
Type to Marker
.
Visual Properties to
Advanced
.
Shininess
— Highlight sharpness as scalar number on 0–128 scale
75
(default) | scalar with value constrained to 0–128
Sharpness of specular light reflections, specified as a scalar number on a 0–128
scale. Increase the shininess value for smaller but sharper highlights. Decrease the
value for larger but smoother highlights.
Dependencies
To enable this parameter, set :
Type to Marker
.
Visual Properties to
Advanced
.
Frames
Show Port R
— Show reference frame port for connection to other blocks
on (default) | off
Select to expose the R port.
New Frame
— Create custom frame for connection to other blocks
button
Click the Create button
to open a pane for creating a new
body-attached frame. In this pane, you can specify the name, origin, and
orientation for the frame.
To name the custom frame, click the text field of the
Frame Name parameter. The name identifies
the corresponding port on the solid block and in the tree view pane
of the Mechanics Explorer.
To select the Frame Origin of the custom
frame, use one of the following methods:
At Reference Frame Origin: Make
the new frame origin coincident with the origin of the
reference frame of the solid.
At Center of Mass: Make the new
frame origin coincident with the center of mass of the
solid.
Based on Geometric Feature: Make
the new frame origin coincident with the center of the
selected feature. Valid features include surfaces,
lines, and points. Select a feature from the
visualization pane, then click Use Selected
Feature to confirm the location of the
origin. The name of the origin location appears in the
field below this option.
To define the orientation of the custom frame, under the
Frame Axes section, select the
Primary Axis and Secondary
Axis of the custom frame and then specify their
directions.
Use the following methods to select a vector for specifying the
directions of the primary and secondary axes. The primary axis is
parallel to the selected vector and constrains the remaining two
axes to its normal plane. The secondary axis is parallel to the
projection of the selected vector onto the normal plane.
Along Reference Frame Axis:
Selects an axis of the reference frame of the solid.
Along Principal Inertia Axis:
Selects an axis of the principal inertia axis of the
solid.
Based on Geometric Feature:
Selects the vector associated with the chosen geometry
feature of the solid. Valid features include surfaces
and lines. The corresponding vector is indicated by a
white arrow in the visualization pane. You can select a
feature from the visualization pane and then click
Use Selected Feature to confirm
the selection. The name of the selected feature appears
in the field below this option.
FrameN
— Edit or delete existing custom frame
frame name
Frames that you have created. N
is a unique identifying number for each
custom frame.
Click the Edit button
to edit other aspects of the
custom frame, such as origin and axes.
Click the Delete button
to delete the custom
frame.
Dependencies
To enable this parameter, create a frame by clicking New Frame.
Extended Capabilities
C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.
Introduced in R2019b