simscape.multibody.RigidBody Class

Namespace: simscape.multibody
Superclasses: simscape.multibody.Component

Construct rigid body

Since R2022a

Description

Use an object of the simscape.multibody.RigidBody class to construct a rigid body. A RigidBody object is a hierarchical container and has a tree structure composed of rigidly connected frames and component objects.

By default, a newly created RigidBody object contains only one frame called reference. The reference frame serves as the root of the tree structure. You must explicitly add frames or component objects to a RigidBody object, and the new frame or component object must be rigidly connected to the tree structure of the RigidBody object. Note that the name of every frame or component object must be unique among the frames and objects at the same hierarchical level of the RigidBody object.

In a larger system, to connect to other frames or component objects, a RigidBody object must have at least one connector. By default, a newly created RigidBody object has zero connectors, and adding frames or component objects to a RigidBody object does not automatically create connectors. To add a connector, use the addConnector method. Note that you can add connectors only to the frames at the top level of the RigidBody object, and each frame can only have one connector.

See More About section for more information about the RigidBody class.

The simscape.multibody.RigidBody class is a handle class.

Class Attributes

`Sealed`	`true`
`ConstructOnLoad`	`true`
`HandleCompatible`	`true`
`RestrictsSubclassing`	`true`

For information on class attributes, see Class Attributes.

Creation

Description

rb = simscape.multibody.RigidBody creates a simscape.multibody.RigidBody object.

example

Properties

expand all

`ComponentNames` — Names of top-level component objects in rigid body
[ ] (default) | string array

Names of the component objects at the top level of a simscape.multibody.RigidBody object, returned as a string array.

Example: "sphere"

Attributes:

`GetAccess`	`public`
`SetAccess`	`Restricts access`
`NonCopyable`	`true`
`Transient`	`true`

`FrameNames` — Names of top-level frames in rigid body
[ ] (default) | string array

Names of the frames at the top level of a simscape.multibody.RigidBody object, returned as a string array.

Example: "reference"

Attributes:

`GetAccess`	`public`
`SetAccess`	`Restricts access`
`NonCopyable`	`true`
`Transient`	`true`

Methods

expand all

Public Methods

`addComponent`	Add component object to rigid body
`addConnector`	Add connector to `Rigidbody` object
`addFrame`	Add frame to rigid body
`component`	Extract component object from `RigidBody` object
`componentPaths`	Return paths of component objects in `RigidBody` object
`plotStructure`	Plot structure tree of rigid body
`removeConnector`	Remove connector from `RigidBody` object

Examples

collapse all

Simple Link

Open Live Script

This example shows how to create a link that has a rectangular shape with two end frames.

To avoid typing the package name for the classes, you can use the import function.

import simscape.Value simscape.op.* simscape.multibody.*;

Create a simscape.multibody.RigidBody object to construct a rigid body named link. By default, the newly created object has one frame.

link = RigidBody

link = 
  RigidBody:

  No connectors.

  Frames:

  Frame        Parent  Source  Connector?
  ___________  ______  ______  __________

  "reference"  --      --      No        

  No components.

  RigidBody with properties:

         FrameNames: "reference"
     ComponentNames: [0x1 string]
        DoVisualize: 1
    FrameConnectors: [0x1 string]

To create the body of the link, you can use the simscape.multibody.Solid class. The body has a rectangular shape whose length, width, and height are 10 cm, 1 cm, and 1 cm, respectively. The length is in the x-direction of the local reference frame. The body is made of aluminum and has the red color.

body = Solid(Brick(Value([10 1 1],"cm")),UniformDensity(Value(2700,"kg/m^3")),SimpleVisualProperties([1 0 0]));

To add the body to the reference frame of the link object, use the addComponent method.

addComponent(link,"Body","reference",body);

To add a frame to each end of the link, you can use the addFrame method. The frames are named as neg_end and pos_end, respectively.

length = Value(10,"cm");
offset = length/2;
addFrame(link,"neg_end","reference",RigidTransform(StandardAxisTranslation(offset,Axis.NegX)));
addFrame(link,"pos_end","reference",RigidTransform(StandardAxisTranslation(offset,Axis.PosX)));

To be able to connect the link to other bodies or joints, the link needs to have connectors. To add connectors to the end frames, you can use the addConnector method.

addConnector(link,"neg_end");
addConnector(link,"pos_end");

To see the components in the link object, you can type:

link

link = 
  RigidBody:

  Connectors:

  Name       Type 
  _________  _____

  "neg_end"  Frame
  "pos_end"  Frame

  Frames:

  Frame        Parent       Source  Connector?
  ___________  ___________  ______  __________

  "reference"  --           --      No        
  "neg_end"    "reference"  Trans   Yes       
  "pos_end"    "reference"  Trans   Yes       

  Components:

  Name    Type   Frame        Connector
  ______  _____  ___________  _________

  "Body"  Solid  "reference"  "R"      

  RigidBody with properties:

         FrameNames: [3x1 string]
     ComponentNames: "Body"
        DoVisualize: 1
    FrameConnectors: [2x1 string]

Add Frames and Component Objects to a Rigid Body

Open Live Script

This example shows how to add a frame, solid, and sub-rigid body to a rigid body.

To avoid typing the package name for the classes, you can use the import function.

import simscape.multibody.*;

Create a simscape.multibody.RigidBody object named rb. The rb object has one frame called reference and no connectors.

rb = RigidBody

rb = 
  RigidBody:

  No connectors.

  Frames:

  Frame        Parent  Source  Connector?
  ___________  ______  ______  __________

  "reference"  --      --      No        

  No components.

  RigidBody with properties:

         FrameNames: "reference"
     ComponentNames: [0x1 string]
        DoVisualize: 1
    FrameConnectors: [0x1 string]

To add frames to the reference frame, create and add frames to a rigid transform object. First, create a simscape.multibody.RigidTransform object named rt. The rt object represents a translation along the positive y-axis of the base frame. The distance of the translation is 50 cm.

rt = RigidTransform(StandardAxisTranslation(simscape.Value(50,"cm"),Axis.PosY));

Then, use the addFrame method to add two frames, fa and fb, to the reference frame through the rt object.

addFrame(rb,"fa","reference",rt);
addFrame(rb,"fb","reference",rt);

You can view the tree structure of the rb object by using the plotStructure method.

plotStructure(rb);

Figure contains an axes object. The axes object contains 3 objects of type line, graphplot. One or more of the lines displays its values using only markers These objects represent Frame, Rigid Transform.

The green vertexes represent the frames, and the green lines represent the rigid transforms between the frames. The arrows indicate the orientations of the rigid transforms. By default, a rigid transform maps vectors from the new frame to the parent frame.

Add a simscape.multibody.Solid object to the rb object. First, create a simscape.multibody.Solid object called sphere. The sphere object represents a solid with a spherical shape. The sphere has a radius of 50 cm.

sphere = Solid(Sphere(simscape.Value(50,"cm")));

Then, use the addComponent method to add the sphere object to the fa frame. By default, a Solid object has one connector that you can connect to the rb object.

addComponent(rb,"sphere","fa",sphere);

Use the plotStructure method to show the tree structure of the rb object in a new figure.

figure
plotStructure(rb);

Figure contains an axes object. The axes object contains 5 objects of type line, graphplot. One or more of the lines displays its values using only markers These objects represent Frame, Solid, Rigid Transform, Connection.

The blue vertex represents the sphere object, and the pink link indicates the connection between the fa frame and the sphere object.

Add a RigidBody object to the rb object as a subbody. Create an empty RigidBody object called subrb and add two new frames, f1 and f2, to the subrb object through the rt object.

subrb = RigidBody;
addFrame(subrb,"f1","reference",rt);
addFrame(subrb,"f2","reference",rt);

Because the subrb object has zero connectors, you must add at least one connector to the object. Use the addConnector method to add a connector to the f1 frame of the subrb object. The connector and frame have the same name.

addConnector(subrb,"f1");

Use the addComponent method to attach the subrb object to the fb frame through the f1 connector.

addComponent(rb,"subrb","fb",subrb,"f1");

Use the plotStructure method to show the tree structure of the rb object in a new figure.

figure
plotStructure(rb);

Figure contains an axes object. The axes object contains 6 objects of type line, graphplot. One or more of the lines displays its values using only markers These objects represent Frame, Solid, Rigid Body, Rigid Transform, Connection.

The red vertex represents the subrb object, and the pink line indicates the connection between the fb frame and the f1 connector of the subrb object.

More About

expand all

How to Add Frames and Component Objects

To add a frame to a simscape.multibody.RigidBody object, use the addFrame method. The frame must connect to an existing frame of the RigidBody through a simscape.multibody.RigidTransform object. There is no limit to the size of the tree structure.

Similarly, to add a component object to a RigidBody object, use the addComponent method. Unlike the simscape.multibody.Multibody object, a RigidBody object can have only two types of component objects: simscape.multibody.Solid and simscape.multibody.RigidBody. A component object must be connected to an existing frame of the RigidBody through a connector. The addComponent method adds only a copy of a component object. In other words, after being passed to the addCompoment method, any subsequent modifications to the original component object do not affect the added object inside the RigidBody object.

Note that you can only add frames or component objects to the top-level of the RigidBody object.

Tree Structure of `RigidBody` Object

To display the tree structure of a RigidBody object, use the plotStructure method. The figure shows the top-level structure of a RigidBody object.

The vertexes represent frames and component objects within the RigidBody object. A green vertex is the frame, a blue vertex is a simscape.multibody.Solid object, and a red vertex is a simscape.multibody.RigidBody object. The reference frame serves as the root of the tree structure. See the Examples section to learn how to add a frame or component object to a RigidBody object.

Version History

Introduced in R2022a

simscape.multibody.RigidBody Class

Description

Class Attributes

Creation

Description

Properties

ComponentNames — Names of top-level component objects in rigid body [ ] (default) | string array

Attributes:

FrameNames — Names of top-level frames in rigid body [ ] (default) | string array

Attributes:

Methods

Public Methods

Examples

Simple Link

Add Frames and Component Objects to a Rigid Body

More About

How to Add Frames and Component Objects

Tree Structure of RigidBody Object

Version History

See Also

`ComponentNames` — Names of top-level component objects in rigid body
[ ] (default) | string array

`FrameNames` — Names of top-level frames in rigid body
[ ] (default) | string array

Tree Structure of `RigidBody` Object