mani_skill.utils.structs.articulation_joint#

Classes#

ArticulationJoint

Wrapper around physx.PhysxArticulationJoint objects

Module Contents#

class mani_skill.utils.structs.articulation_joint.ArticulationJoint[source]#

Bases: mani_skill.utils.structs.base.BaseStruct[sapien.physx.PhysxArticulationJoint]

Wrapper around physx.PhysxArticulationJoint objects

At the moment, all of the same joints across all sub scenes are restricted to having the same properties as each other

__hash__()[source]#
__repr__()[source]#
__str__()[source]#
classmethod create(physx_joints, physx_articulations, scene, scene_idxs, joint_index, active_joint_index=None)[source]#

Creates an object for managing articulation joints in articulations

Note that the properties articulation, child_link, parent_link are by default None as they might not make sense in GPU sim and must be set by user

Parameters:
  • physx_joints (list[sapien.physx.PhysxArticulationJoint]) –

  • physx_articulations (list[sapien.physx.PhysxArticulation]) –

  • scene (mani_skill.envs.scene.ManiSkillScene) –

  • scene_idxs (torch.Tensor) –

  • joint_index (torch.Tensor) –

  • active_joint_index (torch.Tensor) –

get_damping()[source]#
Return type:

float

get_dof()[source]#
Return type:

int

get_drive_mode()[source]#
get_drive_target()[source]#
get_force_limit()[source]#
get_friction()[source]#
get_global_pose()[source]#
get_limits()[source]#
get_name()[source]#
get_pose_in_child()[source]#
get_pose_in_parent()[source]#
get_stiffness()[source]#
Return type:

float

get_type()[source]#
set_drive_properties(stiffness, damping, force_limit=3.4028234663852886e+38, mode='force')[source]#
Parameters:
  • stiffness (float) –

  • damping (float) –

  • force_limit (float) –

  • mode (Literal['force', 'acceleration']) –

set_drive_target(target)[source]#
Parameters:

target (mani_skill.utils.structs.types.Array) –

Return type:

None

set_drive_velocity_target(velocity)[source]#
Parameters:

velocity (mani_skill.utils.structs.types.Array) –

Return type:

None

set_friction(friction)[source]#
Parameters:

friction (float) –

set_limits(limits)[source]#
Parameters:

limits (mani_skill.utils.structs.types.Array) –

Return type:

None

property _data_index[source]#
_physx_articulations: list[sapien.physx.PhysxArticulation] = None[source]#
active_index: torch.Tensor[source]#

index of this joint amongst the active joints

articulation: mani_skill.utils.structs.articulation.Articulation | None = None[source]#
property damping: torch.Tensor[source]#
Return type:

torch.Tensor

property dof: torch.Tensor[source]#
Return type:

torch.Tensor

property drive_mode: list[Literal['force', 'acceleration']][source]#

typing.Literal[‘force’, ‘acceleration’]

Type:

type

Return type:

list[Literal[‘force’, ‘acceleration’]]

property drive_target: torch.Tensor[source]#
Return type:

torch.Tensor

property drive_velocity_target: torch.Tensor[source]#
Return type:

torch.Tensor

property force_limit: torch.Tensor[source]#
Return type:

torch.Tensor

property friction: torch.Tensor[source]#
Return type:

torch.Tensor

property global_pose: mani_skill.utils.structs.pose.Pose[source]#
Return type:

mani_skill.utils.structs.pose.Pose

index: torch.Tensor[source]#

index of this joint among all joints

property limits: torch.Tensor[source]#
Return type:

torch.Tensor

name: str = None[source]#
property pose_in_child[source]#
property pose_in_parent[source]#
property qpos[source]#

The qpos of this joint in the articulation

property qvel[source]#

The qvel of this joint in the articulation

property stiffness: torch.Tensor[source]#
Return type:

torch.Tensor

property type: list[Literal['fixed', 'revolute', 'revolute_unwrapped', 'prismatic', 'free']][source]#
Return type:

list[Literal[‘fixed’, ‘revolute’, ‘revolute_unwrapped’, ‘prismatic’, ‘free’]]