simscape.multibody.Ellipsoid Class

R2026b

Namespace: simscape.multibody
Superclasses: simscape.multibody.Geometry

Create ellipsoidal geometry

Since R2022a

expand all in page

Description

Use an object of the simscape.multibody.Ellipsoid class to represent ellipsoidal geometry. The reference frame of the geometry is located at the centroid of the ellipsoid and the semi-axes are aligned with the axes of the reference frame. To specify the dimensions of the geometry, use the Radii property.

Example of ellipsoidal geometry

Class Attributes

Sealed
true
ConstructOnLoad
true
RestrictsSubclassing
true

For information on class attributes, see Class Attributes.

Creation

Description

ellipsoid = simscape.multibody.ellipsoid creates an ellipsoidal geometry with default values.

ellipsoid = simscape.multibody.ellipsoid(radii) creates an ellipsoidal geometry with the specified radii.

ellipsoid = simscape.multibody.Ellipsoid(radii,surfaceGraphic) creates an ellipsoidal geometry with the specified radii and surface visualization properties.

example

Properties

expand all

Lengths of the three semi-axes of the ellipsoidal geometry, specified as a simscape.Value object that represents a 3-by-1 or 1-by-3 array with a unit of length. The array defines the intercepts of the ellipsoidal surface with the axes of the reference frame.

x-, y-, and z- radii of an ellipsoidal geometry

Example: simscape.Value([240 112 70], "mm")

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Surface visualization properties of the geometry, specified as a simscape.multibody.SurfaceGraphic object.

Attributes:

GetAccess
public
SetAccess
public

Examples

collapse all

This example shows how to create an ellipsoidal geometry with custom surface visualization properties.

Create a SurfaceGraphic object with a red color and opacity of 0.5.

sg = simscape.multibody.SurfaceGraphic(simscape.multibody.SimpleVisualProperties([1 0 0], 0.5));

Create an ellipsoidal geometry with semi-axis lengths of 0.1 m, 0.2 m, and 0.15 m, and the surface graphic.

ellipsoid = simscape.multibody.Ellipsoid(simscape.Value([0.1 0.2 0.15],"m"), sg)

ellipsoid =
  Ellipsoid with properties:

             Radii: [0.1000 0.2000 0.1500] (m)
    SurfaceGraphic: [1x1 simscape.multibody.SurfaceGraphic]

Version History

Introduced in R2022a

See Also