gs.morphs.Plane#
- class genesis.options.morphs.Plane(*, pos: tuple = (0.0, 0.0, 0.0), euler: tuple | None = None, quat: tuple | None = None, visualization: bool = True, collision: bool = True, requires_jac_and_IK: bool = False, is_free: bool | None = None, fixed: bool = True, contype: int = 65535, conaffinity: int = 65535, normal: tuple = (0, 0, 1), plane_size: tuple = (1000.0, 1000.0), tile_size: tuple = (1, 1))[source]#
Morph defined by a plane shape.
Note
Plane is a primitive with infinite size. Note that the pos is the center of the plane, but essetially only defines a point where the plane passes through.
- Parameters:
pos (tuple, shape (3,), optional) – The center position of the plane in meters. Defaults to (0.0, 0.0, 0.0).
euler (tuple, shape (3,), optional) – The euler angle of the entity in degrees. This follows scipy’s extrinsic x-y-z rotation convention. Defaults to (0.0, 0.0, 0.0).
quat (tuple, shape (4,), optional) – The quaternion (w-x-y-z convention) of the entity. If specified, euler will be ignored. Defaults to None.
normal (tuple, shape (3,), optional) – The normal normal of the plane in its local frame. Defaults to (0, 0, 1).
visualization (bool, optional) – Whether the entity needs to be visualized. Set it to False if you need a invisible object only for collision purposes. Defaults to True. visualization and collision cannot both be False. This is only used for RigidEntity.
collision (bool, optional) – Whether the entity needs to be considered for collision checking. Defaults to True. visualization and collision cannot both be False. This is only used for RigidEntity.
fixed (bool, optional) – Whether the baselink of the entity should be fixed. Defaults to False. This is only used for RigidEntity.
contype (int, optional) – The 32-bit integer bitmasks used for contact filtering of contact pairs. When the contype of one geom and the conaffinity of the other geom share a common bit set to 1, two geoms can collide. Defaults to 0xFFFF.
conaffinity (int, optional) – The 32-bit integer bitmasks used for contact filtering of contact pairs. When the conaffinity of one geom and the contype of the other geom share a common bit set to 1, two geoms can collide. Defaults to 0xFFFF.
plane_size (tuple, optional) – The size of the plane in meters. Defaults to (1e3, 1e3).
tile_size (tuple, optional) – The size of each texture tile. Defaults to (1, 1).