Module TeachMyAgent.environments.envs.utils.custom_user_data

Classes

class CustomBodySensorUserData (check_contact, is_contact_critical=False, name='body_part')

Use this for sensors.

Define body type and contact properties. Using check_contact=False means collisions should be ignored. Defining is_contact_critical=True means a collision should stop the episode.

Expand source code

class CustomBodySensorUserData(CustomBodyUserData):
    '''
        Use this for sensors.
    '''
    def __init__(self, check_contact, is_contact_critical=False, name="body_part",):
        super(CustomBodySensorUserData, self).__init__(check_contact=check_contact,
                                                       is_contact_critical=is_contact_critical,
                                                       name=name,
                                                       object_type=CustomUserDataObjectTypes.BODY_SENSOR)
        self.has_joint = False
        self.ready_to_attach = False

Ancestors

• CustomBodyUserData
• CustomUserData

class CustomBodyUserData (check_contact, is_contact_critical=False, name='body_part', object_type=CustomUserDataObjectTypes.BODY_OBJECT)

Custom user data allowing to store properties on objects.

Define body type and contact properties. Using check_contact=False means collisions should be ignored. Defining is_contact_critical=True means a collision should stop the episode.

Expand source code

class CustomBodyUserData(CustomUserData):
    def __init__(self, check_contact, is_contact_critical=False, name="body_part",
                 object_type=CustomUserDataObjectTypes.BODY_OBJECT):
        '''
            Define body type and contact properties. Using `check_contact=False` means collisions should be ignored.
            Defining `is_contact_critical=True` means a collision should stop the episode.
        '''
        super(CustomBodyUserData, self).__init__(name, object_type)
        self.check_contact = check_contact
        self.is_contact_critical = is_contact_critical
        self.has_contact = False

Ancestors

• CustomUserData

Subclasses

• CustomBodySensorUserData

class CustomMotorUserData (speed_control, check_contact, angle_correction=0.0, contact_body=None)

Use this for joints on which enableMotor=True.

If check_contact is set to True, a contact_body must be given. This is used in the observation space to give info about motors as well as contacts on linked objects.

Expand source code

class CustomMotorUserData(CustomUserData):
    '''
        Use this for joints on which enableMotor=True.
    '''
    def __init__(self, speed_control, check_contact, angle_correction=0.0, contact_body=None):
        '''
            If `check_contact` is set to True, a `contact_body` must be given.
            This is used in the observation space to give info about motors as well as contacts on linked objects.
        '''
        super(CustomMotorUserData, self).__init__("motor", CustomUserDataObjectTypes.MOTOR)
        self.speed_control = speed_control
        self.check_contact = check_contact
        self.angle_correction = angle_correction
        self.contact_body = contact_body

Ancestors

• CustomUserData

class CustomUserData (name, object_type)

Custom user data allowing to store properties on objects.

Expand source code

class CustomUserData(object):
    '''
        Custom user data allowing to store properties on objects.
    '''
    def __init__(self, name, object_type):
        self.name = name
        self.object_type = object_type

Subclasses

• CustomBodyUserData
• CustomMotorUserData

class CustomUserDataObjectTypes (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class CustomUserDataObjectTypes(Enum):
    BODY_OBJECT = 0
    WATER = 1
    TERRAIN = 2
    GRIP_TERRAIN = 3 # graspable terrain
    MOTOR = 4
    BODY_SENSOR = 5
    SENSOR_GRIP_TERRAIN = 6 # graspable sensor terrain (e.g. creeper)

Ancestors

• enum.Enum

Class variables

var BODY_OBJECT

var BODY_SENSOR

var GRIP_TERRAIN

var MOTOR

var SENSOR_GRIP_TERRAIN

var TERRAIN

var WATER