Skip to main content
Ctrl+K
Genesis 0.3.6 documentation - Home Genesis 0.3.6 documentation - Home
  • User Guide
  • API Reference
  • Roadmap
  • User Guide
  • API Reference
  • Roadmap

Section Navigation

  • Scene
    • Scene
    • Simulator
  • Entity
    • RigidEntity
      • RigidEntity
      • RigidLink
      • RigidJoint
      • RigidGeom
      • RigidVisGeom
    • AvatarEntity
      • AvatarEntity
      • AvatarLink
      • AvatarJoint
      • AvatarGeom
    • MPMEntity
    • FEMEntity
    • PBDEntity
      • PBDParticleEntity
      • PBDFreeParticleEntity
      • PBD2DEntity
      • PBD3DEntity
      • PBDTetEntity
    • SPHEntity
    • DroneEntity
    • HybridEntity
    • Emitter
  • Material
    • gs.materials.Rigid
    • gs.materials.Avatar
    • MPM
      • gs.materials.MPM.Elastic
      • gs.materials.MPM.ElastoPlastic
      • gs.materials.MPM.Liquid
      • gs.materials.MPM.Muscle
      • gs.materials.MPM.Sand
      • gs.materials.MPM.Snow
    • FEM
      • gs.materials.FEM.Elastic
      • gs.materials.FEM.Muscle
    • PBD
      • gs.materials.PBD.Elastic
      • gs.materials.PBD.Cloth
      • gs.materials.PBD.Liquid
      • gs.materials.PBD.Particle
    • SPH
      • gs.materials.SPH.Liquid
    • gs.materials.Hybrid
  • Sensor
    • Camera
  • Options
    • gs.options.Options
    • Simulator, Coupler & Solver Options
      • gs.options.SimOptions
      • gs.options.CouplerOptions
      • gs.options.ToolOptions
      • gs.options.RigidOptions
      • gs.options.AvatarOptions
      • gs.options.MPMOptions
      • gs.options.SPHOptions
      • gs.options.PBDOptions
      • gs.options.FEMOptions
      • gs.options.SFOptions
    • Morph
      • gs.morphs.Morph
      • Primitive
        • gs.morphs.Primitive
        • gs.morphs.Box
        • gs.morphs.Sphere
        • gs.morphs.Cylinder
        • gs.morphs.Plane
      • FileMorph
        • gs.morphs.FileMorph
        • gs.morphs.Mesh
        • gs.morphs.URDF
        • gs.morphs.MJCF
        • gs.morphs.Terrain
        • gs.morphs.Drone
    • Renderer
      • gs.renderers.Renderer
      • gs.renderers.Rasterizer
      • gs.renderers.RayTracer
      • gs.renderers.RayTracer
    • Surface
      • gs.surfaces.Surface
      • Plastic
        • gs.surfaces.Plastic
        • gs.surfaces.Rough
        • gs.surfaces.Smooth
        • gs.surfaces.Reflective
        • gs.surfaces.Collision
        • gs.surfaces.Default
      • Metal
        • gs.surfaces.Metal
        • gs.surfaces.Iron
        • gs.surfaces.Aluminium
        • gs.surfaces.Copper
        • gs.surfaces.Gold
      • Emission
        • gs.surfaces.Emission
      • Glass
        • gs.surfaces.Glass
        • gs.surfaces.Water
    • Texture
      • gs.textures.Texture
      • gs.textures.ColorTexture
      • gs.textures.ImageTexture
    • Viewer & Visualization
      • gs.options.ViewerOptions
      • gs.options.VisOptions
  • API Reference
  • Scene

Scene#

A genesis.Scene object wraps all components in a simulation environment, including a simulator (containing multiple physics solvers), entities, and a visualizer (controlling both the viewer and all the cameras). Basically, everything happens inside a scene.

  • Scene
    • Scene
      • Scene.destroy()
      • Scene.add_entity()
      • Scene.link_entities()
      • Scene.add_mesh_light()
      • Scene.add_light()
      • Scene.add_sensor()
      • Scene.start_recording()
      • Scene.add_camera()
      • Scene.add_emitter()
      • Scene.add_force_field()
      • Scene.build()
      • Scene.reset()
      • Scene.get_state()
      • Scene.step()
      • Scene.stop_recording()
      • Scene.draw_debug_line()
      • Scene.draw_debug_arrow()
      • Scene.draw_debug_frame()
      • Scene.draw_debug_frames()
      • Scene.draw_debug_mesh()
      • Scene.draw_debug_sphere()
      • Scene.draw_debug_spheres()
      • Scene.draw_debug_box()
      • Scene.draw_debug_points()
      • Scene.draw_debug_path()
      • Scene.render_all_cameras()
      • Scene.clear_debug_object()
      • Scene.clear_debug_objects()
      • Scene.dump_ckpt_to_numpy()
      • Scene.save_checkpoint()
      • Scene.load_checkpoint()
      • Scene.uid
      • Scene.dt
      • Scene.t
      • Scene.substeps
      • Scene.requires_grad
      • Scene.is_built
      • Scene.show_FPS
      • Scene.gravity
      • Scene.viewer
      • Scene.visualizer
      • Scene.sim
      • Scene.cur_t
      • Scene.solvers
      • Scene.active_solvers
      • Scene.entities
      • Scene.emitters
      • Scene.tool_solver
      • Scene.rigid_solver
      • Scene.avatar_solver
      • Scene.mpm_solver
      • Scene.sph_solver
      • Scene.fem_solver
      • Scene.pbd_solver
      • Scene.segmentation_idx_dict
  • Simulator

previous

API Reference

next

Scene

Edit on GitHub

This Page

  • Show Source

© Copyright 2024, Genesis Developers.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.