[User] How do I use FunctionNodeInvertMatrix(FunctionNode) in Blender? Include parameters, examples, warnings and best practices.

[Assistant]
# FunctionNodeInvertMatrix(FunctionNode)

base classes — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct"), [`Node`](bpy.types.Node.html#bpy.types.Node "bpy.types.Node"), [`NodeInternal`](bpy.types.NodeInternal.html#bpy.types.NodeInternal "bpy.types.NodeInternal"), [`FunctionNode`](bpy.types.FunctionNode.html#bpy.types.FunctionNode "bpy.types.FunctionNode")

*class* bpy.types.FunctionNodeInvertMatrix(*FunctionNode*)
:   Compute the inverse of the given matrix, if one exists

    *classmethod* is_registered_node_type()
    :   True if a registered node type

        Returns:
        :   Result

        Return type:
        :   boolean

    *classmethod* input_template(*index*)
    :   Input socket template

        Parameters:
        :   **index** (*int in* *[**0**,* *inf**]*) – Index

        Returns:
        :   result

        Return type:
        :   [`NodeInternalSocketTemplate`](bpy.types.NodeInternalSocketTemplate.html#bpy.types.NodeInternalSocketTemplate "bpy.types.NodeInternalSocketTemplate")

    *classmethod* output_template(*index*)
    :   Output socket template

        Parameters:
        :   **index** (*int in* *[**0**,* *inf**]*) – Index

        Returns:
        :   result

        Return type:
        :   [`NodeInternalSocketTemplate`](bpy.types.NodeInternalSocketTemplate.html#bpy.types.NodeInternalSocketTemplate "bpy.types.NodeInternalSocketTemplate")

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type


[User] Provide the full official documentation entry for Inherited Functions, preserving all code examples.

[Assistant]
|  |  |
| --- | --- |
| - [`bpy_struct.as_pointer`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.as_pointer "bpy.types.bpy_struct.as_pointer") - [`bpy_struct.driver_add`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_add "bpy.types.bpy_struct.driver_add") - [`bpy_struct.driver_remove`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_remove "bpy.types.bpy_struct.driver_remove") - [`bpy_struct.get`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.get "bpy.types.bpy_struct.get") - [`bpy_struct.id_properties_clear`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_clear "bpy.types.bpy_struct.id_properties_clear") - [`bpy_struct.id_properties_ensure`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ensure "bpy.types.bpy_struct.id_properties_ensure") - [`bpy_struct.id_properties_ui`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ui "bpy.types.bpy_struct.id_properties_ui") - [`bpy_struct.is_property_hidden`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_hidden "bpy.types.bpy_struct.is_property_hidden") - [`bpy_struct.is_property_overridable_library`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_overridable_library "bpy.types.bpy_struct.is_property_overridable_library") - [`bpy_struct.is_property_readonly`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_readonly "bpy.types.bpy_struct.is_property_readonly") - [`bpy_struct.is_property_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_set "bpy.types.bpy_struct.is_property_set") - [`bpy_struct.items`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.items "bpy.types.bpy_struct.items") - [`bpy_struct.keyframe_delete`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_delete "bpy.types.bpy_struct.keyframe_delete") - [`bpy_struct.keyframe_insert`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert "bpy.types.bpy_struct.keyframe_insert") - [`bpy_struct.keys`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keys "bpy.types.bpy_struct.keys") - [`bpy_struct.path_from_id`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id "bpy.types.bpy_struct.path_from_id") - [`bpy_struct.path_from_module`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_module "bpy.types.bpy_struct.path_from_module") - [`bpy_struct.path_resolve`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_resolve "bpy.types.bpy_struct.path_resolve") - [`bpy_struct.pop`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.pop "bpy.types.bpy_struct.pop") - [`bpy_struct.property_overridable_library_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_overridable_library_set "bpy.types.bpy_struct.property_overridable_library_set") - [`bpy_struct.property_unset`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_unset "bpy.types.bpy_struct.property_unset") - [`bpy_struct.rna_ancestors`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.rna_ancestors "bpy.types.bpy_struct.rna_ancestors") - [`bpy_struct.type_recast`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.type_recast "bpy.types.bpy_struct.type_recast") - [`bpy_struct.values`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.values "bpy.types.bpy_struct.values") - [`Node.bl_system_properties_get`](bpy.types.Node.html#bpy.types.Node.bl_system_properties_get "bpy.types.Node.bl_system_properties_get") - [`Node.socket_value_update`](bpy.types.Node.html#bpy.types.Node.socket_value_update "bpy.types.Node.socket_value_update") | - [`Node.is_registered_node_type`](bpy.types.Node.html#bpy.types.Node.is_registered_node_type "bpy.types.Node.is_registered_node_type") - [`Node.poll`](bpy.types.Node.html#bpy.types.Node.poll "bpy.types.Node.poll") - [`Node.poll_instance`](bpy.types.Node.html#bpy.types.Node.poll_instance "bpy.types.Node.poll_instance") - [`Node.update`](bpy.types.Node.html#bpy.types.Node.update "bpy.types.Node.update") - [`Node.insert_link`](bpy.types.Node.html#bpy.types.Node.insert_link "bpy.types.Node.insert_link") - [`Node.init`](bpy.types.Node.html#bpy.types.Node.init "bpy.types.Node.init") - [`Node.copy`](bpy.types.Node.html#bpy.types.Node.copy "bpy.types.Node.copy") - [`Node.free`](bpy.types.Node.html#bpy.types.Node.free "bpy.types.Node.free") - [`Node.draw_buttons`](bpy.types.Node.html#bpy.types.Node.draw_buttons "bpy.types.Node.draw_buttons") - [`Node.draw_buttons_ext`](bpy.types.Node.html#bpy.types.Node.draw_buttons_ext "bpy.types.Node.draw_buttons_ext") - [`Node.draw_label`](bpy.types.Node.html#bpy.types.Node.draw_label "bpy.types.Node.draw_label") - [`Node.debug_zone_body_lazy_function_graph`](bpy.types.Node.html#bpy.types.Node.debug_zone_body_lazy_function_graph "bpy.types.Node.debug_zone_body_lazy_function_graph") - [`Node.debug_zone_lazy_function_graph`](bpy.types.Node.html#bpy.types.Node.debug_zone_lazy_function_graph "bpy.types.Node.debug_zone_lazy_function_graph") - [`Node.poll`](bpy.types.Node.html#bpy.types.Node.poll "bpy.types.Node.poll") - [`Node.bl_rna_get_subclass`](bpy.types.Node.html#bpy.types.Node.bl_rna_get_subclass "bpy.types.Node.bl_rna_get_subclass") - [`Node.bl_rna_get_subclass_py`](bpy.types.Node.html#bpy.types.Node.bl_rna_get_subclass_py "bpy.types.Node.bl_rna_get_subclass_py") - [`NodeInternal.poll`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.poll "bpy.types.NodeInternal.poll") - [`NodeInternal.poll_instance`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.poll_instance "bpy.types.NodeInternal.poll_instance") - [`NodeInternal.update`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.update "bpy.types.NodeInternal.update") - [`NodeInternal.draw_buttons`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.draw_buttons "bpy.types.NodeInternal.draw_buttons") - [`NodeInternal.draw_buttons_ext`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.draw_buttons_ext "bpy.types.NodeInternal.draw_buttons_ext") - [`NodeInternal.bl_rna_get_subclass`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.bl_rna_get_subclass "bpy.types.NodeInternal.bl_rna_get_subclass") - [`NodeInternal.bl_rna_get_subclass_py`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.bl_rna_get_subclass_py "bpy.types.NodeInternal.bl_rna_get_subclass_py") - [`FunctionNode.bl_rna_get_subclass`](bpy.types.FunctionNode.html#bpy.types.FunctionNode.bl_rna_get_subclass "bpy.types.FunctionNode.bl_rna_get_subclass") - [`FunctionNode.bl_rna_get_subclass_py`](bpy.types.FunctionNode.html#bpy.types.FunctionNode.bl_rna_get_subclass_py "bpy.types.FunctionNode.bl_rna_get_subclass_py") |


[User] Describe Inherited Functions from the Blender manual or Python API, including usage steps and snippets.

[Assistant]
|  |  |
| --- | --- |
| - [`bpy_struct.as_pointer`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.as_pointer "bpy.types.bpy_struct.as_pointer") - [`bpy_struct.driver_add`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_add "bpy.types.bpy_struct.driver_add") - [`bpy_struct.driver_remove`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_remove "bpy.types.bpy_struct.driver_remove") - [`bpy_struct.get`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.get "bpy.types.bpy_struct.get") - [`bpy_struct.id_properties_clear`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_clear "bpy.types.bpy_struct.id_properties_clear") - [`bpy_struct.id_properties_ensure`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ensure "bpy.types.bpy_struct.id_properties_ensure") - [`bpy_struct.id_properties_ui`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ui "bpy.types.bpy_struct.id_properties_ui") - [`bpy_struct.is_property_hidden`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_hidden "bpy.types.bpy_struct.is_property_hidden") - [`bpy_struct.is_property_overridable_library`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_overridable_library "bpy.types.bpy_struct.is_property_overridable_library") - [`bpy_struct.is_property_readonly`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_readonly "bpy.types.bpy_struct.is_property_readonly") - [`bpy_struct.is_property_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_set "bpy.types.bpy_struct.is_property_set") - [`bpy_struct.items`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.items "bpy.types.bpy_struct.items") | - [`bpy_struct.keyframe_delete`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_delete "bpy.types.bpy_struct.keyframe_delete") - [`bpy_struct.keyframe_insert`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert "bpy.types.bpy_struct.keyframe_insert") - [`bpy_struct.keys`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keys "bpy.types.bpy_struct.keys") - [`bpy_struct.path_from_id`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id "bpy.types.bpy_struct.path_from_id") - [`bpy_struct.path_from_module`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_module "bpy.types.bpy_struct.path_from_module") - [`bpy_struct.path_resolve`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_resolve "bpy.types.bpy_struct.path_resolve") - [`bpy_struct.pop`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.pop "bpy.types.bpy_struct.pop") - [`bpy_struct.property_overridable_library_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_overridable_library_set "bpy.types.bpy_struct.property_overridable_library_set") - [`bpy_struct.property_unset`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_unset "bpy.types.bpy_struct.property_unset") - [`bpy_struct.rna_ancestors`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.rna_ancestors "bpy.types.bpy_struct.rna_ancestors") - [`bpy_struct.type_recast`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.type_recast "bpy.types.bpy_struct.type_recast") - [`bpy_struct.values`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.values "bpy.types.bpy_struct.values") |


[User] Show practical ways to work with Inherited Functions in a Blender add-on or script – include code.

[Assistant]
|  |  |
| --- | --- |
| - [`bpy_struct.as_pointer`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.as_pointer "bpy.types.bpy_struct.as_pointer") - [`bpy_struct.driver_add`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_add "bpy.types.bpy_struct.driver_add") - [`bpy_struct.driver_remove`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_remove "bpy.types.bpy_struct.driver_remove") - [`bpy_struct.get`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.get "bpy.types.bpy_struct.get") - [`bpy_struct.id_properties_clear`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_clear "bpy.types.bpy_struct.id_properties_clear") - [`bpy_struct.id_properties_ensure`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ensure "bpy.types.bpy_struct.id_properties_ensure") - [`bpy_struct.id_properties_ui`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ui "bpy.types.bpy_struct.id_properties_ui") - [`bpy_struct.is_property_hidden`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_hidden "bpy.types.bpy_struct.is_property_hidden") - [`bpy_struct.is_property_overridable_library`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_overridable_library "bpy.types.bpy_struct.is_property_overridable_library") - [`bpy_struct.is_property_readonly`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_readonly "bpy.types.bpy_struct.is_property_readonly") - [`bpy_struct.is_property_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_set "bpy.types.bpy_struct.is_property_set") - [`bpy_struct.items`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.items "bpy.types.bpy_struct.items") - [`bpy_struct.keyframe_delete`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_delete "bpy.types.bpy_struct.keyframe_delete") - [`bpy_struct.keyframe_insert`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert "bpy.types.bpy_struct.keyframe_insert") - [`bpy_struct.keys`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keys "bpy.types.bpy_struct.keys") - [`bpy_struct.path_from_id`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id "bpy.types.bpy_struct.path_from_id") - [`bpy_struct.path_from_module`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_module "bpy.types.bpy_struct.path_from_module") - [`bpy_struct.path_resolve`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_resolve "bpy.types.bpy_struct.path_resolve") - [`bpy_struct.pop`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.pop "bpy.types.bpy_struct.pop") - [`bpy_struct.property_overridable_library_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_overridable_library_set "bpy.types.bpy_struct.property_overridable_library_set") - [`bpy_struct.property_unset`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_unset "bpy.types.bpy_struct.property_unset") - [`bpy_struct.rna_ancestors`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.rna_ancestors "bpy.types.bpy_struct.rna_ancestors") - [`bpy_struct.type_recast`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.type_recast "bpy.types.bpy_struct.type_recast") - [`bpy_struct.values`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.values "bpy.types.bpy_struct.values") - [`Node.bl_system_properties_get`](bpy.types.Node.html#bpy.types.Node.bl_system_properties_get "bpy.types.Node.bl_system_properties_get") - [`Node.socket_value_update`](bpy.types.Node.html#bpy.types.Node.socket_value_update "bpy.types.Node.socket_value_update") | - [`Node.is_registered_node_type`](bpy.types.Node.html#bpy.types.Node.is_registered_node_type "bpy.types.Node.is_registered_node_type") - [`Node.poll`](bpy.types.Node.html#bpy.types.Node.poll "bpy.types.Node.poll") - [`Node.poll_instance`](bpy.types.Node.html#bpy.types.Node.poll_instance "bpy.types.Node.poll_instance") - [`Node.update`](bpy.types.Node.html#bpy.types.Node.update "bpy.types.Node.update") - [`Node.insert_link`](bpy.types.Node.html#bpy.types.Node.insert_link "bpy.types.Node.insert_link") - [`Node.init`](bpy.types.Node.html#bpy.types.Node.init "bpy.types.Node.init") - [`Node.copy`](bpy.types.Node.html#bpy.types.Node.copy "bpy.types.Node.copy") - [`Node.free`](bpy.types.Node.html#bpy.types.Node.free "bpy.types.Node.free") - [`Node.draw_buttons`](bpy.types.Node.html#bpy.types.Node.draw_buttons "bpy.types.Node.draw_buttons") - [`Node.draw_buttons_ext`](bpy.types.Node.html#bpy.types.Node.draw_buttons_ext "bpy.types.Node.draw_buttons_ext") - [`Node.draw_label`](bpy.types.Node.html#bpy.types.Node.draw_label "bpy.types.Node.draw_label") - [`Node.debug_zone_body_lazy_function_graph`](bpy.types.Node.html#bpy.types.Node.debug_zone_body_lazy_function_graph "bpy.types.Node.debug_zone_body_lazy_function_graph") - [`Node.debug_zone_lazy_function_graph`](bpy.types.Node.html#bpy.types.Node.debug_zone_lazy_function_graph "bpy.types.Node.debug_zone_lazy_function_graph") - [`Node.poll`](bpy.types.Node.html#bpy.types.Node.poll "bpy.types.Node.poll") - [`Node.bl_rna_get_subclass`](bpy.types.Node.html#bpy.types.Node.bl_rna_get_subclass "bpy.types.Node.bl_rna_get_subclass") - [`Node.bl_rna_get_subclass_py`](bpy.types.Node.html#bpy.types.Node.bl_rna_get_subclass_py "bpy.types.Node.bl_rna_get_subclass_py") - [`NodeInternal.poll`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.poll "bpy.types.NodeInternal.poll") - [`NodeInternal.poll_instance`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.poll_instance "bpy.types.NodeInternal.poll_instance") - [`NodeInternal.update`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.update "bpy.types.NodeInternal.update") - [`NodeInternal.draw_buttons`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.draw_buttons "bpy.types.NodeInternal.draw_buttons") - [`NodeInternal.draw_buttons_ext`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.draw_buttons_ext "bpy.types.NodeInternal.draw_buttons_ext") - [`NodeInternal.bl_rna_get_subclass`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.bl_rna_get_subclass "bpy.types.NodeInternal.bl_rna_get_subclass") - [`NodeInternal.bl_rna_get_subclass_py`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.bl_rna_get_subclass_py "bpy.types.NodeInternal.bl_rna_get_subclass_py") - `GeometryNode.poll` - [`GeometryNode.bl_rna_get_subclass`](bpy.types.GeometryNode.html#bpy.types.GeometryNode.bl_rna_get_subclass "bpy.types.GeometryNode.bl_rna_get_subclass") - [`GeometryNode.bl_rna_get_subclass_py`](bpy.types.GeometryNode.html#bpy.types.GeometryNode.bl_rna_get_subclass_py "bpy.types.GeometryNode.bl_rna_get_subclass_py") |


[User] Give a detailed overview of Inputs: syntax, arguments, return values, common patterns.

[Assistant]
Vector
:   Vector of the input system that is to be divided into radial segments.

Sides
:   Number of radial segments to divide the input coordinate system into.
    A non-integer value results in an irregular segment that is smaller than the regular segments.

    |  |  |  |  |
    | --- | --- | --- | --- |
    | ../../../../_images/render_shader-nodes_radial_tiling_segments-5_0.png   Sides: 5.0. | ../../../../_images/render_shader-nodes_radial_tiling_segments-5_25.png   Sides: 5.25. | ../../../../_images/render_shader-nodes_radial_tiling_segments-5_5.png   Sides: 5.5. | ../../../../_images/render_shader-nodes_radial_tiling_segments-6_0.png   Sides: 6.0. |

Roundness
:   Roundness of the segment coordinate systems.

    |  |  |  |  |
    | --- | --- | --- | --- |
    | ../../../../_images/render_shader-nodes_radial_tiling_roundness-0_0.png   Roundness: 0.0. | ../../../../_images/render_shader-nodes_radial_tiling_roundness-0_25.png   Roundness: 0.25. | ../../../../_images/render_shader-nodes_radial_tiling_roundness-0_5.png   Roundness: 0.5. | ../../../../_images/render_shader-nodes_radial_tiling_roundness-1_0.png   Roundness: 1.0. |


[User] What is Inherited Functions and how is it used in Blender Python scripting?

[Assistant]
|  |  |
| --- | --- |
| - [`bpy_struct.as_pointer`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.as_pointer "bpy.types.bpy_struct.as_pointer") - [`bpy_struct.driver_add`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_add "bpy.types.bpy_struct.driver_add") - [`bpy_struct.driver_remove`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_remove "bpy.types.bpy_struct.driver_remove") - [`bpy_struct.get`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.get "bpy.types.bpy_struct.get") - [`bpy_struct.id_properties_clear`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_clear "bpy.types.bpy_struct.id_properties_clear") - [`bpy_struct.id_properties_ensure`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ensure "bpy.types.bpy_struct.id_properties_ensure") - [`bpy_struct.id_properties_ui`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ui "bpy.types.bpy_struct.id_properties_ui") - [`bpy_struct.is_property_hidden`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_hidden "bpy.types.bpy_struct.is_property_hidden") - [`bpy_struct.is_property_overridable_library`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_overridable_library "bpy.types.bpy_struct.is_property_overridable_library") - [`bpy_struct.is_property_readonly`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_readonly "bpy.types.bpy_struct.is_property_readonly") - [`bpy_struct.is_property_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_set "bpy.types.bpy_struct.is_property_set") - [`bpy_struct.items`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.items "bpy.types.bpy_struct.items") - [`bpy_struct.keyframe_delete`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_delete "bpy.types.bpy_struct.keyframe_delete") - [`bpy_struct.keyframe_insert`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert "bpy.types.bpy_struct.keyframe_insert") - [`bpy_struct.keys`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keys "bpy.types.bpy_struct.keys") - [`bpy_struct.path_from_id`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id "bpy.types.bpy_struct.path_from_id") - [`bpy_struct.path_from_module`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_module "bpy.types.bpy_struct.path_from_module") - [`bpy_struct.path_resolve`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_resolve "bpy.types.bpy_struct.path_resolve") - [`bpy_struct.pop`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.pop "bpy.types.bpy_struct.pop") - [`bpy_struct.property_overridable_library_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_overridable_library_set "bpy.types.bpy_struct.property_overridable_library_set") - [`bpy_struct.property_unset`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_unset "bpy.types.bpy_struct.property_unset") - [`bpy_struct.rna_ancestors`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.rna_ancestors "bpy.types.bpy_struct.rna_ancestors") | - [`bpy_struct.type_recast`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.type_recast "bpy.types.bpy_struct.type_recast") - [`bpy_struct.values`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.values "bpy.types.bpy_struct.values") - [`ID.bl_system_properties_get`](bpy.types.ID.html#bpy.types.ID.bl_system_properties_get "bpy.types.ID.bl_system_properties_get") - [`ID.rename`](bpy.types.ID.html#bpy.types.ID.rename "bpy.types.ID.rename") - [`ID.evaluated_get`](bpy.types.ID.html#bpy.types.ID.evaluated_get "bpy.types.ID.evaluated_get") - [`ID.copy`](bpy.types.ID.html#bpy.types.ID.copy "bpy.types.ID.copy") - [`ID.asset_mark`](bpy.types.ID.html#bpy.types.ID.asset_mark "bpy.types.ID.asset_mark") - [`ID.asset_clear`](bpy.types.ID.html#bpy.types.ID.asset_clear "bpy.types.ID.asset_clear") - [`ID.asset_generate_preview`](bpy.types.ID.html#bpy.types.ID.asset_generate_preview "bpy.types.ID.asset_generate_preview") - [`ID.override_create`](bpy.types.ID.html#bpy.types.ID.override_create "bpy.types.ID.override_create") - [`ID.override_hierarchy_create`](bpy.types.ID.html#bpy.types.ID.override_hierarchy_create "bpy.types.ID.override_hierarchy_create") - [`ID.user_clear`](bpy.types.ID.html#bpy.types.ID.user_clear "bpy.types.ID.user_clear") - [`ID.user_remap`](bpy.types.ID.html#bpy.types.ID.user_remap "bpy.types.ID.user_remap") - [`ID.make_local`](bpy.types.ID.html#bpy.types.ID.make_local "bpy.types.ID.make_local") - [`ID.user_of_id`](bpy.types.ID.html#bpy.types.ID.user_of_id "bpy.types.ID.user_of_id") - [`ID.animation_data_create`](bpy.types.ID.html#bpy.types.ID.animation_data_create "bpy.types.ID.animation_data_create") - [`ID.animation_data_clear`](bpy.types.ID.html#bpy.types.ID.animation_data_clear "bpy.types.ID.animation_data_clear") - [`ID.update_tag`](bpy.types.ID.html#bpy.types.ID.update_tag "bpy.types.ID.update_tag") - [`ID.preview_ensure`](bpy.types.ID.html#bpy.types.ID.preview_ensure "bpy.types.ID.preview_ensure") - [`ID.bl_rna_get_subclass`](bpy.types.ID.html#bpy.types.ID.bl_rna_get_subclass "bpy.types.ID.bl_rna_get_subclass") - [`ID.bl_rna_get_subclass_py`](bpy.types.ID.html#bpy.types.ID.bl_rna_get_subclass_py "bpy.types.ID.bl_rna_get_subclass_py") |


[User] How do I use Object Operators in Blender? Include parameters, examples, warnings and best practices.

[Assistant]
umber to remove

bpy.ops.object.instance_offset_from_cursor()
:   Set offset used for collection instances based on cursor position

    File:
    :   [startup/bl_operators/object.py:914](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L914)

bpy.ops.object.instance_offset_from_object()
:   Set offset used for collection instances based on the active object position

    File:
    :   [startup/bl_operators/object.py:946](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L946)

bpy.ops.object.instance_offset_to_cursor()
:   Set cursor position to the offset used for collection instances

    File:
    :   [startup/bl_operators/object.py:929](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L929)

bpy.ops.object.isolate_type_render()
:   Hide unselected render objects of same type as active by setting the hide render flag

    File:
    :   [startup/bl_operators/object.py:709](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L709)

bpy.ops.object.join()
:   Join selected objects into active object

bpy.ops.object.join_shapes(*\**, *use_mirror=False*)
:   Add the vertex positions of selected objects as shape keys or update existing shape keys with matching names

    Parameters:
    :   **use_mirror** (*boolean**,* *(**optional**)*) – Mirror, Mirror the new shape key values

bpy.ops.object.join_uvs()
:   Transfer UV Maps from active to selected objects (needs matching geometry)

    File:
    :   [startup/bl_operators/object.py:610](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L610)

bpy.ops.object.laplaciandeform_bind(*\**, *modifier=''*)
:   Bind mesh to system in laplacian deform modifier

    Parameters:
    :   **modifier** (*string**,* *(**optional**,* *never None**)*) – Modifier, Name of the modifier to edit

bpy.ops.object.lattice_add_to_selected(*\**, *fit_to_selected=True*, *radius=1.0*, *margin=0.0*, *add_modifiers=True*, *resolution_u=2*, *resolution_v=2*, *resolution_w=2*, *enter_editmode=False*, *align='WORLD'*, *location=(0.0, 0.0, 0.0)*, *rotation=(0.0, 0.0, 0.0)*, *scale=(0.0, 0.0, 0.0)*)
:   Add a lattice and use it to deform selected objects

    Parameters:
    :   - **fit_to_selected** (*boolean**,* *(**optional**)*) – Fit to Selected, Resize lattice to fit selected deformable objects
        - **radius** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Radius
        - **margin** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Margin, Add margin to lattice dimensions
        - **add_modifiers** (*boolean**,* *(**optional**)*) – Add Modifiers, Automatically add lattice modifiers to selected objects
        - **resolution_u** (*int in* *[**1**,* *64**]**,* *(**optional**)*) – Resolution U, Lattice resolution in U direction
        - **resolution_v** (*int in* *[**1**,* *64**]**,* *(**optional**)*) – V, Lattice resolution in V direction
        - **resolution_w** (*int in* *[**1**,* *64**]**,* *(**optional**)*) – W, Lattice resolution in W direction
        - **enter_editmode** (*boolean**,* *(**optional**)*) – Enter Edit Mode, Enter edit mode when adding this object
        - **align** (enum in [`'WORLD'`, `'VIEW'`, `'CURSOR'`], (optional)) –

          Align, The alignment of the new object

          - `WORLD`
            World – Align the new object to the world.
          - `VIEW`
            View – Align the new object to the view.
          - `CURSOR`
            3D Cursor – Use the 3D cursor orientation for the new object.
        - **location** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object
        - **rotation** ([`mathutils.Euler`](mathutils.html#mathutils.Euler "mathutils.Euler") rotation of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
        - **scale** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale, Scale for the newly added object

bpy.ops.object.light_add(*\**, *type='POINT'*, *radius=1.0*, *align='WORLD'*, *location=(0.0, 0.0, 0.0)*, *rotation=(0.0, 0.0, 0.0)*, *scale=(0.0, 0.0, 0.0)*)
:   Add a light object to the scene

    Parameters:
    :   - **type** (enum in [Light Type Items](bpy_types_enum_items/light_type_items.html#rna-enum-light-type-items), (optional)) – Type
        - **radius** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Radius
        - **align** (enum in [`'WORLD'`, `'VIEW'`, `'CURSOR'`], (optional)) –

          Align, The alignment of the new object

          - `WORLD`
            World – Align the new object to the world.
          - `VIEW`
            View – Align the new object to the view.
          - `CURSOR`
            3D Cursor – Use the 3D cursor orientation for the new object.
        - **location** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object
        - **rotation** ([`mathutils.Euler`](mathutils.html#mathutils.Euler "mathutils.Euler") rotation of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
        - **scale** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale, Scale for the newly added object

bpy.ops.object.light_linking_blocker_collection_new()
:   Create new light linking collection used by the active emitter

bpy.ops.object.light_linking_blockers_link(*\**, *link_state='INCLUDE'*)
:   Light link selected blockers to the active emitter object

    Parameters:
    :   **link_state** (enum in [`'INCLUDE'`, `'EXCLUDE'`], (optional)) –

        Link State, State of the shadow linking

        - `INCLUDE`
          Include – Include selected blockers to cast shadows from the active emitter.
        - `EXCLUDE`
          Exclude – Exclude selected blockers from casting shadows from the active emitter.

bpy.ops.object.light_linking_blockers_select()
:   Select all objects which block light from this emitter

bpy.ops.object.light_linking_receiver_collection_new()
:   Create new light linking collection used by the active emitter

bpy.ops.object.light_linking_receivers_link(*\**, *link_state='INCLUDE'*)
:   Light link selected receivers to the active emitter object

    Parameters:
    :   **link_state** (enum in [`'INCLUDE'`, `'EXCLUDE'`], (optional)) –

        Link State, State of the light linking

        - `INCLUDE`
          Include – Include selected receivers to receive light from the active emitter.
        - `EXCLUDE`
          Exclude – Exclude selected receivers from receiving light from the active emitter.

bpy.ops.object.light_linking_receivers_select()
:   Select all objects which receive light from this emitter

bpy.ops.object.light_linking_unlink_from_collection()
:   Remove this object or collection from the light linking collection

bpy.ops.object.lightprobe_add(*\**, *type='SPHERE'*, *radius=1.0*, *enter_editmode=False*, *align='WORLD'*, *location=(0.0, 0.0, 0.0)*, *rotation=(0.0, 0.0, 0.0)*, *scale=(0.0, 0.0, 0.0)*)
:   Add a light probe object

    Parameters:
    :   - **type** (enum in [`'SPHERE'`, `'PLANE'`, `'VOLUME'`], (optional)) –

          Type

          - `SPHERE`
            Sphere – Light probe that captures precise lighting from all directions at a single point in space.
          - `PLANE`
            Plane – Light probe that captures incoming light from a single direction on a plane.
          - `VOLUME`
            Volume – Light probe that captures low frequency lighting inside a volume.
        - **radius** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Radius
        - **enter_editmode** (*boolean**,* *(**optional**)*) – Enter Edit Mode, Enter edit mode when adding this object
        - **align** (enum in [`'WORLD'`, `'VIEW'`, `'CURSOR'`], (optional)) –

          Align, The alignment of the new object

          - `WORLD`
            World – Align the new object to the world.
          - `VIEW`
            View – Align the new object to the view.
          - `CURSOR`
            3D Cursor – Use the 3D cursor orientation for the new object.
        - **location** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object
        - **rotation** ([`mathutils.Euler`](mathutils.html#mathutils.Euler "mathutils.Euler") rotation of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
        - **scale** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale, Scale for the newly added object

bpy.ops.object.lightprobe_cache_bake(*\**, *subset='ALL'*)
:   Bake irradiance volume light cache

    Parameters:
    :   **subset** (enum in [`'ALL'`, `'SELECTED'`, `'ACTIVE'`], (optional)) –

        Subset, Subset of probes to update

        - `ALL`
          All Volumes – Bake all light probe volumes.
        - `SELECTED`
          Selected Only – Only bake selected light probe volumes.
        - `ACTIVE`
          Active Only – Only bake the active light probe volume.

bpy.ops.object.lightprobe_cache_free(*\**, *subset='SELECTED'*)
:   Delete cached indirect lighting

    Parameters:
    :   **subset** (enum in [`'ALL'`, `'SELECTED'`, `'ACTIVE'`], (optional)) –

        Subset, Subset of probes to update

        - `ALL`
          All Light Probes – Delete all light probes’ baked lighting data.
        - `SELECTED`
          Selected Only – Only delete selected light probes’ baked lighting data.
        - `ACTIVE`
          Active Only – Only delete the active light probe’s baked lighting data.

bpy.ops.object.lineart_bake_strokes(*\**, *bake_all=False*)
:   Bake Line Art for current Grease Pencil object

    Parameters:
    :   **bake_all** (*boolean**,* *(**optional**)*) – Bake All, Bake all Line Art modifiers

bpy.ops.object.lineart_clear(*\**, *clear_all=False*)
:   Clear all strokes in current Grease Pencil object

    Parameters:
    :   **clear_all** (*boolean**,* *(**optional**)*) – Clear All, Clear all Line Art modifier bakes

bpy.ops.object.link_to_collection(*\**, *collection_uid=-1*, *is_new=False*, *new_collection_name=''*)
:   Link objects to a collection

    Parameters:
    :   - **collection_uid** (*int in* *[**-1**,* *inf**]**,* *(**optional**)*) – Collection UID, Session UID of the collection to link to
        - **is_new** (*boolean**,* *(**optional**)*) – New, Link objects to a new collection
        - **new_collection_name** (*string**,* *(**optional**,* *never None**)*) – Name, Name of the newly added collection

bpy.ops.object.location_clear(*\**, *clear_delta=False*)
:   Clear the object’s location

    Parameters:
    :   **clear_delta** (*boolean**,* *(**optional**)*) – Clear Delta, Clear delta location in addition to clearing the normal location transform

bpy.ops.object.make_dupli_face()
:   Convert objects into instanced faces

    File:
    :   [startup/bl_operators/object.py:692](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L692)

bpy.ops.object.make_links_data(*\**, *type='OBDATA'*)
:   Transfer data from active object to selected objects

    Parameters:
    :   **type** (enum in [`'OBDATA'`, `'MATERIAL'`, `'ANIMATION'`, `'GROUPS'`, `'DUPLICOLLECTION'`, `'FONTS'`, `'MODIFIERS'`, `'EFFECTS'`], (optional)) –

        Type

        - `OBDATA`
          Link Object Data – Replace assigned Object Data.
        - `MATERIAL`
          Link Materials – Replace assigned Materials.
        - `ANIMATION`
          Link Animation Data – Replace assigned Animation Data.
        - `GROUPS`
          Link Collections – Replace assigned Collections.
        - `DUPLICOLLECTION`
          Link Instance Collection – Replace assigned Collection Instance.
        - `FONTS`
          Link Fonts to Text – Replace Text object Fonts.
        - `MODIFIERS`
          Copy Modifiers – Replace Modifiers.
        - `EFFECTS`
          Copy Grease Pencil Effects – Replace Grease Pencil Effects.

bpy.ops.object.make_links_scene(*\**, *scene=''*)
:   Link selection to another scene

    Parameters:
    :   **scene** (*enum in* *[**]**,* *(**optional**)*) – Scene

bpy.ops.object.make_local(*\**, *type='SELECT_OBJECT'*)
:   Make library linked data-blocks local to this file

    Parameters:
    :   **type** (enum in [`'SELECT_OBJECT'`, `'SELECT_OBDATA'`, `'SELECT_OBDATA_MATERIAL'`, `'ALL'`], (optional)) – Type

bpy.ops.object.make_override_library(*\**, *collection=0*)
:   Create a local override of the selected linked objects, and their hierarchy of dependencies

    Parameters:
    :   **collection** (*int in* *[**-inf**,* *inf**]**,* *(**optional**)*) – Override Collection, Session UID of the directly linked collection containing the selected object, to make an override from

bpy.ops.object.make_single_user(*\**, *type='SELECTED_OBJECTS'*, *object=False*, *obdata=False*, *material=False*, *animation=False*, *obdata_animation=False*)
:   Make linked data local to each object

    Parameters:
    :   - **type** (enum in [`'SELECTED_OBJECTS'`, `'ALL'`], (optional)) – Type
        - **object** (*boolean**,* *(**optional**)*) – Object, Make single user objects
        - **obdata** (*boolean**,* *(**optional**)*) – Object Data, Make single user object data
        - **material** (*boolean**,* *(**optional**)*) – Materials, Make materials local to each data-block
        - **animation** (*boolean**,* *(**optional**)*) – Object Animation, Make object animation data local to each object
        - **obdata_animation** (*boolean**,* *(**optional**)*) – Object Data Animation, Make object data (mesh, curve etc.) animation data local to each object

bpy.ops.object.material_slot_add()
:   Add a new material slot

bpy.ops.object.material_slot_assign()
:   Assign active material slot to selection

bpy.ops.object.material_slot_copy()
:   Copy material to selected objects

bpy.ops.object.material_slot_deselect()
:   Deselect by active material slot

bpy.ops.object.material_slot_move(*\**, *direction='UP'*)
:   Move the active material up/down in the list

    Parameters:
    :   **direction** (enum in [`'UP'`, `'DOWN'`], (optional)) – Direction, Direction to move the active material towards

bpy.ops.object.material_slot_remove()
:   Remove the selected material slot

bpy.ops.object.material_slot_remove_all()
:   Remove all materials

bpy.ops.object.material_slot_remove_unused()
:   Remove unused material slots

bpy.ops.object.material_slot_select()
:   Select by active material slot

bpy.ops.object.meshdeform_bind(*\**, *modifier=''*)
:   Bind mesh to cage in mesh deform modifier

    Parameters:
    :   **modifier** (*string**,* *(**optional**,* *never None**)*) – Modifier, Name of the modifier to edit

bpy.ops.object.metaball_add(*\**, *type='BALL'*, *radius=2.0*, *enter_editmode=False*, *align='WORLD'*, *location=(0.0, 0.0, 0.0)*, *rotation=(0.0, 0.0, 0.0)*, *scale=(0.0, 0.0, 0.0)*)
:   Add an metaball object to the scene

    Parameters:
    :   - **type** (enum in [Metaelem Type Items](bpy_types_enum_items/metaelem_type_items.html#rna-enum-metaelem-type-items), (optional)) – Primitive
        - **radius** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Radius
        - **enter_editmode** (*boolean**,* *(**optional**)*) – Enter Edit Mode, Enter edit mode when adding this object
        - **align** (enum in [`'WORLD'`, `'VIEW'`, `'CURSOR'`], (optional)) –

          Align, The alignment of the new object

          - `WORLD`
            World – Align the new object to the world.
          - `VIEW`
            View – Align the new object to the view.
          - `CURSOR`
            3D Cursor – Use the 3D cursor orientation for the new object.
        - **location** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object
        - **rotation** ([`mathutils.Euler`](mathutils.html#mathutils.Euler "mathutils.Euler") rotation of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
        - **scale** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale, Scale for the newly added object

bpy.ops.object.mode_set(*\**, *mode='OBJECT'*, *toggle=False*)
:   Sets the object interaction mode

    Parameters:
    :   - **mode** (enum in [Object Mode Items](bpy_types_enum_items/object_mode_items.html#rna-enum-object-mode-items), (optional)) – Mode
        - **toggle** (*boolean**,* *(**optional**)*) – Toggle

bpy.ops.object.mode_set_with_submode(*\**, *mode='OBJECT'*, *toggle=False*, *mesh_select_mode={}*)
:   Sets the object interaction mode

    Parameters:
    :   - **mode** (enum in [Object Mode Items](bpy_types_enum_items/object_mode_items.html#rna-enum-object-mode-items), (optional)) – Mode
        - **toggle** (*boolean**,* *(**optional**)*) – Toggle
        - **mesh_select_mode** (enum set in [Mesh Select Mode Items](bpy_types_enum_items/mesh_select_mode_items.html#rna-enum-mesh-select-mode-items), (optional)) – Mesh Mode

bpy.ops.object.modifier_add(*\**, *type='SUBSURF'*, *use_selected_objects=False*)
:   Add a procedural operation/effect to the active object

    Parameters:
    :   - **type** (enum in [Object Modifier Type Items](bpy_types_enum_items/object_modifier_type_items.html#rna-enum-object-modifier-type-items), (optional)) – Type
        - **use_selected_objects** (*boolean**,* *(**optional**)*) – Selected Objects, Affect all selected objects instead of just the active object

bpy.ops.object.


[User] Describe Inherited Functions from the Blender manual or Python API, including usage steps and snippets.

[Assistant]
|  |  |
| --- | --- |
| - [`bpy_struct.as_pointer`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.as_pointer "bpy.types.bpy_struct.as_pointer") - [`bpy_struct.driver_add`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_add "bpy.types.bpy_struct.driver_add") - [`bpy_struct.driver_remove`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_remove "bpy.types.bpy_struct.driver_remove") - [`bpy_struct.get`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.get "bpy.types.bpy_struct.get") - [`bpy_struct.id_properties_clear`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_clear "bpy.types.bpy_struct.id_properties_clear") - [`bpy_struct.id_properties_ensure`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ensure "bpy.types.bpy_struct.id_properties_ensure") - [`bpy_struct.id_properties_ui`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ui "bpy.types.bpy_struct.id_properties_ui") - [`bpy_struct.is_property_hidden`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_hidden "bpy.types.bpy_struct.is_property_hidden") - [`bpy_struct.is_property_overridable_library`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_overridable_library "bpy.types.bpy_struct.is_property_overridable_library") - [`bpy_struct.is_property_readonly`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_readonly "bpy.types.bpy_struct.is_property_readonly") - [`bpy_struct.is_property_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_set "bpy.types.bpy_struct.is_property_set") - [`bpy_struct.items`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.items "bpy.types.bpy_struct.items") - [`bpy_struct.keyframe_delete`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_delete "bpy.types.bpy_struct.keyframe_delete") - [`bpy_struct.keyframe_insert`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert "bpy.types.bpy_struct.keyframe_insert") - [`bpy_struct.keys`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keys "bpy.types.bpy_struct.keys") - [`bpy_struct.path_from_id`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id "bpy.types.bpy_struct.path_from_id") - [`bpy_struct.path_from_module`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_module "bpy.types.bpy_struct.path_from_module") - [`bpy_struct.path_resolve`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_resolve "bpy.types.bpy_struct.path_resolve") - [`bpy_struct.pop`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.pop "bpy.types.bpy_struct.pop") - [`bpy_struct.property_overridable_library_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_overridable_library_set "bpy.types.bpy_struct.property_overridable_library_set") - [`bpy_struct.property_unset`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_unset "bpy.types.bpy_struct.property_unset") - [`bpy_struct.rna_ancestors`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.rna_ancestors "bpy.types.bpy_struct.rna_ancestors") | - [`bpy_struct.type_recast`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.type_recast "bpy.types.bpy_struct.type_recast") - [`bpy_struct.values`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.values "bpy.types.bpy_struct.values") - [`ID.bl_system_properties_get`](bpy.types.ID.html#bpy.types.ID.bl_system_properties_get "bpy.types.ID.bl_system_properties_get") - [`ID.rename`](bpy.types.ID.html#bpy.types.ID.rename "bpy.types.ID.rename") - [`ID.evaluated_get`](bpy.types.ID.html#bpy.types.ID.evaluated_get "bpy.types.ID.evaluated_get") - [`ID.copy`](bpy.types.ID.html#bpy.types.ID.copy "bpy.types.ID.copy") - [`ID.asset_mark`](bpy.types.ID.html#bpy.types.ID.asset_mark "bpy.types.ID.asset_mark") - [`ID.asset_clear`](bpy.types.ID.html#bpy.types.ID.asset_clear "bpy.types.ID.asset_clear") - [`ID.asset_generate_preview`](bpy.types.ID.html#bpy.types.ID.asset_generate_preview "bpy.types.ID.asset_generate_preview") - [`ID.override_create`](bpy.types.ID.html#bpy.types.ID.override_create "bpy.types.ID.override_create") - [`ID.override_hierarchy_create`](bpy.types.ID.html#bpy.types.ID.override_hierarchy_create "bpy.types.ID.override_hierarchy_create") - [`ID.user_clear`](bpy.types.ID.html#bpy.types.ID.user_clear "bpy.types.ID.user_clear") - [`ID.user_remap`](bpy.types.ID.html#bpy.types.ID.user_remap "bpy.types.ID.user_remap") - [`ID.make_local`](bpy.types.ID.html#bpy.types.ID.make_local "bpy.types.ID.make_local") - [`ID.user_of_id`](bpy.types.ID.html#bpy.types.ID.user_of_id "bpy.types.ID.user_of_id") - [`ID.animation_data_create`](bpy.types.ID.html#bpy.types.ID.animation_data_create "bpy.types.ID.animation_data_create") - [`ID.animation_data_clear`](bpy.types.ID.html#bpy.types.ID.animation_data_clear "bpy.types.ID.animation_data_clear") - [`ID.update_tag`](bpy.types.ID.html#bpy.types.ID.update_tag "bpy.types.ID.update_tag") - [`ID.preview_ensure`](bpy.types.ID.html#bpy.types.ID.preview_ensure "bpy.types.ID.preview_ensure") - [`ID.bl_rna_get_subclass`](bpy.types.ID.html#bpy.types.ID.bl_rna_get_subclass "bpy.types.ID.bl_rna_get_subclass") - [`ID.bl_rna_get_subclass_py`](bpy.types.ID.html#bpy.types.ID.bl_rna_get_subclass_py "bpy.types.ID.bl_rna_get_subclass_py") |


[User] Provide the full official documentation entry for Inherited Functions, preserving all code examples.

[Assistant]
|  |  |
| --- | --- |
| - [`bpy_struct.as_pointer`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.as_pointer "bpy.types.bpy_struct.as_pointer") - [`bpy_struct.driver_add`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_add "bpy.types.bpy_struct.driver_add") - [`bpy_struct.driver_remove`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_remove "bpy.types.bpy_struct.driver_remove") - [`bpy_struct.get`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.get "bpy.types.bpy_struct.get") - [`bpy_struct.id_properties_clear`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_clear "bpy.types.bpy_struct.id_properties_clear") - [`bpy_struct.id_properties_ensure`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ensure "bpy.types.bpy_struct.id_properties_ensure") - [`bpy_struct.id_properties_ui`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ui "bpy.types.bpy_struct.id_properties_ui") - [`bpy_struct.is_property_hidden`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_hidden "bpy.types.bpy_struct.is_property_hidden") - [`bpy_struct.is_property_overridable_library`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_overridable_library "bpy.types.bpy_struct.is_property_overridable_library") - [`bpy_struct.is_property_readonly`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_readonly "bpy.types.bpy_struct.is_property_readonly") - [`bpy_struct.is_property_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_set "bpy.types.bpy_struct.is_property_set") - [`bpy_struct.items`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.items "bpy.types.bpy_struct.items") - [`bpy_struct.keyframe_delete`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_delete "bpy.types.bpy_struct.keyframe_delete") - [`bpy_struct.keyframe_insert`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert "bpy.types.bpy_struct.keyframe_insert") - [`bpy_struct.keys`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keys "bpy.types.bpy_struct.keys") - [`bpy_struct.path_from_id`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id "bpy.types.bpy_struct.path_from_id") - [`bpy_struct.path_from_module`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_module "bpy.types.bpy_struct.path_from_module") - [`bpy_struct.path_resolve`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_resolve "bpy.types.bpy_struct.path_resolve") - [`bpy_struct.pop`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.pop "bpy.types.bpy_struct.pop") - [`bpy_struct.property_overridable_library_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_overridable_library_set "bpy.types.bpy_struct.property_overridable_library_set") - [`bpy_struct.property_unset`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_unset "bpy.types.bpy_struct.property_unset") - [`bpy_struct.rna_ancestors`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.rna_ancestors "bpy.types.bpy_struct.rna_ancestors") - [`bpy_struct.type_recast`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.type_recast "bpy.types.bpy_struct.type_recast") - [`bpy_struct.values`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.values "bpy.types.bpy_struct.values") - [`Node.bl_system_properties_get`](bpy.types.Node.html#bpy.types.Node.bl_system_properties_get "bpy.types.Node.bl_system_properties_get") - [`Node.socket_value_update`](bpy.types.Node.html#bpy.types.Node.socket_value_update "bpy.types.Node.socket_value_update") | - [`Node.is_registered_node_type`](bpy.types.Node.html#bpy.types.Node.is_registered_node_type "bpy.types.Node.is_registered_node_type") - [`Node.poll`](bpy.types.Node.html#bpy.types.Node.poll "bpy.types.Node.poll") - [`Node.poll_instance`](bpy.types.Node.html#bpy.types.Node.poll_instance "bpy.types.Node.poll_instance") - [`Node.update`](bpy.types.Node.html#bpy.types.Node.update "bpy.types.Node.update") - [`Node.insert_link`](bpy.types.Node.html#bpy.types.Node.insert_link "bpy.types.Node.insert_link") - [`Node.init`](bpy.types.Node.html#bpy.types.Node.init "bpy.types.Node.init") - [`Node.copy`](bpy.types.Node.html#bpy.types.Node.copy "bpy.types.Node.copy") - [`Node.free`](bpy.types.Node.html#bpy.types.Node.free "bpy.types.Node.free") - [`Node.draw_buttons`](bpy.types.Node.html#bpy.types.Node.draw_buttons "bpy.types.Node.draw_buttons") - [`Node.draw_buttons_ext`](bpy.types.Node.html#bpy.types.Node.draw_buttons_ext "bpy.types.Node.draw_buttons_ext") - [`Node.draw_label`](bpy.types.Node.html#bpy.types.Node.draw_label "bpy.types.Node.draw_label") - [`Node.debug_zone_body_lazy_function_graph`](bpy.types.Node.html#bpy.types.Node.debug_zone_body_lazy_function_graph "bpy.types.Node.debug_zone_body_lazy_function_graph") - [`Node.debug_zone_lazy_function_graph`](bpy.types.Node.html#bpy.types.Node.debug_zone_lazy_function_graph "bpy.types.Node.debug_zone_lazy_function_graph") - [`Node.poll`](bpy.types.Node.html#bpy.types.Node.poll "bpy.types.Node.poll") - [`Node.bl_rna_get_subclass`](bpy.types.Node.html#bpy.types.Node.bl_rna_get_subclass "bpy.types.Node.bl_rna_get_subclass") - [`Node.bl_rna_get_subclass_py`](bpy.types.Node.html#bpy.types.Node.bl_rna_get_subclass_py "bpy.types.Node.bl_rna_get_subclass_py") - [`NodeInternal.poll`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.poll "bpy.types.NodeInternal.poll") - [`NodeInternal.poll_instance`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.poll_instance "bpy.types.NodeInternal.poll_instance") - [`NodeInternal.update`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.update "bpy.types.NodeInternal.update") - [`NodeInternal.draw_buttons`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.draw_buttons "bpy.types.NodeInternal.draw_buttons") - [`NodeInternal.draw_buttons_ext`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.draw_buttons_ext "bpy.types.NodeInternal.draw_buttons_ext") - [`NodeInternal.bl_rna_get_subclass`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.bl_rna_get_subclass "bpy.types.NodeInternal.bl_rna_get_subclass") - [`NodeInternal.bl_rna_get_subclass_py`](bpy.types.NodeInternal.html#bpy.types.NodeInternal.bl_rna_get_subclass_py "bpy.types.NodeInternal.bl_rna_get_subclass_py") - `GeometryNode.poll` - [`GeometryNode.bl_rna_get_subclass`](bpy.types.GeometryNode.html#bpy.types.GeometryNode.bl_rna_get_subclass "bpy.types.GeometryNode.bl_rna_get_subclass") - [`GeometryNode.bl_rna_get_subclass_py`](bpy.types.GeometryNode.html#bpy.types.GeometryNode.bl_rna_get_subclass_py "bpy.types.GeometryNode.bl_rna_get_subclass_py") |


[User] Show practical ways to work with Bpy.Types.Movietrackingcamera in a Blender add-on or script – include code.

[Assistant] MovieTrackingCamera(bpy_struct) - Blender Python API Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Hide navigation sidebar Hide table of contents sidebar Skip to content Toggle site navigation sidebar Blender Python API Toggle Light / Dark / Auto color theme Toggle table of contents sidebar Blender Python API Documentation Quickstart API Overview API Reference Usage Best Practice Tips and Tricks Gotchas Toggle navigation of Gotchas Troubleshooting Errors & Crashes Python Threads are Not Supported Internal Data & Their Python Objects Using Operators Modes and Mesh Access Bones & Armatures File Paths & String Encoding Advanced Toggle navigation of Advanced Blender as a Python Module Change Log Application Modules Context Access (bpy.context) Data Access (bpy.data) Message Bus (bpy.msgbus) Operators (bpy.ops) Toggle navigation of Operators (bpy.ops) Action Operators Anim Operators Armature Operators Asset Operators Boid Operators Brush Operators Buttons Operators Cachefile Operators Camera Operators Clip Operators Cloth Operators Collection Operators Console Operators Constraint Operators Curve Operators Curves Operators Cycles Operators Dpaint Operators Ed Operators Export Anim Operators Export Scene Operators Extensions Operators File Operators Fluid Operators Font Operators Geometry Operators Gizmogroup Operators Gpencil Operators Graph Operators Grease Pencil Operators Image Operators Import Anim Operators Import Curve Operators Import Scene Operators Info Operators Lattice Operators Marker Operators Mask Operators Material Operators Mball Operators Mesh Operators Nla Operators Node Operators Object Operators Outliner Operators Paint Operators Paintcurve Operators Palette Operators Particle Operators Pointcloud Operators Pose Operators Poselib Operators Preferences Operators Ptcache Operators Render Operators Rigidbody Operators Scene Operators Screen Operators Script Operators Sculpt Operators Sculpt Curves Operators Sequencer Operators Sound Operators Spreadsheet Operators Surface Operators Text Operators Text Editor Operators Texture Operators Transform Operators Ui Operators Uilist Operators Uv Operators View2D Operators View3D Operators Wm Operators Workspace Operators World Operators Types (bpy.types) Toggle navigation of Types (bpy.types) AOV(bpy_struct) AOVs(bpy_struct) ASSETBROWSER_UL_metadata_tags(UIList) Action(ID) ActionChannelbag(bpy_struct) ActionChannelbagFCurves(bpy_struct) ActionChannelbagGroups(bpy_struct) ActionChannelbags(bpy_struct) ActionConstraint(Constraint) ActionGroup(bpy_struct) ActionKeyframeStrip(ActionStrip) ActionLayer(bpy_struct) ActionLayers(bpy_struct) ActionPoseMarkers(bpy_struct) ActionSlot(bpy_struct) ActionSlots(bpy_struct) ActionStrip(bpy_struct) ActionStrips(bpy_struct) AddStrip(EffectStrip) Addon(bpy_struct) AddonPreferences(bpy_struct) Addons(bpy_struct) AdjustmentStrip(EffectStrip) AlphaOverStrip(EffectStrip) AlphaUnderStrip(EffectStrip) AnimData(bpy_struct) AnimDataDrivers(bpy_struct) AnimViz(bpy_struct) AnimVizMotionPaths(bpy_struct) Annotation(ID) AnnotationFrame(bpy_struct) AnnotationFrames(bpy_struct) AnnotationLayer(bpy_struct) AnnotationLayers(bpy_struct) AnnotationStroke(bpy_struct) AnnotationStrokePoint(bpy_struct) AnyType(bpy_struct) Area(bpy_struct) AreaLight(Light) AreaSpaces(bpy_struct) Armature(ID) ArmatureBones(bpy_struct) ArmatureConstraint(Constraint) ArmatureConstraintTargets(bpy_struct) ArmatureEditBones(bpy_struct) ArmatureModifier(Modifier) ArrayModifier(Modifier) AssetLibraryCollection(bpy_struct) AssetLibraryReference(bpy_struct) AssetMetaData(bpy_struct) AssetRepresentation(bpy_struct) AssetShelf(bpy_struct) AssetTag(bpy_struct) AssetTags(bpy_struct) AssetWeakReference(bpy_struct) Attribute(bpy_struct) AttributeGroupCurves(bpy_struct) AttributeGroupGreasePencil(bpy_struct) AttributeGroupGreasePencilDrawing(bpy_struct) AttributeGroupMesh(bpy_struct) AttributeGroupPointCloud(bpy_struct) BakeSettings(bpy_struct) BevelModifier(Modifier) BezierSplinePoint(bpy_struct) BlendData(bpy_struct) BlendDataActions(bpy_struct) BlendDataAnnotations(bpy_struct) BlendDataArmatures(bpy_struct) BlendDataBrushes(bpy_struct) BlendDataCacheFiles(bpy_struct) BlendDataCameras(bpy_struct) BlendDataCollections(bpy_struct) BlendDataCurves(bpy_struct) BlendDataFonts(bpy_struct) BlendDataGreasePencilsV3(bpy_struct) BlendDataHairCurves(bpy_struct) BlendDataImages(bpy_struct) BlendDataLattices(bpy_struct) BlendDataLibraries(bpy_struct) BlendDataLights(bpy_struct) BlendDataLineStyles(bpy_struct) BlendDataMasks(bpy_struct) BlendDataMaterials(bpy_struct) BlendDataMeshes(bpy_struct) BlendDataMetaBalls(bpy_struct) BlendDataMovieClips(bpy_struct) BlendDataNodeTrees(bpy_struct) BlendDataObjects(bpy_struct) BlendDataPaintCurves(bpy_struct) BlendDataPalettes(bpy_struct) BlendDataParticles(bpy_struct) BlendDataPointClouds(bpy_struct) BlendDataProbes(bpy_struct) BlendDataScenes(bpy_struct) BlendDataScreens(bpy_struct) BlendDataSounds(bpy_struct) BlendDataSpeakers(bpy_struct) BlendDataTexts(bpy_struct) BlendDataTextures(bpy_struct) BlendDataVolumes(bpy_struct) BlendDataWindowManagers(bpy_struct) BlendDataWorkSpaces(bpy_struct) BlendDataWorlds(bpy_struct) BlendFileColorspace(bpy_struct) BlendImportContext(bpy_struct) BlendImportContextItem(bpy_struct) BlendImportContextItems(bpy_struct) BlendImportContextLibraries(bpy_struct) BlendImportContextLibrary(bpy_struct) BlendTexture(Texture) BlenderRNA(bpy_struct) BoidRule(bpy_struct) BoidRuleAverageSpeed(BoidRule) BoidRuleAvoid(BoidRule) BoidRuleAvoidCollision(BoidRule) BoidRuleFight(BoidRule) BoidRuleFollowLeader(BoidRule) BoidRuleGoal(BoidRule) BoidSettings(bpy_struct) BoidState(bpy_struct) Bone(bpy_struct) BoneCollection(bpy_struct) BoneCollectionMemberships(bpy_struct) BoneCollections(bpy_struct) BoneColor(bpy_struct) BoolAttribute(Attribute) BoolAttributeValue(bpy_struct) BoolProperty(Property) BooleanModifier(Modifier) BrightContrastModifier(StripModifier) Brush(ID) BrushCapabilities(bpy_struct) BrushCapabilitiesImagePaint(bpy_struct) BrushCapabilitiesSculpt(bpy_struct) BrushCapabilitiesVertexPaint(bpy_struct) BrushCapabilitiesWeightPaint(bpy_struct) BrushCurvesSculptSettings(bpy_struct) BrushGpencilSettings(bpy_struct) BrushTextureSlot(TextureSlot) BuildModifier(Modifier) ByteColorAttribute(Attribute) ByteColorAttributeValue(bpy_struct) ByteIntAttribute(Attribute) ByteIntAttributeValue(bpy_struct) CLIP_UL_tracking_objects(UIList) CURVES_UL_attributes(UIList) CacheFile(ID) CacheFileLayer(bpy_struct) CacheFileLayers(bpy_struct) CacheObjectPath(bpy_struct) CacheObjectPaths(bpy_struct) Camera(ID) CameraBackgroundImage(bpy_struct) CameraBackgroundImages(bpy_struct) CameraDOFSettings(bpy_struct) CameraSolverConstraint(Constraint) CameraStereoData(bpy_struct) CastModifier(Modifier) ChannelDriverVariables(bpy_struct) ChildOfConstraint(Constraint) ChildParticle(bpy_struct) ClampToConstraint(Constraint) ClothCollisionSettings(bpy_struct) ClothModifier(Modifier) ClothSettings(bpy_struct) ClothSolverResult(bpy_struct) CloudsTexture(Texture) Collection(ID) CollectionChild(bpy_struct) CollectionChildren(bpy_struct) CollectionExport(bpy_struct) CollectionExports(bpy_struct) CollectionLightLinking(bpy_struct) CollectionObject(bpy_struct) CollectionObjects(bpy_struct) CollectionProperty(Property) CollisionModifier(Modifier) CollisionSettings(bpy_struct) ColorBalanceModifier(StripModifier) ColorManagedDisplaySettings(bpy_struct) ColorManagedInputColorspaceSettings(bpy_struct) ColorManagedSequencerColorspaceSettings(bpy_struct) ColorManagedViewSettings(bpy_struct) ColorMapping(bpy_struct) ColorMixStrip(EffectStrip) ColorRamp(bpy_struct) ColorRampElement(bpy_struct) ColorRampElements(bpy_struct) ColorStrip(EffectStrip) CompositorNode(NodeInternal) CompositorNodeAlphaOver(CompositorNode) CompositorNodeAntiAliasing(CompositorNode) CompositorNodeBilateralblur(CompositorNode) CompositorNodeBlur(CompositorNode) CompositorNodeBokehBlur(CompositorNode) CompositorNodeBokehImage(CompositorNode) CompositorNodeBoxMask(CompositorNode) CompositorNodeBrightContrast(CompositorNode) CompositorNodeChannelMatte(CompositorNode) CompositorNodeChromaMatte(CompositorNode) CompositorNodeColorBalance(CompositorNode) CompositorNodeColorCorrection(CompositorNode) CompositorNodeColorMatte(CompositorNode) CompositorNodeColorSpill(CompositorNode) CompositorNodeCombineColor(CompositorNode) CompositorNodeConvertColorSpace(CompositorNode) CompositorNodeConvertToDisplay(CompositorNode) CompositorNodeConvolve(CompositorNode) CompositorNodeCornerPin(CompositorNode) CompositorNodeCrop(CompositorNode) CompositorNodeCryptomatte(CompositorNode) CompositorNodeCryptomatteV2(CompositorNode) CompositorNodeCurveRGB(CompositorNode) CompositorNodeCustomGroup(CompositorNode) CompositorNodeDBlur(CompositorNode) CompositorNodeDefocus(CompositorNode) CompositorNodeDenoise(CompositorNode) CompositorNodeDespeckle(CompositorNode) CompositorNodeDiffMatte(CompositorNode) CompositorNodeDilateErode(CompositorNode) CompositorNodeDisplace(CompositorNode) CompositorNodeDistanceMatte(CompositorNode) CompositorNodeDoubleEdgeMask(CompositorNode) CompositorNodeEllipseMask(CompositorNode) CompositorNodeExposure(CompositorNode) CompositorNodeFilter(CompositorNode) CompositorNodeFlip(CompositorNode) CompositorNodeGamma(CompositorNode) CompositorNodeGlare(CompositorNode) CompositorNodeGroup(CompositorNode) CompositorNodeHueCorrect(CompositorNode) CompositorNodeHueSat(CompositorNode) CompositorNodeIDMask(CompositorNode) CompositorNodeImage(CompositorNode) CompositorNodeImageCoordinates(CompositorNode) CompositorNodeImageInfo(CompositorNode) CompositorNodeInpaint(CompositorNode) CompositorNodeInvert(CompositorNode) CompositorNodeKeying(CompositorNode) CompositorNodeKeyingScreen(CompositorNode) CompositorNodeKuwahara(CompositorNode) CompositorNodeLensdist(CompositorNode) CompositorNodeLevels(CompositorNode) CompositorNodeLumaMatte(CompositorNode) CompositorNodeMapUV(CompositorNode) CompositorNodeMask(CompositorNode) CompositorNodeMovieClip(CompositorNode) CompositorNodeMovieDistortion(CompositorNode) CompositorNodeNormal(CompositorNode) CompositorNodeNormalize(CompositorNode) CompositorNodeOutputFile(CompositorNode) CompositorNodePixelate(CompositorNode) CompositorNodePlaneTrackDeform(CompositorNode) CompositorNodePosterize(CompositorNode) CompositorNodePremulKey(CompositorNode) CompositorNodeRGB(CompositorNode) CompositorNodeRGBToBW(CompositorNode) CompositorNodeRLayers(CompositorNode) CompositorNodeRelativeToPixel(CompositorNode) CompositorNodeRotate(CompositorNode) CompositorNodeScale(CompositorNode) CompositorNodeSceneTime(CompositorNode) CompositorNodeSeparateColor(CompositorNode) CompositorNodeSetAlpha(CompositorNode) CompositorNodeSplit(CompositorNode) CompositorNodeStabilize(CompositorNode) CompositorNodeSwitch(CompositorNode) CompositorNodeSwitchView(CompositorNode) CompositorNodeTime(CompositorNode) CompositorNodeTonemap(CompositorNode) CompositorNodeTrackPos(CompositorNode) CompositorNodeTransform(CompositorNode) CompositorNodeTranslate(CompositorNode) CompositorNodeTree(NodeTree) CompositorNodeVecBlur(CompositorNode) CompositorNodeViewer(CompositorNode) CompositorNodeZcombine(CompositorNode) ConsoleLine(bpy_struct) Constraint(bpy_struct) ConstraintTarget(bpy_struct) ConstraintTargetBone(bpy_struct) Context(bpy_struct) CopyLocationConstraint(Constraint) CopyRotationConstraint(Constraint) CopyScaleConstraint(Constraint) CopyTransformsConstraint(Constraint) CorrectiveSmoothModifier(Modifier) CrossStrip(EffectStrip) CryptomatteEntry(bpy_struct) Curve(ID) CurveMap(bpy_struct) CurveMapPoint(bpy_struct) CurveMapPoints(bpy_struct) CurveMapping(bpy_struct) CurveModifier(Modifier) CurvePaintSettings(bpy_struct) CurvePoint(bpy_struct) CurveProfile(bpy_struct) CurveProfilePoint(bpy_struct) CurveProfilePoints(bpy_struct) CurveSlice(bpy_struct) CurveSplines(bpy_struct) Curves(ID) CurvesModifier(StripModifier) CurvesSculpt(Paint) DATA_UL_bone_collections(UIList) DampedTrackConstraint(Constraint) DataTransferModifier(Modifier) DecimateModifier(Modifier) Depsgraph(bpy_struct) DepsgraphObjectInstance(bpy_struct) DepsgraphUpdate(bpy_struct) DisplaceModifier(Modifier) DisplaySafeAreas(bpy_struct) DistortedNoiseTexture(Texture) DopeSheet(bpy_struct) Driver(bpy_struct) DriverTarget(bpy_struct) DriverVariable(bpy_struct) DynamicPaintBrushSettings(bpy_struct) DynamicPaintCanvasSettings(bpy_struct) DynamicPaintModifier(Modifier) DynamicPaintSurface(bpy_struct) DynamicPaintSurfaces(bpy_struct) EQCurveMappingData(bpy_struct) EdgeSplitModifier(Modifier) EditBone(bpy_struct) EffectStrip(Strip) EffectorWeights(bpy_struct) EnumProperty(Property) EnumPropertyItem(bpy_struct) EvaluateClosureNodeViewerPathElem(ViewerPathElem) Event(bpy_struct) ExplodeModifier(Modifier) FCurve(bpy_struct) FCurveKeyframePoints(bpy_struct) FCurveModifiers(bpy_struct) FCurveSample(bpy_struct) FFmpegSettings(bpy_struct) FILEBROWSER_UL_dir(UIList) FModifier(bpy_struct) FModifierCycles(FModifier) FModifierEnvelope(FModifier) FModifierEnvelopeControlPoint(bpy_struct) FModifierEnvelopeControlPoints(bpy_struct) FModifierFunctionGenerator(FModifier) FModifierGenerator(FModifier) FModifierLimits(FModifier) FModifierNoise(FModifier) FModifierStepped(FModifier) FieldSettings(bpy_struct) FileAssetSelectIDFilter(bpy_struct) FileAssetSelectParams(FileSelectParams) FileBrowserFSMenuEntry(bpy_struct) FileHandler(bpy_struct) FileSelectEntry(bpy_struct) FileSelectIDFilter(bpy_struct) FileSelectParams(bpy_struct) Float2Attribute(Attribute) Float2AttributeValue(bpy_struct) Float4x4Attribute(Attribute) Float4x4AttributeValue(bpy_struct) FloatAttribute(Attribute) FloatAttributeValue(bpy_struct) FloatColorAttribute(Attribute) FloatColorAttributeValue(bpy_struct) FloatProperty(Property) FloatVectorAttribute(Attribute) FloatVectorAttributeValue(bpy_struct) FloatVectorValueReadOnly(bpy_struct) FloorConstraint(Constraint) FluidDomainSettings(bpy_struct) FluidEffectorSettings(bpy_struct) FluidFlowSettings(bpy_struct) FluidModifier(Modifier) FollowPathConstraint(Constraint) FollowTrackConstraint(Constraint) ForeachGeometryElementGenerationItem(bpy_struct) ForeachGeometryElementInputItem(bpy_struct) ForeachGeometryElementMainItem(bpy_struct) ForeachGeometryElementZoneViewerPathElem(ViewerPathElem) FreestyleLineSet(bpy_struct) FreestyleLineStyle(ID) FreestyleModuleSettings(bpy_struct) FreestyleModules(bpy_struct) FreestyleSettings(bpy_struct) Function(bpy_struct) FunctionNode(NodeInternal) FunctionNodeAlignEulerToVector(FunctionNode) FunctionNodeAlignRotationToVector(FunctionNode) FunctionNodeAxesToRotation(FunctionNode) FunctionNodeAxisAngleToRotation(FunctionNode) FunctionNodeBitMath(FunctionNode) FunctionNodeBooleanMath(FunctionNode) FunctionNodeCombineColor(FunctionNode) FunctionNodeCombineMatrix(FunctionNode) FunctionNodeCombineTransform(FunctionNode) FunctionNodeCompare(FunctionNode) FunctionNodeEulerToRotation(FunctionNode) FunctionNodeFindInString(FunctionNode) FunctionNodeFloatToInt(FunctionNode) FunctionNodeFormatString(FunctionNode) FunctionNodeHashValue(FunctionNode) FunctionNodeInputBool(FunctionNode) FunctionNodeInputColor(FunctionNode) FunctionNodeInputInt(FunctionNode) FunctionNodeInputRotation(FunctionNode) FunctionNodeInputSpecialCharacters(FunctionNode) FunctionNodeInputString(FunctionNode) FunctionNodeInputVector(FunctionNode) FunctionNodeIntegerMath(FunctionNode) FunctionNodeInvertMatrix(FunctionNode) FunctionNodeInvertRotation(FunctionNode) FunctionNodeMatchString(FunctionNode) FunctionNodeMatrixDeterminant(FunctionNode) FunctionNodeMatrixMultiply(FunctionNode) FunctionNodeProjectPoint(FunctionNode) FunctionNodeQuaternionToRotation(FunctionNode) FunctionNodeRandomValue(FunctionNode) FunctionNodeReplaceString(FunctionNode) FunctionNodeRotateEuler(FunctionNode) FunctionNodeRotateRotation(FunctionNode) FunctionNodeRotateVector(FunctionNode) FunctionNodeRotationToAxisAngle(FunctionNode) FunctionNodeRotationToEuler(FunctionNode) FunctionNodeRotationToQuaternion(FunctionNode) FunctionNodeSeparateColor(FunctionNode) FunctionNodeSeparateMatrix(FunctionNode) FunctionNodeSeparateTransform(FunctionNode) FunctionNodeSliceString(FunctionNode) FunctionNodeStringLength(FunctionNode) FunctionNodeStringToValue(FunctionNode) FunctionNodeTransformDirection(FunctionNode) FunctionNodeTransformPoint(FunctionNode) FunctionNodeTransposeMatrix(FunctionNode) FunctionNodeValueToString(FunctionNode) GPENCIL_UL_annotation_layer(UIList) GPENCIL_UL_matslots(UIList) GPencilInterpolateSettings(bpy_struct) GPencilSculptGuide(bpy_struct) GPencilSculptSettings(bpy_struct) GREASE_PENCIL_UL_attributes(UIList) GREASE_PENCIL_UL_masks(UIList) GammaCrossStrip(EffectStrip) GaussianBlurStrip(EffectStrip) GeometryAttributeConstraint(Constraint) GeometryNode(NodeInternal) GeometryNodeAccumulateField(GeometryNode) GeometryNodeAttributeDomainSize(GeometryNode) GeometryNodeAttributeStatistic(GeometryNode) GeometryNodeBake(GeometryNode) GeometryNodeBlurAttribute(GeometryNode) GeometryNodeBoundBox(GeometryNode) GeometryNodeCameraInfo(GeometryNode) GeometryNodeCaptureAttribute(GeometryNode) GeometryNodeCollectionInfo(GeometryNode) GeometryNodeConvexHull(GeometryNode) GeometryNodeCornersOfEdge(GeometryNode) GeometryNodeCornersOfFace(GeometryNode) GeometryNodeCornersOfVertex(GeometryNode) GeometryNodeCurveArc(GeometryNode) GeometryNodeCurveEndpointSelection(GeometryNode) GeometryNodeCurveHandleTypeSelection(GeometryNode) GeometryNodeCurveLength(GeometryNode) GeometryNodeCurveOfPoint(GeometryNode) GeometryNodeCurvePrimitiveBezierSegment(GeometryNode) GeometryNodeCurvePrimitiveCircle(GeometryNode) GeometryNodeCurvePrimitiveLine(GeometryNode) GeometryNodeCurvePrimitiveQuadrilateral(GeometryNode) GeometryNodeCurveQuadraticBezier(GeometryNode) GeometryNodeCurveSetHandles(GeometryNode) GeometryNodeCurveSpiral(GeometryNode) GeometryNodeCurveSplineType(GeometryNode) GeometryNodeCurveStar(GeometryNode) GeometryNodeCurveToMe


[User] Describe Interpolated from the Blender manual or Python API, including usage steps and snippets.

[Assistant]
Virtual Parents
:   Relative amount of virtual parents.

Long Hair
:   Calculate children that suit long hair well.

### Parting

Parting
:   Creates parting in the children based on parent strands.

Min/Max
:   The minimum/maximum root to tip angle (tip distance/root distance for long hair).


[User] How do I use Inherited Functions in Blender? Include parameters, examples, warnings and best practices.

[Assistant]
|  |  |
| --- | --- |
| - [`bpy_struct.as_pointer`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.as_pointer "bpy.types.bpy_struct.as_pointer") - [`bpy_struct.driver_add`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_add "bpy.types.bpy_struct.driver_add") - [`bpy_struct.driver_remove`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.driver_remove "bpy.types.bpy_struct.driver_remove") - [`bpy_struct.get`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.get "bpy.types.bpy_struct.get") - [`bpy_struct.id_properties_clear`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_clear "bpy.types.bpy_struct.id_properties_clear") - [`bpy_struct.id_properties_ensure`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ensure "bpy.types.bpy_struct.id_properties_ensure") - [`bpy_struct.id_properties_ui`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_properties_ui "bpy.types.bpy_struct.id_properties_ui") - [`bpy_struct.is_property_hidden`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_hidden "bpy.types.bpy_struct.is_property_hidden") - [`bpy_struct.is_property_overridable_library`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_overridable_library "bpy.types.bpy_struct.is_property_overridable_library") - [`bpy_struct.is_property_readonly`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_readonly "bpy.types.bpy_struct.is_property_readonly") - [`bpy_struct.is_property_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.is_property_set "bpy.types.bpy_struct.is_property_set") - [`bpy_struct.items`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.items "bpy.types.bpy_struct.items") | - [`bpy_struct.keyframe_delete`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_delete "bpy.types.bpy_struct.keyframe_delete") - [`bpy_struct.keyframe_insert`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keyframe_insert "bpy.types.bpy_struct.keyframe_insert") - [`bpy_struct.keys`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.keys "bpy.types.bpy_struct.keys") - [`bpy_struct.path_from_id`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_id "bpy.types.bpy_struct.path_from_id") - [`bpy_struct.path_from_module`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_from_module "bpy.types.bpy_struct.path_from_module") - [`bpy_struct.path_resolve`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.path_resolve "bpy.types.bpy_struct.path_resolve") - [`bpy_struct.pop`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.pop "bpy.types.bpy_struct.pop") - [`bpy_struct.property_overridable_library_set`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_overridable_library_set "bpy.types.bpy_struct.property_overridable_library_set") - [`bpy_struct.property_unset`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.property_unset "bpy.types.bpy_struct.property_unset") - [`bpy_struct.rna_ancestors`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.rna_ancestors "bpy.types.bpy_struct.rna_ancestors") - [`bpy_struct.type_recast`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.type_recast "bpy.types.bpy_struct.type_recast") - [`bpy_struct.values`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.values "bpy.types.bpy_struct.values") |


[User] What is Transform Operators and how is it used in Blender Python scripting?

[Assistant]
# Transform Operators

bpy.ops.transform.bbone_resize(*\**, *value=(1.0, 1.0, 1.0)*, *orient_type='GLOBAL'*, *orient_matrix=((0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0))*, *orient_matrix_type='GLOBAL'*, *constraint_axis=(False, False, False)*, *mirror=False*, *release_confirm=False*, *use_accurate=False*)
:   Scale selected bendy bones display size

    Parameters:
    :   - **value** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Display Size
        - **orient_type** (*enum in* *[**]**,* *(**optional**)*) – Orientation, Transformation orientation
        - **orient_matrix** ([`mathutils.Matrix`](mathutils.html#mathutils.Matrix "mathutils.Matrix") of 3 \* 3 items in [-inf, inf], (optional)) – Matrix
        - **orient_matrix_type** (*enum in* *[**]**,* *(**optional**)*) – Matrix Orientation
        - **constraint_axis** (*boolean array* *of* *3 items**,* *(**optional**)*) – Constraint Axis
        - **mirror** (*boolean**,* *(**optional**)*) – Mirror Editing
        - **release_confirm** (*boolean**,* *(**optional**)*) – Confirm on Release, Always confirm operation when releasing button
        - **use_accurate** (*boolean**,* *(**optional**)*) – Accurate, Use accurate transformation

bpy.ops.transform.bend(*\**, *value=0.0*, *mirror=False*, *use_proportional_edit=False*, *proportional_edit_falloff='SMOOTH'*, *proportional_size=1.0*, *use_proportional_connected=False*, *use_proportional_projected=False*, *snap=False*, *gpencil_strokes=False*, *center_override=(0.0, 0.0, 0.0)*, *release_confirm=False*, *use_accurate=False*)
:   Bend selected items between the 3D cursor and the mouse

    Parameters:
    :   - **value** (*float array* *of* *1 items in* *[**-inf**,* *inf**]**,* *(**optional**)*) – Angle
        - **mirror** (*boolean**,* *(**optional**)*) – Mirror Editing
        - **use_proportional_edit** (*boolean**,* *(**optional**)*) – Proportional Editing
        - **proportional_edit_falloff** (enum in [Proportional Falloff Items](bpy_types_enum_items/proportional_falloff_items.html#rna-enum-proportional-falloff-items), (optional)) – Proportional Falloff, Falloff type for proportional editing mode
        - **proportional_size** (*float in* *[**1e-06**,* *inf**]**,* *(**optional**)*) – Proportional Size
        - **use_proportional_connected** (*boolean**,* *(**optional**)*) – Connected
        - **use_proportional_projected** (*boolean**,* *(**optional**)*) – Projected (2D)
        - **snap** (*boolean**,* *(**optional**)*) – Use Snapping Options
        - **gpencil_strokes** (*boolean**,* *(**optional**)*) – Edit Grease Pencil, Edit selected Grease Pencil strokes
        - **center_override** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Center Override, Force using this center value (when set)
        - **release_confirm** (*boolean**,* *(**optional**)*) – Confirm on Release, Always confirm operation when releasing button
        - **use_accurate** (*boolean**,* *(**optional**)*) – Accurate, Use accurate transformation

bpy.ops.transform.create_orientation(*\**, *name=''*, *use_view=False*, *use=False*, *overwrite=False*)
:   Create transformation orientation from selection

    Parameters:
    :   - **name** (*string**,* *(**optional**,* *never None**)*) – Name, Name of the new custom orientation
        - **use_view** (*boolean**,* *(**optional**)*) – Use View, Use the current view instead of the active object to create the new orientation
        - **use** (*boolean**,* *(**optional**)*) – Use After Creation, Select orientation after its creation
        - **overwrite** (*boolean**,* *(**optional**)*) – Overwrite Previous, Overwrite previously created orientation with same name

bpy.ops.transform.delete_orientation()
:   Delete transformation orientation

bpy.ops.transform.edge_bevelweight(*\**, *value=0.0*, *snap=False*, *release_confirm=False*, *use_accurate=False*)
:   Change the bevel weight of edges

    Parameters:
    :   - **value** (*float in* *[**-1**,* *1**]**,* *(**optional**)*) – Factor
        - **snap** (*boolean**,* *(**optional**)*) – Use Snapping Options
        - **release_confirm** (*boolean**,* *(**optional**)*) – Confirm on Release, Always confirm operation when releasing button
        - **use_accurate** (*boolean**,* *(**optional**)*) – Accurate, Use accurate transformation

bpy.ops.transform.edge_crease(*\**, *value=0.0*, *snap=False*, *release_confirm=False*, *use_accurate=False*)
:   Change the crease of edges

    Parameters:
    :   - **value** (*float in* *[**-1**,* *1**]**,* *(**optional**)*) – Factor
        - **snap** (*boolean**,* *(**optional**)*) – Use Snapping Options
        - **release_confirm** (*boolean**,* *(**optional**)*) – Confirm on Release, Always confirm operation when releasing button
        - **use_accurate** (*boolean**,* *(**optional**)*) – Accurate, Use accurate transformation

bpy.ops.transform.edge_slide(*\**, *value=0.0*, *single_side=False*, *use_even=False*, *flipped=False*, *use_clamp=True*, *mirror=False*, *snap=False*, *snap_elements={'INCREMENT'}*, *use_snap_project=False*, *snap_target='CLOSEST'*, *use_snap_self=True*, *use_snap_edit=True*, *use_snap_nonedit=True*, *use_snap_selectable=False*, *snap_point=(0.0, 0.0, 0.0)*, *correct_uv=True*, *release_confirm=False*, *use_accurate=False*)
:   Slide an edge loop along a mesh

    Parameters:
    :   - **value** (*float in* *[**-10**,* *10**]**,* *(**optional**)*) – Factor
        - **single_side** (*boolean**,* *(**optional**)*) – Single Side
        - **use_even** (*boolean**,* *(**optional**)*) – Even, Make the edge loop match the shape of the adjacent edge loop
        - **flipped** (*boolean**,* *(**optional**)*) – Flipped, When Even mode is active, flips between the two adjacent edge loops
        - **use_clamp** (*boolean**,* *(**optional**)*) – Clamp, Clamp within the edge extents
        - **mirror** (*boolean**,* *(**optional**)*) – Mirror Editing
        - **snap** (*boolean**,* *(**optional**)*) – Use Snapping Options
        - **snap_elements** (enum set in [Snap Element Items](bpy_types_enum_items/snap_element_items.html#rna-enum-snap-element-items), (optional)) – Snap to Elements
        - **use_snap_project** (*boolean**,* *(**optional**)*) – Project Individual Elements
        - **snap_target** (enum in [Snap Source Items](bpy_types_enum_items/snap_source_items.html#rna-enum-snap-source-items), (optional)) – Snap Base, Point on source that will snap to target
        - **use_snap_self** (*boolean**,* *(**optional**)*) – Target: Include Active
        - **use_snap_edit** (*boolean**,* *(**optional**)*) – Target: Include Edit
        - **use_snap_nonedit** (*boolean**,* *(**optional**)*) – Target: Include Non-Edited
        - **use_snap_selectable** (*boolean**,* *(**optional**)*) – Target: Exclude Non-Selectable
        - **snap_point** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Point
        - **correct_uv** (*boolean**,* *(**optional**)*) – Correct UVs, Correct UV coordinates when transforming
        - **release_confirm** (*boolean**,* *(**optional**)*) – Confirm on Release, Always confirm operation when releasing button
        - **use_accurate** (*boolean**,* *(**optional**)*) – Accurate, Use accurate transformation

bpy.ops.transform.from_gizmo()
:   Transform selected items by mode type

bpy.ops.transform.mirror(*\**, *orient_type='GLOBAL'*, *orient_matrix=((0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0))*, *orient_matrix_type='GLOBAL'*, *constraint_axis=(False, False, False)*, *gpencil_strokes=False*, *center_override=(0.0, 0.0, 0.0)*, *release_confirm=False*, *use_accurate=False*)
:   Mirror selected items around one or more axes

    Parameters:
    :   - **orient_type** (*enum in* *[**]**,* *(**optional**)*) – Orientation, Transformation orientation
        - **orient_matrix** ([`mathutils.Matrix`](mathutils.html#mathutils.Matrix "mathutils.Matrix") of 3 \* 3 items in [-inf, inf], (optional)) – Matrix
        - **orient_matrix_type** (*enum in* *[**]**,* *(**optional**)*) – Matrix Orientation
        - **constraint_axis** (*boolean array* *of* *3 items**,* *(**optional**)*) – Constraint Axis
        - **gpencil_strokes** (*boolean**,* *(**optional**)*) – Edit Grease Pencil, Edit selected Grease Pencil strokes
        - **center_override** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Center Override, Force using this center value (when set)
        - **release_confirm** (*boolean**,* *(**optional**)*) – Confirm on Release, Always confirm operation when releasing button
        - **use_accurate** (*boolean**,* *(**optional**)*) – Accurate, Use accurate transformation

bpy.ops.transform.push_pull(*\**, *value=0.0*, *mirror=False*, *use_proportional_edit=False*, *proportional_edit_falloff='SMOOTH'*, *proportional_size=1.0*, *use_proportional_connected=False*, *use_proportional_projected=False*, *snap=False*, *center_override=(0.0, 0.0, 0.0)*, *release_confirm=False*, *use_accurate=False*)
:   Push/Pull selected items

    Parameters:
    :   - **value** (*float in* *[**-inf**,* *inf**]**,* *(**optional**)*) – Distance
        - **mirror** (*boolean**,* *(**optional**)*) – Mirror Editing
        - **use_proportional_edit** (*boolean**,* *(**optional**)*) – Proportional Editing
        - **proportional_edit_falloff** (enum in [Proportional Falloff Items](bpy_types_enum_items/proportional_falloff_items.html#rna-enum-proportional-falloff-items), (optional)) – Proportional Falloff, Falloff type for proportional editing mode
        - **proportional_size** (*float in* *[**1e-06**,* *inf**]**,* *(**optional**)*) – Proportional Size
        - **use_proportional_connected** (*boolean**,* *(**optional**)*) – Connected
        - **use_proportional_projected** (*boolean**,* *(**optional**)*) – Projected (2D)
        - **snap** (*boolean**,* *(**optional**)*) – Use Snapping Options
        - **center_override** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Center Override, Force using this center value (when set)
        - **release_confirm** (*boolean**,* *(**optional**)*) – Confirm on Release, Always confirm operation when releasing button
        - **use_accurate** (*boolean**,* *(**optional**)*) – Accurate, Use accurate transformation

bpy.ops.transform.resize(*\**, *value=(1.0, 1.0, 1.0)*, *mouse_dir_constraint=(0.0, 0.0, 0.0)*, *orient_type='GLOBAL'*, *orient_matrix=((0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0))*, *orient_matrix_type='GLOBAL'*, *constraint_axis=(False, False, False)*, *mirror=False*, *use_proportional_edit=False*, *proportional_edit_falloff='SMOOTH'*, *proportional_size=1.0*, *use_proportional_connected=False*, *use_proportional_projected=False*, *snap=False*, *snap_elements={'INCREMENT'}*, *use_snap_project=False*, *snap_target='CLOSEST'*, *use_snap_self=True*, *use_snap_edit=True*, *use_snap_nonedit=True*, *use_snap_selectable=False*, *snap_point=(0.0, 0.0, 0.0)*, *gpencil_strokes=False*, *texture_space=False*, *remove_on_cancel=False*, *use_duplicated_keyframes=False*, *center_override=(0.0, 0.0, 0.0)*, *release_confirm=False*, *use_accurate=False*)
:   Scale (resize) selected items

    Parameters:
    :   - **value** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale
        - **mouse_dir_constraint** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Mouse Directional Constraint
        - **orient_type** (*enum in* *[**]**,* *(**optional**)*) – Orientation, Transformation orientation
        - **orient_matrix** ([`mathutils.Matrix`](mathutils.html#mathutils.Matrix "mathutils.Matrix") of 3 \* 3 items in [-inf, inf], (optional)) – Matrix
        - **orient_matrix_type** (*enum in* *[**]**,* *(**optional**)*) – Matrix Orientation
        - **constraint_axis** (*boolean array* *of* *3 items**,* *(**optional**)*) – Constraint Axis
        - **mirror** (*boolean**,* *(**optional**)*) – Mirror Editing
        - **use_proportional_edit** (*boolean**,* *(**optional**)*) – Proportional Editing
        - **proportional_edit_falloff** (enum in [Proportional Falloff Items](bpy_types_enum_items/proportional_falloff_items.html#rna-enum-proportional-falloff-items), (optional)) – Proportional Falloff, Falloff type for proportional editing mode
        - **proportional_size** (*float in* *[**1e-06**,* *inf**]**,* *(**optional**)*) – Proportional Size
        - **use_proportional_connected** (*boolean**,* *(**optional**)*) – Connected
        - **use_proportional_projected** (*boolean**,* *(**optional**)*) – Projected (2D)
        - **snap** (*boolean**,* *(**optional**)*) – Use Snapping Options
        - **snap_elements** (enum set in [Snap Element Items](bpy_types_enum_items/snap_element_items.html#rna-enum-snap-element-items), (optional)) – Snap to Elements
        - **use_snap_project** (*boolean**,* *(**optional**)*) – Project Individual Elements
        - **snap_target** (enum in [Snap Source Items](bpy_types_enum_items/snap_source_items.html#rna-enum-snap-source-items), (optional)) – Snap Base, Point on source that will snap to target
        - **use_snap_self** (*boolean**,* *(**optional**)*) – Target: Include Active
        - **use_snap_edit** (*boolean**,* *(**optional**)*) – Target: Include Edit
        - **use_snap_nonedit** (*boolean**,* *(**optional**)*) – Target: Include Non-Edited
        - **use_snap_selectable** (*boolean**,* *(**optional**)*) – Target: Exclude Non-Selectable
        - **snap_point** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Point
        - **gpencil_strokes** (*boolean**,* *(**optional**)*) – Edit Grease Pencil, Edit selected Grease Pencil strokes
        - **texture_space** (*boolean**,* *(**optional**)*) – Edit Texture Space, Edit object data texture space
        - **remove_on_cancel** (*boolean**,* *(**optional**)*) – Remove on Cancel, Remove elements on cancel
        - **use_duplicated_keyframes** (*boolean**,* *(**optional**)*) – Duplicated Keyframes, Transform duplicated keyframes
        - **center_override** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Center Override, Force using this center value (when set)
        - **release_confirm** (*boolean**,* *(**optional**)*) – Confirm on Release, Always confirm operation when releasing button
        - **use_accurate** (*boolean**,* *(**optional**)*) – Accurate, Use accurate transformation

bpy.ops.transform.rotate(*\**, *value=0.0*, *orient_axis='Z'*, *orient_type='GLOBAL'*, *orient_matrix=((0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0))*, *orient_matrix_type='GLOBAL'*, *constraint_axis=(False, False, False)*, *mirror=False*, *use_proportional_edit=False*, *proportional_edit_falloff='SMOOTH'*, *proportional_size=1.0*, *use_proportional_connected=False*, *use_proportional_projected=False*, *snap=False*, *snap_elements={'INCREMENT'}*, *use_snap_project=False*, *snap_target='CLOSEST'*, *use_snap_self=True*, *use_snap_edit=True*, *use_snap_nonedit=True*, *use_snap_selectable=False*, *snap_point=(0.0, 0.0, 0.0)*, *gpencil_strokes=False*, *center_override=(0.0, 0.0, 0.0)*, *release_confirm=False*, *use_accurate=False*)
:   Rotate selected items

    Parameters:
    :   - **value** (*float in* *[**-inf**,* *inf**]**,* *(**optional**)*) – Angle
        - **orient_axis** (enum in [Axis Xyz Items](bpy_types_enum_items/axis_xyz_items.html#rna-enum-axis-xyz-items), (optional)) – Axis
        - **orient_type** (*enum in* *[**]**,* *(**optional**)*) – Orientation, Transformation orientation
        - **orient_matrix** ([`mathutils.Matrix`](mathutils.html#mathutils.Matrix "mathutils.Matrix") of 3 \* 3 items in [-inf, inf], (optional)) – Matrix
        - **orient_matrix_type** (*enum in* *[**]**,* *(**optional**)*) – Matrix Orientation
        - **constraint_axis** (*boolean array* *of* *3 items**,* *(**optional**)*) – Constraint Axis
        - **mirror** (*boolean**,* *(**optional**)*) – Mirror Editing
        - **use_proportional_edit** (*boolean**,* *(**optional**)*) – Proportional Editing
        - **proportional_edit_falloff** (enum in [Proportional Falloff Items](bpy_types_enum_items/proportional_falloff_items.html#rna-enum-proportional-falloff-items), (optional)) – Proportional Falloff, Falloff type for proportional editing mode
        - **proportional_size** (*float in* *[**1e-06**,* *inf**]**,* *(**optional**)*) – Proportional Size
        - **use_proportional_connected** (*boolean**,* *(**optional**)*) – Connected
        - **use_proportional_projected** (*boolean**,* *(**optional**)*) – Projected (2D)
        - **snap** (*boolean**,* *(**optional**)*) – Use Snapping Options
        - **snap_elements** (enum set in [Snap Element Items](bpy_types_enum_items/snap_element_items.html#rna-enum-snap-element-items), (optional)) – Snap to Elements
        - **use_snap_project** (*boolean**,* *(**optional**)*) – Project Individual Elements
        - **snap_target** (enum in [Snap Source Items](bpy_types_enum_items/snap_source_items.html#rna-enum-snap-source-items), (optional)) – Snap Base, Point on source that will snap to target
        - **use_snap_self** (*boolean**,* *(**optional**)*) – Target: Include Active
        - **use_snap_edit** (*boolean**,* *(**optional**)*) – Target: Include Edit
        - **use_snap_nonedit** (*boolean**,* *(**optional**)*) – Target: Include Non-Edited
        - **use_snap_selectable** (*boolean**,* *(**optional**)*) – Target: Exclude Non-Selectable
        - **snap_point** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf],


[User] Describe Inputs from the Blender manual or Python API, including usage steps and snippets.

[Assistant]
Vector
:   Texture coordinate to sample texture at;
    defaults to Generated texture coordinates if the socket is left unconnected.

Scale
:   Overall texture scale.

Distortion
:   Amount of distortion of the wave.

Detail
:   Amount of distortion noise detail.

Detail Scale
:   Scale of distortion noise.

Roughness
:   Blend between a smoother noise pattern, and rougher with sharper peaks.

Phase Offset
:   Position of the wave along the *Bands Direction*.
    This can be used as an input for more control over the distortion.


[User] Provide the full official documentation entry for OpenVDB File, preserving all code examples.

[Assistant]
File Path
:   The VDB file to use.

Sequence
:   Loads further VDB files, one for each frame in an animation. Much like with image sequences,
    all the files should have a numerical suffix in their name; so if you selected smoke-000.vdb
    in the *File Path*, there should be a smoke-001.vdb, a smoke-002.vdb and so on.

    Frames
    :   How many frames of the sequence to use.

    Start
    :   Scene frame at which the sequence should start.

    Offset
    :   How many frames of the sequence to skip at the beginning.

    Mode
    :   How the volume should behave before the sequence’s first frame (*Start*) and after its
        last (*Start* + *Frames*).

        Clip:
        :   Show nothing.

        Extend:
        :   Keep showing the first/last frame of the sequence.

        Repeat:
        :   Play the sequence again (and again, and again…).

        Ping-Pong:
        :   Play the sequence forwards, then backwards, then forwards again and so on.


[User] What is Multiple Importance Sampling and how is it used in Blender Python scripting?

[Assistant]
Materials with emission shaders can be configured to use
Multiple Importance Sampling ([Material Settings](../material_settings.html)).
This means that they will get rays sent directly towards them,
rather than ending up there based on rays randomly bouncing around.
For very bright mesh light sources, this can reduce noise significantly.
However, when the emission is not particularly bright,
this will take samples away from other brighter light sources for which it is important to find them this way.

The optimal setting here is difficult to guess; it may be a matter of trial and error,
but often it is clear that a somewhat glowing object may be only contributing light locally,
while a mesh light used as a light would need this option enabled.
Here is an example where the emissive spheres contribute little to the lighting,
and the image renders with slightly less noise by disabling Multiple Importance on them.

|  |  |
| --- | --- |
| <../../../_images/render_cycles_optimizations_reducing-noise_sample-lamp.jpg>   Multiple Importance off. | <../../../_images/render_cycles_optimizations_reducing-noise_no-sample-lamp.jpg>   Multiple Importance on. |

The world background also has a *Multiple Importance* ([Settings](../world_settings.html#render-cycles-integrator-world-settings)) option.
This is mostly useful for environment maps that have small bright spots in them, rather than being smooth.
This option will then, in a preprocess, determine the bright spots, and send light rays directly towards them. Again,
enabling this option may take samples away from more important light sources if it is not needed.