Orbit 使用指南 02 | 在场景中生成原始对象| Isaac Sim

如是我闻： Orbit使用指南02将

深入探讨如何使用Python代码在Orbit中向场景生成各种对象（或原始对象）。
一起探索如何生成地面平面、灯光、基本图形形状以及来自USD文件的网格。
前置知识：如何生成空白场景，Orbit 使用指南 01

指南02对应于orbit/source/standalone/tutorials/00_sim目录下的spawn_prims.py脚本。让我们先瞅一瞅这个Python脚本：

# Copyright (c) 2022-2024, The ORBIT Project Developers.
# All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause

"""This script demonstrates how to spawn prims into the scene.

.. code-block:: bash

    # Usage
    ./orbit.sh -p source/standalone/tutorials/00_sim/spawn_prims.py

"""

from __future__ import annotations

"""Launch Isaac Sim Simulator first."""
import argparse

from omni.isaac.orbit.app import AppLauncher

# create argparser
parser = argparse.ArgumentParser(description="Tutorial on spawning prims into the scene.")
# append AppLauncher cli args
AppLauncher.add_app_launcher_args(parser)
# parse the arguments
args_cli = parser.parse_args()
# launch omniverse app
app_launcher = AppLauncher(args_cli)
simulation_app = app_launcher.app

"""Rest everything follows."""

import traceback

import carb
import omni.isaac.core.utils.prims as prim_utils

import omni.isaac.orbit.sim as sim_utils
from omni.isaac.orbit.utils.assets import ISAAC_NUCLEUS_DIR


def design_scene():
    """Designs the scene by spawning ground plane, light, objects and meshes from usd files."""
    # Ground-plane
    cfg_ground = sim_utils.GroundPlaneCfg()
    cfg_ground.func("/World/defaultGroundPlane", cfg_ground)

    # spawn distant light
    cfg_light_distant = sim_utils.DistantLightCfg(
        intensity=3000.0,
        color=(0.75, 0.75, 0.75),
    )
    cfg_light_distant.func("/World/lightDistant", cfg_light_distant, translation=(1, 0, 10))

    # create a new xform prim for all objects to be spawned under
    prim_utils.create_prim("/World/Objects", "Xform")
    # spawn a red cone
    cfg_cone = sim_utils.ConeCfg(
        radius=0.15,
        height=0.5,
        visual_material=sim_utils.PreviewSurfaceCfg(diffuse_color=(1.0, 0.0, 0.0)),
    )
    cfg_cone.func("/World/Objects/Cone1", cfg_cone, translation=(-1.0, 1.0, 1.0))
    cfg_cone.func("/World/Objects/Cone2", cfg_cone, translation=(-1.0, -1.0, 1.0))

    # spawn a green cone with colliders and rigid body
    cfg_cone_rigid = sim_utils.ConeCfg(
        radius=0.15,
        height=0.5,
        rigid_props=sim_utils.RigidBodyPropertiesCfg(),
        mass_props=sim_utils.MassPropertiesCfg(mass=1.0),
        collision_props=sim_utils.CollisionPropertiesCfg(),
        visual_material=sim_utils.PreviewSurfaceCfg(diffuse_color=(0.0, 1.0, 0.0)),
    )
    cfg_cone_rigid.func(
        "/World/Objects/ConeRigid", cfg_cone_rigid, translation=(0.0, 0.0, 2.0), orientation=(0.5, 0.0, 0.5, 0.0)
    )

    # spawn a usd file of a table into the scene
    cfg = sim_utils.UsdFileCfg(usd_path=f"{ISAAC_NUCLEUS_DIR}/Props/Mounts/SeattleLabTable/table_instanceable.usd")
    cfg.func("/World/Objects/Table", cfg, translation=(0.0, 0.0, 1.05))


def main():
    """Main function."""

    # Initialize the simulation context
    sim_cfg = sim_utils.SimulationCfg(dt=0.01, substeps=1)
    sim = sim_utils.SimulationContext(sim_cfg)
    # Set main camera
    sim.set_camera_view([2.0, 0.0, 2.5], [-0.5, 0.0, 0.5])

    # Design scene by adding assets to it
    design_scene()

    # Play the simulator
    sim.reset()
    # Now we are ready!
    print("[INFO]: Setup complete...")

    # Simulate physics
    while simulation_app.is_running():
        # perform step
        sim.step()


if __name__ == "__main__":
    try:
        # run the main execution
        main()
    except Exception as err:
        carb.log_error(err)
        carb.log_error(traceback.format_exc())
        raise
    finally:
        # close sim app
        simulation_app.close()

代码解析

Omniverse中的场景设计始终绕不过去一个名为USD（Universal Scene Description，通用场景描述）的软件系统和文件格式。它允许以类似文件系统的层次方式来描述3D场景。由于USD是一个全面的框架，推荐阅读USD的文档以深入了解它。

为了让大家全面了解，这里介绍一些必须掌握的USD概念。

原始对象（Primitives，简称Prims）：这些是USD场景的基本构建块。可以将它们视为场景图中的节点。每个节点可以是一个网格（mesh）、灯光（light）、相机（camera）或变换（transform）。它也可以是一组其他的原始对象。
属性（Attributes）：这些是原始对象的属性。可以将它们视为键值对。例如，一个原始对象可以有一个名为颜色的属性，其值为红色。
关系（Relationships）：这些是原始对象之间的连接。可以将它们视为指向其他原始对象的指针。例如，一个网格原始对象可以与一个材质原始对象有一个关系，用于遮光。

这些原始对象及其属性和关系的集合被称为USD展台（stage）。它可以被视为场景中所有原始对象的容器。当我们说我们在设计一个场景时，实际上我们是在设计一个USD展台。

虽然直接使用USD API提供了很大的灵活性，但学习和使用它可能会比较繁琐。为了简化场景设计，Orbit在USD API的基础上构建，提供了一个配置驱动的接口来将原始对象生成到场景中。这些功能包含在sim.spawners模块中。

在场景中生成原始对象时，每个原始对象需要一个定义了原始对象属性和关系（通过材料和阴影区信息）的配置类实例。然后，指定了原始对象的名称和变换的配置类，被传递给其相应的函数。函数随后将原始对象生成到场景中。

抽象的来看，一般是这样的

# Create a configuration class instance
cfg = MyPrimCfg()
prim_path = "/path/to/prim"

# Spawn the prim into the scene using the corresponding spawner function
spawn_my_prim(prim_path, cfg, translation=[0, 0, 0], orientation=[1, 0, 0, 0], scale=[1, 1, 1])
# OR
# Use the spawner function directly from the configuration class
cfg.func(prim_path, cfg, translation=[0, 0, 0], orientation=[1, 0, 0, 0], scale=[1, 1, 1])

在这里，我们展示如何在场景中生成各种不同的原始对象。想要了解更多可用的生成器（spawners），请参考Orbit中的sim.spawners模块。

生成一个地面平面

sim.spawners.GroundPlaneCfg用于配置一个网格状的地面平面，并且可以修改其属性，比如外观和大小。

    # Ground-plane
    cfg_ground = sim_utils.GroundPlaneCfg()
    cfg_ground.func("/World/defaultGroundPlane", cfg_ground)

生成灯光

可以在展台上生成不同类型的灯光原始对象，包括远光、球形灯、圆盘灯和圆柱灯。在这里，我们生成一个远光，这是一种来自无限远处、只向一个方向照射的灯光。

    # spawn distant light
    cfg_light_distant = sim_utils.DistantLightCfg(
        intensity=3000.0,
        color=(0.75, 0.75, 0.75),
    )
    cfg_light_distant.func("/World/lightDistant", cfg_light_distant, translation=(1, 0, 10))

生成基本图形（primitive shapes）

在介绍如何生成基本形状之前，我们先介绍一个名为变换原始对象（或Xform）的概念。变换原始对象是一种只包含变换属性的原始对象。它用于将其他原始对象分组并作为一个整体进行变换。在这里，我们创建一个Xform原始对象，将所有基本图形分组在其下。

    # create a new xform prim for all objects to be spawned under
    prim_utils.create_prim("/World/Objects", "Xform")

接下来，使用sim.spawners.ConeCfg类生成一个圆锥。我们可以指定圆锥的半径、高度、物理属性和材质属性。默认情况下，物理和材质属性是禁用的。

我们生成的前两个圆锥Cone1和Cone2是视觉元素，没有启用物理效果。

    # spawn a red cone
    cfg_cone = sim_utils.ConeCfg(
        radius=0.15,
        height=0.5,
        visual_material=sim_utils.PreviewSurfaceCfg(diffuse_color=(1.0, 0.0, 0.0)),
    )
    cfg_cone.func("/World/Objects/Cone1", cfg_cone, translation=(-1.0, 1.0, 1.0))
    cfg_cone.func("/World/Objects/Cone2", cfg_cone, translation=(-1.0, -1.0, 1.0))

对于第三个圆锥ConeRigid，我们通过在配置类中设置属性，为其添加了刚体物理效果。通过这些属性，我们可以指定圆锥的质量、摩擦力系数和弹性系数。如果不指定，它们将默认使用USD物理设置的默认值。

    # spawn a red cone
    cfg_cone = sim_utils.ConeCfg(
        radius=0.15,
        height=0.5,
        visual_material=sim_utils.PreviewSurfaceCfg(diffuse_color=(1.0, 0.0, 0.0)),
    )
    cfg_cone.func("/World/Objects/Cone1", cfg_cone, translation=(-1.0, 1.0, 1.0))
    cfg_cone.func("/World/Objects/Cone2", cfg_cone, translation=(-1.0, -1.0, 1.0))

通过其他文件生成

最后，还可以从其他文件格式中生成原始对象，如其他USD、URDF或OBJ文件。在这里，我们将一个桌子的USD文件生成到场景中。桌子是一个网格原始对象，并且有一个与之关联的材质原始对象。所有这些信息都存储在其USD文件中。

    # spawn a usd file of a table into the scene
    cfg = sim_utils.UsdFileCfg(usd_path=f"{ISAAC_NUCLEUS_DIR}/Props/Mounts/SeattleLabTable/table_instanceable.usd")
    cfg.func("/World/Objects/Table", cfg, translation=(0.0, 0.0, 1.05))

上述的桌子实际上是作为一个引用被添加到场景中。用通俗的话来说，这意味着桌子实际上没有被直接添加到场景中，而是添加了一个指向桌子的指针。这允许我们以非破坏性的方式对桌子做出修改并在场景中反映出其变化。例如，我们可以改变桌子的材质，而无需直接修改桌子的底层文件。只有变化会被存储在USD展台中。

运行脚本

我们通过在命令行输入以下命令来运行脚本

./orbit.sh -p source/standalone/tutorials/00_sim/spawn_prims.py

模拟开始，应该能看到一个窗口，里面有一个地面平面、灯光、一些圆锥和一个桌子。启用了刚体物理的绿色圆锥应该会掉落并与桌子及地面平面发生碰撞。其他的圆锥是视觉元素，应该保持静止。要停止模拟，你可以关闭窗口，或在终端中按Ctrl+C。
在这里插入图片描述

指南02为在Orbit中，向场景生成各种原始对象提供了基础，展示了Orbit场景设计的基本概念以及如何使用生成器（spawners）。在接下来的指南中，我们将探讨如何与场景和模拟进行交互。