habitat_sim.attributes.MarkerSets class

Methods

def find_value_location(self, key: str) -> typing.List[str]: Returns a list of keys, in order, for the traversal of the nested subconfigurations in this Configuration to get the requested key’s value or subconfig. Key is not found if list is empty.
def get(self, arg0: str, /) -> object: Retrieve the requested value referenced by key argument, if it exists
def get_all_marker_points(self, /) -> typing.Dict[str, typing.Dict[str, typing.Dict[str, typing.List[magnum.Vector3]]]]: Get the marker points for every MarkerSet of every link of every TaskSet present as a dict of dicts of dicts. The format is a dictionary keyed by TaskSet name, of dictionaries, keyed by LinkSet name, of dictionaries, each keyed by MarkerSet name referencing a list of that MarkerSet’s marker points
def get_all_taskset_names(self, /) -> typing.List[str]: Get a list of all the existing TaskSet names
def get_as_string(self, arg0: str, /) -> str: Retrieves a string representation of the value referred to by the passed key.
def get_keys_and_types(self, /) -> typing.Dict[str, habitat_sim._ext.habitat_sim_bindings.ConfigValType]: Returns a dictionary where the keys are the names of the values this configuration holds and the values are the types of these values.
def get_keys_by_type(self, value_type: habitat_sim._ext.habitat_sim_bindings.ConfigValType, sorted: bool = False) -> typing.List[str]: Retrieves a list of all the keys of values of the specified types. Takes ConfigValType enum value as argument, and whether the keys should be sorted or not.
def get_subconfig(self, name: str) -> habitat_sim._ext.habitat_sim_bindings.Configuration: Get the subconfiguration with the given name.
def get_subconfig_copy(self, name: str) -> habitat_sim._ext.habitat_sim_bindings.Configuration: Get a copy of the subconfiguration with the given name.
def get_subconfig_keys(self, sorted: bool = False) -> typing.List[str]: Retrieves a list of the keys of this configuration’s subconfigurations, specifying whether the keys should be sorted or not
def get_task_link_markerset_points(self, taskset_name: str, linkset_name: str, markerset_name: str) -> typing.List[magnum.Vector3]: Get the marker points for the specified TaskSet’s specified LinkSet’s specified MarkerSet as a list of 3d points
def get_task_linkset_points(self, taskset_name: str, linkset_name: str) -> typing.Dict[str, typing.List[magnum.Vector3]]: Get the points in all the MarkerSets of the specified LinkSet, in the specified TaskSet, as a dictionary, keyed by each MarkerSet’s name and referencing a list of 3d points.
def get_taskset(self, taskset_name: str) -> habitat_sim._ext.habitat_sim_bindings.TaskSet: Get an editable reference to the specified TaskSet, possibly new and empty if it does not exist
def get_taskset_points(self, taskset_name: str) -> typing.Dict[str, typing.Dict[str, typing.List[magnum.Vector3]]]: Get all the marker points in the specified TaskSet as a dict of dicts. The format is a dictionary keyed by LinkSet name, of dictionaries, each keyed by MarkerSet name and referencing a list of 3d points
def get_type(self, arg0: str, /) -> habitat_sim._ext.habitat_sim_bindings.ConfigValType: Retrieves the ConfigValType of the value referred to by the passed key.
def has_key_to_type(self, key: str, value_type: habitat_sim._ext.habitat_sim_bindings.ConfigValType) -> bool: Returns whether passed key points to a value of specified ConfigValType
def has_subconfig(self, arg0: str, /) -> bool: Returns true if specified key references an existing subconfiguration within this configuration.
def has_task_link_markerset(self, taskset_name: str, linkset_name: str, markerset_name: str) -> bool: Whether or not a MarkerSet exists within an existing Linkset in an existing TaskSet with the given names
def has_task_linkset(self, taskset_name: str, linkset_name: str) -> bool: Whether or not a LinkSet with the given name within the TaskSet with the given name exists
def has_taskset(self, taskset_name: str) -> bool: Whether or not a TaskSet with the given name exists
def has_value(self, key: str) -> bool: Returns whether or not this Configuration has the passed key. Does not check subconfigurations.
def init(self, key: str, value: str) -> None: Initialize the value specified by given string key to be specified string value.
def init(self, key: str, value: bool) -> None: Initialize the value specified by given string key to be specified boolean value.
def init(self, key: str, value: int) -> None: Initialize the value specified by given string key to be specified integer value.
def init(self, key: str, value: float) -> None: Initialize the value specified by given string key to be specified floating-point value.
def init(self, key: str, value: magnum.Vector2) -> None: Initialize the value specified by given string key to be specified Magnum::Vector2 value.
def init(self, key: str, value: magnum.Vector2i) -> None: Initialize the value specified by given string key to be specified Magnum::Vector2i value.
def init(self, key: str, value: magnum.Vector3) -> None: Initialize the value specified by given string key to be specified Magnum::Vector3 value.
def init(self, key: str, value: magnum.Vector4) -> None: Initialize the value specified by given string key to be specified Magnum::Vector4 value.
def init(self, key: str, value: magnum.Color4) -> None: Initialize the value specified by given string key to be specified Magnum::Color4 value.
def init(self, key: str, value: magnum.Quaternion) -> None: Initialize the value specified by given string key to be specified Magnum::Quaternion value.
def init(self, key: str, value: magnum.Matrix3) -> None: Initialize the value specified by given string key to be specified Magnum::Matrix3 value.
def init(self, key: str, value: magnum.Matrix4) -> None: Initialize the value specified by given string key to be specified Magnum::Matrix4 value.
def init(self, key: str, value: magnum.Rad) -> None: Initialize the value specified by given string key to be specified Magnum::Rad value.
def init(self, key: str, value: magnum.Deg) -> None: Initialize the value specified by given string key to be specified Magnum::Deg value.
def init_task_link_markerset(self, taskset_name: str, linkset_name: str, markerset_name: str) -> None: Initialize a MarkerSet within a LinkSet within a new TaskSet with the given names in this collection
def remove(self, arg0: str, /) -> object: Retrieve and remove the requested value, if it exists
def remove_subconfig(self, arg0: str, /) -> habitat_sim._ext.habitat_sim_bindings.Configuration: Removes and returns subconfiguration corresponding to passed key, if found. Gives warning otherwise.
def save_subconfig(self, name: str, subconfig: habitat_sim._ext.habitat_sim_bindings.Configuration) -> None: Save a subconfiguration with the given name.
def set(self, key: str, value: str) -> None: Set the value specified by given string key to be specified string value.
def set(self, key: str, value: bool) -> None: Set the value specified by given string key to be specified boolean value.
def set(self, key: str, value: int) -> None: Set the value specified by given string key to be specified integer value.
def set(self, key: str, value: float) -> None: Set the value specified by given string key to be specified floating-point value.
def set(self, key: str, value: magnum.Vector2) -> None: Set the value specified by given string key to be specified Magnum::Vector2 value.
def set(self, key: str, value: magnum.Vector2i) -> None: Set the value specified by given string key to be specified Magnum::Vector2i value.
def set(self, key: str, value: magnum.Vector3) -> None: Set the value specified by given string key to be specified Magnum::Vector3 value.
def set(self, key: str, value: magnum.Vector4) -> None: Set the value specified by given string key to be specified Magnum::Vector4 value.
def set(self, key: str, value: magnum.Color4) -> None: Set the value specified by given string key to be specified Magnum::Color4 value.
def set(self, key: str, value: magnum.Quaternion) -> None: Set the value specified by given string key to be specified Magnum::Quaternion value.
def set(self, key: str, value: magnum.Matrix3) -> None: Set the value specified by given string key to be specified Magnum::Matrix3 value.
def set(self, key: str, value: magnum.Matrix4) -> None: Set the value specified by given string key to be specified Magnum::Matrix4 value.
def set(self, key: str, value: magnum.Rad) -> None: Set the value specified by given string key to be specified Magnum::Rad value.
def set(self, key: str, value: magnum.Deg) -> None: Set the value specified by given string key to be specified Magnum::Deg value.
def set_all_points(self, task_link_markerset_dict: typing.Dict[str, typing.Dict[str, typing.Dict[str, typing.List[magnum.Vector3]]]]) -> None: Set the marker points for every MarkerSet of every LinkSet of every TaskSet present to the values in the passed dict of dicts of dicts. The format should be dictionary, keyed by TaskSet name, of dictionaries, keyed by link name, of dictionary, each keyed by MarkerSet name and value being a list of that MarkerSet’s marker points. TaskSets, LinkSets and MarkerSet which are not referenced in the passed dict will remain untouched by this setter.
def set_task_link_markerset_points(self, taskset_name: str, linkset_name: str, markerset_name: str, marker_list: typing.List[magnum.Vector3]) -> None: Set the marker points for the specified TaskSet’s specified LinkSet’s specified MarkerSet to the given list of 3d points
def set_task_linkset_points(self, taskset_name: str, linkset_name: str, markerset_dict: typing.Dict[str, typing.List[magnum.Vector3]]) -> None: Set the points in all the MarkerSets of the specified LinkSet, in the specified TaskSet, to the given dictionary, keyed by each MarkerSet’s name and referencing a list of 3d points.
def set_taskset_points(self, taskset_name: str, link_markerset_dict: typing.Dict[str, typing.Dict[str, typing.List[magnum.Vector3]]]) -> None: Set all the marker points in the specified TaskSet to the 3d point values in the passed dict of dicts. The format should be a dictionary keyed by LinkSet name, of dictionaries, each keyed by MarkerSet name and referencing a list of 3d points

Special methods

def __init__(self, /) -> None
def __repr__(self, new_line: str = '\n') -> str

Properties

num_tasksets: int get: The current number of TaskSets present in the MarkerSets collection.
top_level_num_configs: int get: Holds the total number of subconfigs this Configuration holds at the base level (does not recurse subconfigs).
top_level_num_entries: int get: Holds the total number of values and subconfigs this Configuration holds at the base level (does not recurse subconfigs).
top_level_num_values: int get: Holds the total number of values this Configuration holds at the base level (does not recurse subconfigs).
total_num_configs: int get: Holds the total number of subconfigs this Configuration holds across all levels (recurses subconfigs).
total_num_entries: int get: Holds the total number of values and subconfigs this Configuration holds across all levels (recurses subconfigs).
total_num_values: int get: Holds the total number of values this Configuration holds across all levels (recurses subconfigs).