Skip to main content
Ctrl+K

Genesis World

  • User Guide
  • API Reference
  • GitHub
  • PyPI
  • User Guide
  • API Reference
  • GitHub
  • PyPI

Section Navigation

  • Scene
    • Scene
    • Simulator
    • Mesh
    • ForceField
  • Entity
    • Rigid entity
      • RigidEntity
      • RigidLink
      • RigidJoint
      • RigidGeom
      • RigidVisGeom
    • MPMEntity
    • FEMEntity
    • PBD entities
      • PBDParticleEntity
      • PBDFreeParticleEntity
      • PBD2DEntity
      • PBD3DEntity
      • PBDTetEntity
    • SPHEntity
    • SFParticleEntity
    • DroneEntity
    • HybridEntity
    • ToolEntity
    • Emitter
  • Visualization and rendering
    • Visualizer
    • Viewer
    • Camera
    • Renderers
      • gs.renderers.Rasterizer
      • gs.renderers.RayTracer
      • gs.renderers.BatchRenderer
    • Lights
  • Sensors
    • Camera sensor
    • Contact sensors
    • IMU sensor
    • Raycaster sensor
    • Tactile sensors
    • Other sensors
  • Recording and playback
    • Recorder
    • RecorderManager
    • File writers
    • Plotters
  • Physics engine
    • Solvers
      • RigidSolver
      • MPMSolver
      • FEMSolver
      • PBDSolver
      • SPHSolver
      • SFSolver
      • ToolSolver
    • Couplers
      • LegacyCoupler
      • SAPCoupler
      • IPCCoupler
    • States
  • Material
    • gs.materials.Rigid
    • 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.Cloth
      • 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
    • gs.materials.SPH.Liquid
    • gs.materials.SF.Smoke
    • gs.materials.Hybrid
    • gs.materials.Tool
    • gs.materials.Kinematic
  • Options
    • gs.options.Options
    • Simulator, coupler and solver options
      • gs.options.SimOptions
      • gs.options.BaseCouplerOptions
      • gs.options.LegacyCouplerOptions
      • gs.options.SAPCouplerOptions
      • gs.options.IPCCouplerOptions
      • gs.options.ToolOptions
      • gs.options.RigidOptions
      • gs.options.KinematicOptions
      • 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.MeshSet
        • gs.morphs.URDF
        • gs.morphs.MJCF
        • gs.morphs.USD
        • gs.morphs.Terrain
        • gs.morphs.Drone
      • gs.morphs.Nowhere
    • Surface
      • gs.surfaces.Surface
      • Plastic
        • gs.surfaces.Plastic
        • gs.surfaces.Rough
        • gs.surfaces.Smooth
        • gs.surfaces.Reflective
        • gs.surfaces.Collision
        • gs.surfaces.BSDF
        • gs.surfaces.Default
      • Metal
        • gs.surfaces.Metal
        • gs.surfaces.Iron
        • gs.surfaces.Aluminium
        • gs.surfaces.Copper
        • gs.surfaces.Gold
      • gs.surfaces.Emission
      • Glass
        • gs.surfaces.Glass
        • gs.surfaces.Water
    • Texture
      • gs.textures.Texture
      • gs.textures.ColorTexture
      • gs.textures.ImageTexture
      • gs.textures.BatchTexture
    • Miscellaneous options
      • gs.options.ProfilingOptions
      • gs.options.FoamOptions
      • gs.options.CoacdOptions
  • Utilities and helpers
    • Constants and enums
    • Device and platform utilities
    • Tensor utilities
    • Geometry utilities
    • File I/O utilities
  • Differentiable simulation
    • Tensor
    • Creation operations
  • API Reference
  • Entity
  • Rigid entity
  • RigidLink

RigidLink#

class genesis.engine.entities.rigid_entity.rigid_link.RigidLink(entity: RigidEntity, name: str, idx: int, joint_start: int, n_joints: int, geom_start: int, cell_start: int, vert_start: int, face_start: int, edge_start: int, free_verts_state_start: int, fixed_verts_state_start: int, vgeom_start: int, vvert_start: int, vface_start: int, pos: np.typing.ArrayLike, quat: np.typing.ArrayLike, inertial_pos: np.typing.ArrayLike | None, inertial_quat: np.typing.ArrayLike | None, inertial_i: np.typing.ArrayLike | None, inertial_mass: float | None, parent_idx: int, root_idx: int | None, invweight: float | None, visualize_contact: bool, is_robot: bool, aligned: bool = False)[source]#

Bases: KinematicLink

RigidLink class. One RigidEntity consists of multiple RigidLinks, each of which is a rigid body and could consist of multiple RigidGeoms (link.geoms, for collision) and RigidVisGeoms (link.vgeoms for visualization).

get_verts()[source]#

Get the vertices of the link’s collision body (concatenation of all link.geoms) in the world frame.

get_AABB()[source]#

Get the vertex-based axis-aligned bounding box (AABB) of the link’s collision body in the world frame by aggregating all the collision geometries associated with this link (link.geoms).

set_mass(mass: tuple[float, ...])[source]#

Set the mass of the link.

Parameters:

mass (float | array_like, shape (n_envs,)) – The mass to set.

get_mass()[source]#

Get the mass of the link.

set_friction(friction)[source]#

Set the friction of all the link’s geoms.

property visualize_contact: bool#

Whether to visualize the contact of the link.

property invweight#

The invweight of the link.

property inertial_pos: ArrayLike | None#

The initial position of the link’s inertial frame.

property inertial_quat: ArrayLike | None#

The initial quaternion of the link’s inertial frame.

property inertial_mass: float | None#

The initial mass of the link.

property inertial_i: ArrayLike | None#

The inerial matrix of the link.

property geoms: list[genesis.engine.entities.rigid_entity.rigid_geom.RigidGeom]#

The list of the link’s collision geometries (RigidGeom).

property n_geoms: int#

Number of the link’s collision geometries.

property geom_start: int#

The start index of the link’s collision geometries in the RigidSolver.

property geom_end: int#

The end index of the link’s collision geometries in the RigidSolver.

property n_cells#

Number of sdf cells of all the link’s geoms.

property n_verts: int#

Number of vertices of all the link’s geoms.

property n_faces: int#

Number of faces of all the link’s geoms.

property n_edges: int#

Number of edges of all the link’s geoms.

property is_free#

previous

RigidEntity

next

RigidJoint

On this page
  • RigidLink
    • RigidLink.get_verts()
    • RigidLink.get_AABB()
    • RigidLink.set_mass()
    • RigidLink.get_mass()
    • RigidLink.set_friction()
    • RigidLink.visualize_contact
    • RigidLink.invweight
    • RigidLink.inertial_pos
    • RigidLink.inertial_quat
    • RigidLink.inertial_mass
    • RigidLink.inertial_i
    • RigidLink.geoms
    • RigidLink.n_geoms
    • RigidLink.geom_start
    • RigidLink.geom_end
    • RigidLink.n_cells
    • RigidLink.n_verts
    • RigidLink.n_faces
    • RigidLink.n_edges
    • RigidLink.is_free
Edit on GitHub

This Page

  • Show Source
Genesis AI Genesis AI

© 2026 Genesis AI SAS