sim3d.person.Pedestrian

Create pedestrian that follows ground in 3D environment

Since R2024b

Description

Use the sim3d.person.Pedestrian object to create a pedestrian that follows ground in the 3D environment. After you create a sim3d.person.Pedestrian object, you can modify aspects of the pedestrian actor by setting property values.

Creation

Syntax

person = sim3d.person.Pedestrian()

person = sim3d.person.Pedestrian(Name=Value)

Description

person = sim3d.person.Pedestrian() creates a default pedestrian object in the 3D environment.

person = sim3d.person.Pedestrian(Name=Value) specifies options using one or more name-value arguments. For example, to create a pedestrian at the position [1 2 0], set Translation to [1 2 0].

Input Arguments

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: person = sim3d.person.Pedestrian(ActorName="Pedestrian",PedestrianType="male_02")

ActorName — Name of actor

autogenerated name (default) | character array | string

Name of actor, specified as a character array or string. If you do not specify an actor name, then the software assigns the actor an autogenerated name. Use this argument to set the name of the sim3d.person.Pedestrian object.

Note

If you specify the same name as an actor that already exists, then the software appends actor name you specify with a unique identifier.

PedestrianType — Type of pedestrian

"male_01" (default) | "male_02" | "male_03" | "female_01" | "female_02" | "female_03" | "child"

Type of pedestrian, specified as one of these options:

• "male_01"

• "male_02"

• "male_03"

• "female_01"

• "female_02"

• "female_03"

• "child"

Example: PedestrianType="male_02"

Data Types: string

ActorClassId — Semantic segmentation map of object class identifiers

4 (default) | real positive scalar

Semantic segmentation map of object class identifiers, specified as real positive scalar. For a complete list of actor IDs and their corresponding object descriptions, see Labels.

Translation — Relative translation

[0 0 0] (default) | real 1-by-3 vector

Relative translation (x,y,z) of the actor object to its parent actor, specified as a real 1-by-3 vector, in m. Use this argument to set the initial translation of the pedestrian in the 3D environment along the X, Y, and Z axes of the ISO 8855 standard coordinate system. For more information on the coordinate system, see Coordinate Systems in Simulink 3D Animation. When you add an actor to the 3D environment, the default parent actor is the Scene Origin at (0,0,0).

Example: Translation=[3 4 3]

Note

The sim3d.person.Pedestrian object implements an actor that follows the ground. Use X, Y, and Yaw properties to move the actor in the 3D environment. The actor object then determines the corresponding elevation, pitch, and roll by sensing the ground terrain.

Data Types: double

Rotation — Relative rotation

[0 0 0] (default) | real 1-by-3 vector

Relative rotation (roll, pitch, yaw) of the actor object to its parent actor, specified as a real 1-by-3 vector, in rad. Use this argument to set the initial rotation of the pedestrian in the 3D environment along the X, Y, and Z axes of the ISO 8855 standard coordinate system. For more information on the coordinate system, see Coordinate Systems in Simulink 3D Animation.

Example: Rotation=[0 0 pi/4]

Note

The sim3d.person.Pedestrian object implements an actor that follows the ground. Use X, Y, and Yaw properties to move the actor in the 3D environment. The actor object then determines the corresponding elevation, pitch, and roll by sensing the ground terrain.

Data Types: double

Properties

Parent — Parent of actor

handle to parent actor object

Parent of actor, specified as a handle to the parent actor object. After you add an actor to the sim3d.World object, the default parent actor is the Scene Origin at (0,0,0). Use this property to set any actor in the 3D environment as the parent actor of a sim3d.person.Pedestrian object.

Children — Children of actor

structure

This property is read-only.

Children of actor, specified as a structure. Each field of the structure contains a handle to the child of a sim3d.person.Pedestrian object.

ParentWorld — Parent world

handle to parent world object

Parent world, specified as a handle to the parent sim3d.World object. You can use this property only if the sim3d.person.Pedestrian object is added to the parent sim3d.World object.

PedestrianType — Type of pedestrian

"male_01" (default) | "male_02" | "male_03" | "female_01" | "female_02" | "female_03" | "child"

Type of pedestrian, specified as one of these options:

• "male_01"

• "male_02"

• "male_03"

• "female_01"

• "female_02"

• "female_03"

• "child"

Example: PedestrianType="male_02"

Data Types: string

X — Longitudinal position of actor

0 (default) | scalar

Longitudinal position of the actor along the X-axis of the scene, specified as scalar, in m. X is in the ISO 8855 standard coordinate system. Use this property to move the actor along the X-axis of the scene. For more information on the coordinate system, see Coordinate Systems in Simulink 3D Animation.

Y — Lateral position of actor

0 (default) | scalar

Lateral position of the actor along the Y-axis of the scene, specified as scalar, in m. Y is in the ISO 8855 standard coordinate system. Use this property to move the actor along the Y-axis of the scene. For more information on the coordinate system, see Coordinate Systems in Simulink 3D Animation.

Yaw — Yaw orientation angle of actor

0 (default) | scalar

Yaw orientation angle of the actor along the Z-axis of the scene, specified as scalar, in rad. Yaw is in the ISO 8855 standard coordinate system. Use this property to rotate the actor along the Z-axis of the scene. For more information on the coordinate system, see Coordinate Systems in Simulink 3D Animation.

Version History

Introduced in R2024b