# fiftyone.core.threed.shape_3d Mesh definitions for 3D visualization. Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)

**Classes:** | [`Shape3D`](#fiftyone.core.threed.shape_3d.Shape3D)(name[, material, visible, position, ...]) | Represents an abstract 3D shape. | |-------------------------------------------------------------------------------------------------|------------------------------------| | [`BoxGeometry`](#fiftyone.core.threed.shape_3d.BoxGeometry)(name[, width, height, depth, ...]) | Represents a 3D box. | | [`CylinderGeometry`](#fiftyone.core.threed.shape_3d.CylinderGeometry)(name[, radius_top, ...]) | Represents a 3D cylinder. | | [`SphereGeometry`](#fiftyone.core.threed.shape_3d.SphereGeometry)(name[, radius, ...]) | Represents a 3D sphere. | | [`PlaneGeometry`](#fiftyone.core.threed.shape_3d.PlaneGeometry)(name[, width, height, ...]) | Represents a 3D plane. | ### *class* fiftyone.core.threed.shape_3d.Shape3D(name: str, material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial) | None = None, visible=True, position: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, scale: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, quaternion: [Quaternion](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Quaternion) | None = None) Bases: [`Mesh`](fiftyone.core.threed.mesh.md#fiftyone.core.threed.mesh.Mesh) Represents an abstract 3D shape. * **Parameters:** * **name** – the name of the mesh * **material** (`fiftyone.core.threed.MeshMaterial`, optional) – default material for the shape mesh. Defaults to [`fiftyone.core.threed.MeshStandardMaterial`](fiftyone.core.threed.md#fiftyone.core.threed.MeshStandardMaterial) if not provided * **visible** (*True*) – default visibility of the mesh in the scene * **position** (*None*) – the position of the mesh in object space * **quaternion** (*None*) – the quaternion of the mesh in object space * **scale** (*None*) – the scale of the mesh in object space **Methods:** | [`add`](#fiftyone.core.threed.shape_3d.Shape3D.add)(\*objs) | Add one or more objects as children of this one. | |----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | [`as_dict`](#fiftyone.core.threed.shape_3d.Shape3D.as_dict)() | Converts the object to a dict. | | [`clear`](#fiftyone.core.threed.shape_3d.Shape3D.clear)() | Remove all children from this object. | | [`find_and_execute`](#fiftyone.core.threed.shape_3d.Shape3D.find_and_execute)(node, predicate, on_match) | Recursively search the scene graph and execute an action on matching nodes. | | [`remove`](#fiftyone.core.threed.shape_3d.Shape3D.remove)(\*objs) | Remove one or more objects from the scene graph recursively. | | [`remove_by_name`](#fiftyone.core.threed.shape_3d.Shape3D.remove_by_name)(name) | Remove all objects with the given name from the scene graph recursively. | | [`remove_by_uuid`](#fiftyone.core.threed.shape_3d.Shape3D.remove_by_uuid)(target_uuid) | Remove the object with the given UUID from the scene graph recursively. | | [`set_default_material`](#fiftyone.core.threed.shape_3d.Shape3D.set_default_material)(material) | Sets the material of the mesh. | | [`traverse`](#fiftyone.core.threed.shape_3d.Shape3D.traverse)([include_self]) | Traverse the scene graph. | **Attributes:** | [`local_transform_matrix`](#fiftyone.core.threed.shape_3d.Shape3D.local_transform_matrix) | The local transform matrix of the object. | |---------------------------------------------------------------------------------------------|-----------------------------------------------| | [`position`](#fiftyone.core.threed.shape_3d.Shape3D.position) | The position of the object in object space. | | [`quaternion`](#fiftyone.core.threed.shape_3d.Shape3D.quaternion) | The quaternion of the object in object space. | | [`rotation`](#fiftyone.core.threed.shape_3d.Shape3D.rotation) | The rotation of the object in object space. | | [`scale`](#fiftyone.core.threed.shape_3d.Shape3D.scale) | The scale of the object in object space. | | [`uuid`](#fiftyone.core.threed.shape_3d.Shape3D.uuid) | The unique ID of the object. | #### add(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Add one or more objects as children of this one. #### as_dict() Converts the object to a dict. #### clear() → None Remove all children from this object. #### find_and_execute(node: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D), predicate, on_match, stop_on_first_match: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = False) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) Recursively search the scene graph and execute an action on matching nodes. This is a generic method for traversing the scene graph and performing operations on nodes that match a given predicate. It can be used for finding and removing nodes, collecting nodes, updating nodes, etc. The traversal continues into the subtrees of both matching and non-matching nodes. For matching nodes, the subtree is traversed when on_match returns True and stop_on_first_match is False. * **Parameters:** * **node** – the node to start searching from * **predicate** – a function that takes a child Object3D and returns * **criteria** (*True if it matches the search*) * **on_match** – a function called when a match is found, takes * **(****parent** * **searching** ([*child*](fiftyone.core.odm.md#fiftyone.core.odm.WorkspaceDocument.child) *)* *and returns True to continue*) * **to** (*False*) * **stop** * **stop_on_first_match** – if True, stop searching after first match * **processed** (*is*) * **Returns:** True if a match was found and we should stop, False otherwise ### Example # Find all nodes with a specific name and collect them matches = [] def predicate(child): > return child.name == “target” def on_match(parent, child): : matches.append(child) return True # continue searching scene.find_and_execute(scene, predicate, on_match) #### *property* local_transform_matrix The local transform matrix of the object. Setting this property also decomposes the matrix into its constituent position, quaternion, and scale components. However, decomposition of matrices with skew / shear components (non-uniform scaling) might have unexpected results. #### *property* position The position of the object in object space. #### *property* quaternion The quaternion of the object in object space. #### remove(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Remove one or more objects from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes any matching objects from their parent’s children list. * **Parameters:** **\*objs** – one or more Object3D instances to remove * **Raises:** * **ValueError** – if any of the objects to remove is this object itself * **ValueError** – if any of the objects is not found in the scene graph #### remove_by_name(name: str) → None Remove all objects with the given name from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes all objects matching the given name from their parent’s children lists. * **Parameters:** **name** – the name of the objects to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by name * **ValueError** – if no objects with the given name are found #### remove_by_uuid(target_uuid: str) → None Remove the object with the given UUID from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes the object matching the given UUID from its parent’s children list. UUIDs should be unique, so only one match is expected. * **Parameters:** **target_uuid** – the UUID of the object to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by UUID * **ValueError** – if no object with the given UUID is found #### *property* rotation The rotation of the object in object space. #### *property* scale The scale of the object in object space. #### set_default_material(material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) Sets the material of the mesh. * **Parameters:** **material** ([*MeshMaterial*](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) – the material to set as the default #### traverse(include_self=True) Traverse the scene graph. #### *property* uuid The unique ID of the object. ### *class* fiftyone.core.threed.shape_3d.BoxGeometry(name: str, width: float = 1, height: float = 1, depth: float = 1, default_material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial) | None = None, visible=True, position: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, scale: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, quaternion: [Quaternion](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Quaternion) | None = None) Bases: [`Shape3D`](#fiftyone.core.threed.shape_3d.Shape3D) Represents a 3D box. * **Parameters:** * **name** (*str*) – name of the box * **width** (*float*) – the width of the box. Defaults to 1 * **height** (*float*) – the height of the box. Defaults to 1 * **depth** (*float*) – the depth of the box. Defaults to 1 * **material** (`fiftyone.core.threed.MeshMaterial`, optional) – default material for the box. Defaults to [`fiftyone.core.threed.MeshStandardMaterial`](fiftyone.core.threed.md#fiftyone.core.threed.MeshStandardMaterial) * **visible** (*True*) – default visibility of the mesh in the scene * **position** (*None*) – the position of the mesh in object space * **quaternion** (*None*) – the quaternion of the mesh in object space * **scale** (*None*) – the scale of the mesh in object space **Methods:** | [`add`](#fiftyone.core.threed.shape_3d.BoxGeometry.add)(\*objs) | Add one or more objects as children of this one. | |--------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | [`as_dict`](#fiftyone.core.threed.shape_3d.BoxGeometry.as_dict)() | Converts the object to a dict. | | [`clear`](#fiftyone.core.threed.shape_3d.BoxGeometry.clear)() | Remove all children from this object. | | [`find_and_execute`](#fiftyone.core.threed.shape_3d.BoxGeometry.find_and_execute)(node, predicate, on_match) | Recursively search the scene graph and execute an action on matching nodes. | | [`remove`](#fiftyone.core.threed.shape_3d.BoxGeometry.remove)(\*objs) | Remove one or more objects from the scene graph recursively. | | [`remove_by_name`](#fiftyone.core.threed.shape_3d.BoxGeometry.remove_by_name)(name) | Remove all objects with the given name from the scene graph recursively. | | [`remove_by_uuid`](#fiftyone.core.threed.shape_3d.BoxGeometry.remove_by_uuid)(target_uuid) | Remove the object with the given UUID from the scene graph recursively. | | [`set_default_material`](#fiftyone.core.threed.shape_3d.BoxGeometry.set_default_material)(material) | Sets the material of the mesh. | | [`traverse`](#fiftyone.core.threed.shape_3d.BoxGeometry.traverse)([include_self]) | Traverse the scene graph. | **Attributes:** | [`local_transform_matrix`](#fiftyone.core.threed.shape_3d.BoxGeometry.local_transform_matrix) | The local transform matrix of the object. | |-------------------------------------------------------------------------------------------------|-----------------------------------------------| | [`position`](#fiftyone.core.threed.shape_3d.BoxGeometry.position) | The position of the object in object space. | | [`quaternion`](#fiftyone.core.threed.shape_3d.BoxGeometry.quaternion) | The quaternion of the object in object space. | | [`rotation`](#fiftyone.core.threed.shape_3d.BoxGeometry.rotation) | The rotation of the object in object space. | | [`scale`](#fiftyone.core.threed.shape_3d.BoxGeometry.scale) | The scale of the object in object space. | | [`uuid`](#fiftyone.core.threed.shape_3d.BoxGeometry.uuid) | The unique ID of the object. | #### add(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Add one or more objects as children of this one. #### as_dict() Converts the object to a dict. #### clear() → None Remove all children from this object. #### find_and_execute(node: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D), predicate, on_match, stop_on_first_match: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = False) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) Recursively search the scene graph and execute an action on matching nodes. This is a generic method for traversing the scene graph and performing operations on nodes that match a given predicate. It can be used for finding and removing nodes, collecting nodes, updating nodes, etc. The traversal continues into the subtrees of both matching and non-matching nodes. For matching nodes, the subtree is traversed when on_match returns True and stop_on_first_match is False. * **Parameters:** * **node** – the node to start searching from * **predicate** – a function that takes a child Object3D and returns * **criteria** (*True if it matches the search*) * **on_match** – a function called when a match is found, takes * **(****parent** * **searching** ([*child*](fiftyone.core.odm.md#fiftyone.core.odm.WorkspaceDocument.child) *)* *and returns True to continue*) * **to** (*False*) * **stop** * **stop_on_first_match** – if True, stop searching after first match * **processed** (*is*) * **Returns:** True if a match was found and we should stop, False otherwise ### Example # Find all nodes with a specific name and collect them matches = [] def predicate(child): > return child.name == “target” def on_match(parent, child): : matches.append(child) return True # continue searching scene.find_and_execute(scene, predicate, on_match) #### *property* local_transform_matrix The local transform matrix of the object. Setting this property also decomposes the matrix into its constituent position, quaternion, and scale components. However, decomposition of matrices with skew / shear components (non-uniform scaling) might have unexpected results. #### *property* position The position of the object in object space. #### *property* quaternion The quaternion of the object in object space. #### remove(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Remove one or more objects from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes any matching objects from their parent’s children list. * **Parameters:** **\*objs** – one or more Object3D instances to remove * **Raises:** * **ValueError** – if any of the objects to remove is this object itself * **ValueError** – if any of the objects is not found in the scene graph #### remove_by_name(name: str) → None Remove all objects with the given name from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes all objects matching the given name from their parent’s children lists. * **Parameters:** **name** – the name of the objects to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by name * **ValueError** – if no objects with the given name are found #### remove_by_uuid(target_uuid: str) → None Remove the object with the given UUID from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes the object matching the given UUID from its parent’s children list. UUIDs should be unique, so only one match is expected. * **Parameters:** **target_uuid** – the UUID of the object to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by UUID * **ValueError** – if no object with the given UUID is found #### *property* rotation The rotation of the object in object space. #### *property* scale The scale of the object in object space. #### set_default_material(material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) Sets the material of the mesh. * **Parameters:** **material** ([*MeshMaterial*](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) – the material to set as the default #### traverse(include_self=True) Traverse the scene graph. #### *property* uuid The unique ID of the object. ### *class* fiftyone.core.threed.shape_3d.CylinderGeometry(name: str, radius_top: float = 1, radius_bottom: float = 1, height: float = 1, radial_segments: int = 32, height_segments: int = 1, open_ended: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = False, theta_start: float = 0, theta_length: float = 6.283185307179586, default_material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial) | None = None, visible=True, position: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, scale: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, quaternion: [Quaternion](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Quaternion) | None = None) Bases: [`Shape3D`](#fiftyone.core.threed.shape_3d.Shape3D) Represents a 3D cylinder. * **Parameters:** * **name** (*str*) – name of the cylinder * **radius_top** (*float*) – the radius of the top of the cylinder. Defaults to 1 * **radius_bottom** (*float*) – the radius of the bottom of the cylinder. Defaults to 1 * **height** (*float*) – the height of the cylinder. Defaults to 1 * **radial_segments** (*int*) – number of segmented faces around the circumference of the cylinder. Defaults to 32 * **height_segments** (*int*) – number of rows of faces around the circumference of the cylinder. Defaults to 1 * **open_ended** ([*bool*](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)) – whether the cylinder is open-ended. Defaults to `False` * **theta_start** (*float*) – the start angle for the vertical sweep. Defaults to 0 * **theta_length** (*float*) – the angle for the vertical sweep. Defaults to 2\*Math.PI, which makes for a complete cylinder * **material** (`fiftyone.core.threed.MeshMaterial`, optional) – default material for the cylinder. Defaults to [`fiftyone.core.threed.MeshStandardMaterial`](fiftyone.core.threed.md#fiftyone.core.threed.MeshStandardMaterial) * **visible** (*True*) – default visibility of the mesh in the scene * **position** (*None*) – the position of the mesh in object space * **quaternion** (*None*) – the quaternion of the mesh in object space * **scale** (*None*) – the scale of the mesh in object space **Methods:** | [`add`](#fiftyone.core.threed.shape_3d.CylinderGeometry.add)(\*objs) | Add one or more objects as children of this one. | |-------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | [`as_dict`](#fiftyone.core.threed.shape_3d.CylinderGeometry.as_dict)() | Converts the object to a dict. | | [`clear`](#fiftyone.core.threed.shape_3d.CylinderGeometry.clear)() | Remove all children from this object. | | [`find_and_execute`](#fiftyone.core.threed.shape_3d.CylinderGeometry.find_and_execute)(node, predicate, on_match) | Recursively search the scene graph and execute an action on matching nodes. | | [`remove`](#fiftyone.core.threed.shape_3d.CylinderGeometry.remove)(\*objs) | Remove one or more objects from the scene graph recursively. | | [`remove_by_name`](#fiftyone.core.threed.shape_3d.CylinderGeometry.remove_by_name)(name) | Remove all objects with the given name from the scene graph recursively. | | [`remove_by_uuid`](#fiftyone.core.threed.shape_3d.CylinderGeometry.remove_by_uuid)(target_uuid) | Remove the object with the given UUID from the scene graph recursively. | | [`set_default_material`](#fiftyone.core.threed.shape_3d.CylinderGeometry.set_default_material)(material) | Sets the material of the mesh. | | [`traverse`](#fiftyone.core.threed.shape_3d.CylinderGeometry.traverse)([include_self]) | Traverse the scene graph. | **Attributes:** | [`local_transform_matrix`](#fiftyone.core.threed.shape_3d.CylinderGeometry.local_transform_matrix) | The local transform matrix of the object. | |------------------------------------------------------------------------------------------------------|-----------------------------------------------| | [`position`](#fiftyone.core.threed.shape_3d.CylinderGeometry.position) | The position of the object in object space. | | [`quaternion`](#fiftyone.core.threed.shape_3d.CylinderGeometry.quaternion) | The quaternion of the object in object space. | | [`rotation`](#fiftyone.core.threed.shape_3d.CylinderGeometry.rotation) | The rotation of the object in object space. | | [`scale`](#fiftyone.core.threed.shape_3d.CylinderGeometry.scale) | The scale of the object in object space. | | [`uuid`](#fiftyone.core.threed.shape_3d.CylinderGeometry.uuid) | The unique ID of the object. | #### add(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Add one or more objects as children of this one. #### as_dict() Converts the object to a dict. #### clear() → None Remove all children from this object. #### find_and_execute(node: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D), predicate, on_match, stop_on_first_match: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = False) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) Recursively search the scene graph and execute an action on matching nodes. This is a generic method for traversing the scene graph and performing operations on nodes that match a given predicate. It can be used for finding and removing nodes, collecting nodes, updating nodes, etc. The traversal continues into the subtrees of both matching and non-matching nodes. For matching nodes, the subtree is traversed when on_match returns True and stop_on_first_match is False. * **Parameters:** * **node** – the node to start searching from * **predicate** – a function that takes a child Object3D and returns * **criteria** (*True if it matches the search*) * **on_match** – a function called when a match is found, takes * **(****parent** * **searching** ([*child*](fiftyone.core.odm.md#fiftyone.core.odm.WorkspaceDocument.child) *)* *and returns True to continue*) * **to** (*False*) * **stop** * **stop_on_first_match** – if True, stop searching after first match * **processed** (*is*) * **Returns:** True if a match was found and we should stop, False otherwise ### Example # Find all nodes with a specific name and collect them matches = [] def predicate(child): > return child.name == “target” def on_match(parent, child): : matches.append(child) return True # continue searching scene.find_and_execute(scene, predicate, on_match) #### *property* local_transform_matrix The local transform matrix of the object. Setting this property also decomposes the matrix into its constituent position, quaternion, and scale components. However, decomposition of matrices with skew / shear components (non-uniform scaling) might have unexpected results. #### *property* position The position of the object in object space. #### *property* quaternion The quaternion of the object in object space. #### remove(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Remove one or more objects from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes any matching objects from their parent’s children list. * **Parameters:** **\*objs** – one or more Object3D instances to remove * **Raises:** * **ValueError** – if any of the objects to remove is this object itself * **ValueError** – if any of the objects is not found in the scene graph #### remove_by_name(name: str) → None Remove all objects with the given name from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes all objects matching the given name from their parent’s children lists. * **Parameters:** **name** – the name of the objects to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by name * **ValueError** – if no objects with the given name are found #### remove_by_uuid(target_uuid: str) → None Remove the object with the given UUID from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes the object matching the given UUID from its parent’s children list. UUIDs should be unique, so only one match is expected. * **Parameters:** **target_uuid** – the UUID of the object to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by UUID * **ValueError** – if no object with the given UUID is found #### *property* rotation The rotation of the object in object space. #### *property* scale The scale of the object in object space. #### set_default_material(material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) Sets the material of the mesh. * **Parameters:** **material** ([*MeshMaterial*](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) – the material to set as the default #### traverse(include_self=True) Traverse the scene graph. #### *property* uuid The unique ID of the object. ### *class* fiftyone.core.threed.shape_3d.SphereGeometry(name: str, radius: float = 1, width_segments: int = 32, height_segments: int = 16, phi_start: float = 0, phi_length: float = 6.283185307179586, theta_start: float = 0, theta_length: float = 3.141592653589793, default_material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial) | None = None, visible=True, position: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, scale: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, quaternion: [Quaternion](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Quaternion) | None = None) Bases: [`Shape3D`](#fiftyone.core.threed.shape_3d.Shape3D) Represents a 3D sphere. * **Parameters:** * **name** (*str*) – the name of the sphere * **radius** (*float*) – the radius of the sphere. Defaults to 1 * **width_segments** (*int*) – the number of segmented faces around the circumference of the sphere. Defaults to 32 * **height_segments** (*int*) – the number of rows of faces around the circumference of the sphere. Defaults to 16 * **phi_start** (*float*) – the start angle for the horizontal sweep. Defaults to 0 * **phi_length** (*float*) – the angle for the horizontal sweep. Defaults to `2*math.pi`, which makes for a complete sphere * **theta_start** (*float*) – the start angle for the vertical sweep. Defaults to 0 * **theta_length** (*float*) – the angle for the vertical sweep. Defaults to `math.pi`, which makes for a complete sphere * **material** (`fiftyone.core.threed.MeshMaterial`, optional) – the default material for the sphere. Defaults to [`fiftyone.core.threed.MeshStandardMaterial`](fiftyone.core.threed.md#fiftyone.core.threed.MeshStandardMaterial) * **visible** (*True*) – default visibility of the mesh in the scene * **position** (*None*) – the position of the mesh in object space * **quaternion** (*None*) – the quaternion of the mesh in object space * **scale** (*None*) – the scale of the mesh in object space **Methods:** | [`add`](#fiftyone.core.threed.shape_3d.SphereGeometry.add)(\*objs) | Add one or more objects as children of this one. | |-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | [`as_dict`](#fiftyone.core.threed.shape_3d.SphereGeometry.as_dict)() | Converts the object to a dict. | | [`clear`](#fiftyone.core.threed.shape_3d.SphereGeometry.clear)() | Remove all children from this object. | | [`find_and_execute`](#fiftyone.core.threed.shape_3d.SphereGeometry.find_and_execute)(node, predicate, on_match) | Recursively search the scene graph and execute an action on matching nodes. | | [`remove`](#fiftyone.core.threed.shape_3d.SphereGeometry.remove)(\*objs) | Remove one or more objects from the scene graph recursively. | | [`remove_by_name`](#fiftyone.core.threed.shape_3d.SphereGeometry.remove_by_name)(name) | Remove all objects with the given name from the scene graph recursively. | | [`remove_by_uuid`](#fiftyone.core.threed.shape_3d.SphereGeometry.remove_by_uuid)(target_uuid) | Remove the object with the given UUID from the scene graph recursively. | | [`set_default_material`](#fiftyone.core.threed.shape_3d.SphereGeometry.set_default_material)(material) | Sets the material of the mesh. | | [`traverse`](#fiftyone.core.threed.shape_3d.SphereGeometry.traverse)([include_self]) | Traverse the scene graph. | **Attributes:** | [`local_transform_matrix`](#fiftyone.core.threed.shape_3d.SphereGeometry.local_transform_matrix) | The local transform matrix of the object. | |----------------------------------------------------------------------------------------------------|-----------------------------------------------| | [`position`](#fiftyone.core.threed.shape_3d.SphereGeometry.position) | The position of the object in object space. | | [`quaternion`](#fiftyone.core.threed.shape_3d.SphereGeometry.quaternion) | The quaternion of the object in object space. | | [`rotation`](#fiftyone.core.threed.shape_3d.SphereGeometry.rotation) | The rotation of the object in object space. | | [`scale`](#fiftyone.core.threed.shape_3d.SphereGeometry.scale) | The scale of the object in object space. | | [`uuid`](#fiftyone.core.threed.shape_3d.SphereGeometry.uuid) | The unique ID of the object. | #### add(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Add one or more objects as children of this one. #### as_dict() Converts the object to a dict. #### clear() → None Remove all children from this object. #### find_and_execute(node: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D), predicate, on_match, stop_on_first_match: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = False) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) Recursively search the scene graph and execute an action on matching nodes. This is a generic method for traversing the scene graph and performing operations on nodes that match a given predicate. It can be used for finding and removing nodes, collecting nodes, updating nodes, etc. The traversal continues into the subtrees of both matching and non-matching nodes. For matching nodes, the subtree is traversed when on_match returns True and stop_on_first_match is False. * **Parameters:** * **node** – the node to start searching from * **predicate** – a function that takes a child Object3D and returns * **criteria** (*True if it matches the search*) * **on_match** – a function called when a match is found, takes * **(****parent** * **searching** ([*child*](fiftyone.core.odm.md#fiftyone.core.odm.WorkspaceDocument.child) *)* *and returns True to continue*) * **to** (*False*) * **stop** * **stop_on_first_match** – if True, stop searching after first match * **processed** (*is*) * **Returns:** True if a match was found and we should stop, False otherwise ### Example # Find all nodes with a specific name and collect them matches = [] def predicate(child): > return child.name == “target” def on_match(parent, child): : matches.append(child) return True # continue searching scene.find_and_execute(scene, predicate, on_match) #### *property* local_transform_matrix The local transform matrix of the object. Setting this property also decomposes the matrix into its constituent position, quaternion, and scale components. However, decomposition of matrices with skew / shear components (non-uniform scaling) might have unexpected results. #### *property* position The position of the object in object space. #### *property* quaternion The quaternion of the object in object space. #### remove(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Remove one or more objects from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes any matching objects from their parent’s children list. * **Parameters:** **\*objs** – one or more Object3D instances to remove * **Raises:** * **ValueError** – if any of the objects to remove is this object itself * **ValueError** – if any of the objects is not found in the scene graph #### remove_by_name(name: str) → None Remove all objects with the given name from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes all objects matching the given name from their parent’s children lists. * **Parameters:** **name** – the name of the objects to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by name * **ValueError** – if no objects with the given name are found #### remove_by_uuid(target_uuid: str) → None Remove the object with the given UUID from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes the object matching the given UUID from its parent’s children list. UUIDs should be unique, so only one match is expected. * **Parameters:** **target_uuid** – the UUID of the object to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by UUID * **ValueError** – if no object with the given UUID is found #### *property* rotation The rotation of the object in object space. #### *property* scale The scale of the object in object space. #### set_default_material(material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) Sets the material of the mesh. * **Parameters:** **material** ([*MeshMaterial*](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) – the material to set as the default #### traverse(include_self=True) Traverse the scene graph. #### *property* uuid The unique ID of the object. ### *class* fiftyone.core.threed.shape_3d.PlaneGeometry(name: str, width: float = 1, height: float = 1, default_material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial) | None = None, visible=True, position: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, scale: [Vector3](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Vector3) | List[float] | Tuple[float] | array | None = None, quaternion: [Quaternion](fiftyone.core.threed.transformation.md#fiftyone.core.threed.transformation.Quaternion) | None = None) Bases: [`Shape3D`](#fiftyone.core.threed.shape_3d.Shape3D) Represents a 3D plane. * **Parameters:** * **name** (*str*) – name of the plane * **width** (*float*) – the width of the plane. Defaults to 1 * **height** (*float*) – the height of the plane. Defaults to 1 * **material** (`fiftyone.core.threed.MeshMaterial`, optional) – the default material for the plane. Defaults to [`fiftyone.core.threed.MeshStandardMaterial`](fiftyone.core.threed.md#fiftyone.core.threed.MeshStandardMaterial) * **visible** (*True*) – default visibility of the mesh in the scene * **position** (*None*) – the position of the mesh in object space * **quaternion** (*None*) – the quaternion of the mesh in object space * **scale** (*None*) – the scale of the mesh in object space **Methods:** | [`add`](#fiftyone.core.threed.shape_3d.PlaneGeometry.add)(\*objs) | Add one or more objects as children of this one. | |----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | [`as_dict`](#fiftyone.core.threed.shape_3d.PlaneGeometry.as_dict)() | Converts the object to a dict. | | [`clear`](#fiftyone.core.threed.shape_3d.PlaneGeometry.clear)() | Remove all children from this object. | | [`find_and_execute`](#fiftyone.core.threed.shape_3d.PlaneGeometry.find_and_execute)(node, predicate, on_match) | Recursively search the scene graph and execute an action on matching nodes. | | [`remove`](#fiftyone.core.threed.shape_3d.PlaneGeometry.remove)(\*objs) | Remove one or more objects from the scene graph recursively. | | [`remove_by_name`](#fiftyone.core.threed.shape_3d.PlaneGeometry.remove_by_name)(name) | Remove all objects with the given name from the scene graph recursively. | | [`remove_by_uuid`](#fiftyone.core.threed.shape_3d.PlaneGeometry.remove_by_uuid)(target_uuid) | Remove the object with the given UUID from the scene graph recursively. | | [`set_default_material`](#fiftyone.core.threed.shape_3d.PlaneGeometry.set_default_material)(material) | Sets the material of the mesh. | | [`traverse`](#fiftyone.core.threed.shape_3d.PlaneGeometry.traverse)([include_self]) | Traverse the scene graph. | **Attributes:** | [`local_transform_matrix`](#fiftyone.core.threed.shape_3d.PlaneGeometry.local_transform_matrix) | The local transform matrix of the object. | |---------------------------------------------------------------------------------------------------|-----------------------------------------------| | [`position`](#fiftyone.core.threed.shape_3d.PlaneGeometry.position) | The position of the object in object space. | | [`quaternion`](#fiftyone.core.threed.shape_3d.PlaneGeometry.quaternion) | The quaternion of the object in object space. | | [`rotation`](#fiftyone.core.threed.shape_3d.PlaneGeometry.rotation) | The rotation of the object in object space. | | [`scale`](#fiftyone.core.threed.shape_3d.PlaneGeometry.scale) | The scale of the object in object space. | | [`uuid`](#fiftyone.core.threed.shape_3d.PlaneGeometry.uuid) | The unique ID of the object. | #### add(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Add one or more objects as children of this one. #### as_dict() Converts the object to a dict. #### clear() → None Remove all children from this object. #### find_and_execute(node: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D), predicate, on_match, stop_on_first_match: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = False) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) Recursively search the scene graph and execute an action on matching nodes. This is a generic method for traversing the scene graph and performing operations on nodes that match a given predicate. It can be used for finding and removing nodes, collecting nodes, updating nodes, etc. The traversal continues into the subtrees of both matching and non-matching nodes. For matching nodes, the subtree is traversed when on_match returns True and stop_on_first_match is False. * **Parameters:** * **node** – the node to start searching from * **predicate** – a function that takes a child Object3D and returns * **criteria** (*True if it matches the search*) * **on_match** – a function called when a match is found, takes * **(****parent** * **searching** ([*child*](fiftyone.core.odm.md#fiftyone.core.odm.WorkspaceDocument.child) *)* *and returns True to continue*) * **to** (*False*) * **stop** * **stop_on_first_match** – if True, stop searching after first match * **processed** (*is*) * **Returns:** True if a match was found and we should stop, False otherwise ### Example # Find all nodes with a specific name and collect them matches = [] def predicate(child): > return child.name == “target” def on_match(parent, child): : matches.append(child) return True # continue searching scene.find_and_execute(scene, predicate, on_match) #### *property* local_transform_matrix The local transform matrix of the object. Setting this property also decomposes the matrix into its constituent position, quaternion, and scale components. However, decomposition of matrices with skew / shear components (non-uniform scaling) might have unexpected results. #### *property* position The position of the object in object space. #### *property* quaternion The quaternion of the object in object space. #### remove(\*objs: [Object3D](fiftyone.core.threed.object_3d.md#fiftyone.core.threed.object_3d.Object3D)) → None Remove one or more objects from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes any matching objects from their parent’s children list. * **Parameters:** **\*objs** – one or more Object3D instances to remove * **Raises:** * **ValueError** – if any of the objects to remove is this object itself * **ValueError** – if any of the objects is not found in the scene graph #### remove_by_name(name: str) → None Remove all objects with the given name from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes all objects matching the given name from their parent’s children lists. * **Parameters:** **name** – the name of the objects to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by name * **ValueError** – if no objects with the given name are found #### remove_by_uuid(target_uuid: str) → None Remove the object with the given UUID from the scene graph recursively. This method searches recursively through the entire scene graph starting from this object and removes the object matching the given UUID from its parent’s children list. UUIDs should be unique, so only one match is expected. * **Parameters:** **target_uuid** – the UUID of the object to remove * **Raises:** * **ValueError** – if attempting to remove this object itself by UUID * **ValueError** – if no object with the given UUID is found #### *property* rotation The rotation of the object in object space. #### *property* scale The scale of the object in object space. #### set_default_material(material: [MeshMaterial](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) Sets the material of the mesh. * **Parameters:** **material** ([*MeshMaterial*](fiftyone.core.threed.material_3d.md#fiftyone.core.threed.material_3d.MeshMaterial)) – the material to set as the default #### traverse(include_self=True) Traverse the scene graph. #### *property* uuid The unique ID of the object.