Element¶
- class jacobi.Element¶
Bases:
pybind11_objectThe base element of a scene
The Element struct represents the base element of a scene, such as a robot, camera, or obstacle. It contains a name, pose, and tags that can be used to identify and categorize the element.
- __init__(*args, **kwargs)¶
- get_parameter(self: Element, tag: str) str | None¶
Reads the value of a tag parameter param=value. Tags are case- insensitive.
- Parameter
tag: The tag to read the parameter from.
- Returns:
std::optional<std::string> The value of the parameter if it exists, std::nullopt otherwise.
- Parameter
- has_tag(self: Element, tag: str) bool¶
Checks whether a tag is present on the element. Tags are case- insensitive.
- Parameter
tag: The tag to check for.
- Returns:
bool True if the tag is present, false otherwise.
- Parameter
- property name¶
The unique name of the element, for display and identification.
- property origin¶
Pose of the element, relative to the parent. Is called “base” for robots in Studio.
- property tags¶
Given tags of the element, might be with a parameter param=value.