py3dframe.FrameTree.disconnect_frame#

FrameTree.disconnect_frame(name, recursive=True)[source]#

Remove a Frame from the FrameTree.

The frame is removed from the FrameTree and its parent is set to None.

See also

FrameTree.connect_frame() : Add a frame to the FrameTree.

Warning

The root frame (Canonical frame of \(\mathcal{R}^3\)) cannot be removed from the FrameTree.

Parameters:

name (str) – The name of the frame to remove.
recursive (bool, optional) – If True, all child frames of the specified frame are also removed recursively. If False, the child frames are not removed and will have their parent set to the parent of the removed frame. Default is True.

Return type:

None