user: What is Bpy.Types.Object and how is it used in Blender Python scripting?

assistant: lacement_deformed Return type : mathutils.Vector of 3 items in [-inf, inf] crazyspace_displacement_to_original ( * , vertex_index = 0 , displacement = (0.0, 0.0, 0.0) ) ¶ Free evaluated state of crazyspace Parameters : vertex_index ( int in [ -inf , inf ] , ( optional ) ) – vertex_index displacement ( mathutils.Vector of 3 items in [-inf, inf], (optional)) – displacement Returns : displacement_original Return type : mathutils.Vector of 3 items in [-inf, inf] crazyspace_eval_clear ( ) ¶ crazyspace_eval_clear to_mesh ( * , preserve_all_data_layers = False , depsgraph = None ) ¶ Create a Mesh data-block from the current state of the object. The object owns the data-block. To force free it use to_mesh_clear(). The result is temporary and cannot be used by objects from the main database. Parameters : preserve_all_data_layers ( boolean , ( optional ) ) – Preserve all data layers in the mesh, like UV maps and vertex groups. By default Blender only computes the subset of data layers needed for viewport display and rendering, for better performance. depsgraph ( Depsgraph , (optional)) – Dependency Graph, Evaluated dependency graph which is required when preserve_all_data_layers is true Returns : Mesh created from object Return type : Mesh to_mesh_clear ( ) ¶ Clears mesh data-block created by to_mesh() to_curve ( depsgraph , * , apply_modifiers = False ) ¶ Create a Curve data-block from the current state of the object. This only works for curve and text objects. The object owns the data-block. To force free it, use to_curve_clear(). The result is temporary and cannot be used by objects from the main database. Parameters : depsgraph ( Depsgraph ) – Dependency Graph, Evaluated dependency graph apply_modifiers ( boolean , ( optional ) ) – Apply the deform modifiers on the control points of the curve. This is only supported for curve objects. Returns : Curve created from object Return type : Curve to_curve_clear ( ) ¶ Clears curve data-block created by to_curve() find_armature ( ) ¶ Find armature influencing this object as a parent or via a modifier Returns : Armature object influencing this object or nullptr Return type : Object shape_key_add ( * , name = 'Key' , from_mix = True ) ¶ Add shape key to this object Parameters : name ( string , ( optional , never None ) ) – Unique name for the new key-block from_mix ( boolean , ( optional ) ) – Create new shape from existing mix of shapes Returns : New shape key-block Return type : ShapeKey shape_key_remove ( key ) ¶ Remove a Shape Key from this object Parameters : key ( ShapeKey , (never None)) – Key-block to be removed shape_key_clear ( ) ¶ Remove all Shape Keys from this object ray_cast ( origin , direction , * , distance = 1.70141e+38 , depsgraph = None ) ¶ Cast a ray onto evaluated geometry, in object space (using context’s or provided depsgraph to get evaluated mesh if needed) Parameters : origin ( mathutils.Vector of 3 items in [-inf, inf]) – Origin of the ray, in object space direction ( mathutils.Vector of 3 items in [-inf, inf]) – Direction of the ray, in object space distance ( float in [ 0 , inf ] , ( optional ) ) – Maximum distance depsgraph ( Depsgraph , (optional)) – Depsgraph to use to get evaluated data, when called from original object (only needed if current Context’s depsgraph is not suitable) Returns : result , Whether the ray successfully hit the geometry, boolean location , The hit location of this ray cast, mathutils.Vector of 3 items in [-inf, inf] normal , The face normal at the ray cast hit location, mathutils.Vector of 3 items in [-inf, inf] index , The face index, -1 when original data isn’t available, int in [-inf, inf] Return type : (boolean, mathutils.Vector of 3 items in [-inf, inf], mathutils.Vector of 3 items in [-inf, inf], int in [-inf, inf]) closest_point_on_mesh ( origin , * , distance = 1.84467e+19 , depsgraph = None ) ¶ Find the nearest point on evaluated geometry, in object space (using context’s or provided depsgraph to get evaluated mesh if needed) Parameters : origin ( mathutils.Vector of 3 items in [-inf, inf]) – Point to find closest geometry from (in object space) distance ( float in [ 0 , inf ] , ( optional ) ) – Maximum distance depsgraph ( Depsgraph , (optional)) – Depsgraph to use to get evaluated data, when called from original object (only needed if current Context’s depsgraph is not suitable) Returns : result , Whether closest point on geometry was found, boolean location , The location on the object closest to the point, mathutils.Vector of 3 items in [-inf, inf] normal , The face normal at the closest point, mathutils.Vector of 3 items in [-inf, inf] index , The face index, -1 when original data isn’t available, int in [-inf, inf] Return type : (boolean, mathutils.Vector of 3 items in [-inf, inf], mathutils.Vector of 3 items in [-inf, inf], int in [-inf, inf]) is_modified ( scene , settings ) ¶ Determine if this object is modified from the base mesh data Parameters : scene ( Scene , (never None)) – Scene in which to check the object settings (enum in [ 'PREVIEW' , 'RENDER' ]) – Modifier settings to apply PREVIEW Preview – Apply modifier preview settings. RENDER Render – Apply modifier render settings. Returns : Whether the object is modified Return type : boolean is_deform_modified ( scene , settings ) ¶ Determine if this object is modified by a deformation from the base mesh data Parameters : scene ( Scene , (never None)) – Scene in which to check the object settings (enum in [ 'PREVIEW' , 'RENDER' ]) – Modifier settings to apply PREVIEW Preview – Apply modifier preview settings. RENDER Render – Apply modifier render settings. Returns : Whether the object is deform-modified Return type : boolean update_from_editmode ( ) ¶ Load the objects edit-mode data into the object data Returns : Success Return type : boolean cache_release ( ) ¶ Release memory used by caches associated with this object. Intended to be used by render engines only. evaluated_geometry ( ) ¶ Get the evaluated geometry set of this evaluated object. This only works for objects that contain geometry data like meshes and curves but not e.g. cameras. Returns : The evaluated geometry. Return type : bpy.types.GeometrySet 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 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 Inherited Properties ¶ bpy_struct.id_data ID.name ID.name_full ID.id_type ID.session_uid ID.is_evaluated ID.original ID.users ID.use_fake_user ID.use_extra_user ID.is_embedded_data ID.is_linked_packed ID.is_missing ID.is_runtime_data ID.is_editable ID.tag ID.is_library_indirect ID.library ID.library_weak_reference ID.asset_data ID.override_library ID.preview Inherited Functions ¶ bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors bpy_struct.type_recast bpy_struct.values ID.bl_system_properties_get ID.rename ID.evaluated_get ID.copy ID.asset_mark ID.asset_clear ID.asset_generate_preview ID.override_create ID.override_hierarchy_create ID.user_clear ID.user_remap ID.make_local ID.user_of_id ID.animation_data_create ID.animation_data_clear ID.update_tag ID.preview_ensure ID.bl_rna_get_subclass ID.bl_rna_get_subclass_py References ¶ bpy.context.active_object bpy.context.edit_object bpy.context.editable_objects bpy.context.image_paint_object bpy.context.object bpy.context.objects_in_mode bpy.context.objects_in_mode_unique_data bpy.context.particle_edit_object bpy.context.pose_object bpy.context.sculpt_object bpy.context.selectable_objects bpy.context.selected_editable_objects bpy.context.selected_objects bpy.context.vertex_paint_object bpy.context.visible_objects bpy.context.weight_paint_object Action.flip_with_pose ActionConstraint.target ArmatureModifier.object ArrayModifier.curve ArrayModifier.end_cap ArrayModifier.offset_object ArrayModifier.start_cap BlendData.objects BlendDataMeshes.new_from_object BlendDataObjects.new BlendDataObjects.remove BoidRuleAvoid.object BoidRuleFollowLeader.object BoidRuleGoal.object BooleanModifier.object CameraDOFSettings.focus_object CastModifier.object ChildOfConstraint.target ClampToConstraint.target Collection.all_objects Collection.objects CollectionObjects.link CollectionObjects.unlink Constraint.space_object ConstraintTarget.target ConstraintTargetBone.target CopyLocationConstraint.target CopyRotationConstraint.target CopyScaleConstraint.target CopyTransformsConstraint.target Curve.bevel_object Curve.taper_object CurveModifier.object Curves.surface CyclesRenderSettings.dicing_camera DampedTrackConstraint.target DataTransferModifier.object Depsgraph.objects DepsgraphObjectInstance.instance_object DepsgraphObjectInstance.object DepsgraphObjectInstance.parent DisplaceModifier.texture_coords_object DynamicPaintSurface.output_exists FieldSettings.source_object FloorConstraint.target FluidDomainSettings.guide_parent FollowPathConstraint.target FollowTrackConstraint.camera FollowTrackConstraint.depth_object GPencilSculptGuide.reference_object GeometryAttributeConstraint.target GeometryNodeInputObject.object GreasePencilArmatureModifier.object GreasePencilArrayModifier.offset_object GreasePencilBuildModifier.object GreasePencilHookModifier.object GreasePencilLatticeModifier.object GreasePencilLayer.parent GreasePencilLineartModifier.light_contour_object GreasePencilLineartModifier.source_camera GreasePencilLineartModifier.source_object GreasePencilMirrorModifier.object GreasePencilOutlineModifier.object GreasePencilShrinkwrapModifier.auxiliary_target GreasePencilShrinkwrapModifier.target GreasePencilTintModifier.object GreasePencilWeightProximityModifier.object HookModifier.object KinematicConstraint.pole_target KinematicConstraint.target LatticeModifier.object LayerObjects.active LayerObjects.selected LimitDistanceConstraint.target LineStyleAlphaModifier_DistanceFromObject.target LineStyleColorModifier_DistanceFromObject.target LineStyleThicknessModifier_DistanceFromObject.target LockedTrackConstraint.target MaskModifier.armature MeshDeformModifier.object MeshToVolumeModifier.object MirrorModifier.mirror_object NodeSocketObject.default_value NodeTreeInterfaceSocketObject.default_value NormalEditModifier.target Object.find_armature Object.parent ObjectBase.object ObjectSolverConstraint.camera ParticleEdit.object ParticleEdit.shape_object ParticleHairKey.co_object ParticleHairKey.co_object_set ParticleInstanceModifier.object ParticleSettings.instance_object ParticleSettingsTextureSlot.object ParticleSystem.co_hair ParticleSystem.parent ParticleSystem.reactor_target_object ParticleTarget.object PivotConstraint.target PoseBone.custom_shape RenderEngine.bake RenderEngine.camera_model_matrix RenderEngine.camera_override RenderEngine.camera_shift_x RenderEngine.use_spherical_stereo RigidBodyConstraint.object1 RigidBodyConstraint.object2 RigidBodyWorld.convex_sweep_test BakeSettings.cage_object Scene.camera Scene.objects Scene.ray_cast Scene.uvedit_aspect SceneStrip.scene_camera ScrewModifier.object Sculpt.gravity_object ShaderFxShadow.object ShaderFxSwirl.object ShaderNodeTexCoord.object ShrinkwrapConstraint.target ShrinkwrapModifier.auxiliary_target ShrinkwrapModifier.target SimpleDeformModifier.origin SpaceView3D.camera SpaceView3D.lock_object SplineIKConstraint.target StretchToConstraint.target SurfaceDeformModifier.target TextCurve.follow_curve TimelineMarker.camera ToolSettings.anim_mirror_object ToolSettings.anim_relative_object TrackToConstraint.target TransformConstraint.target UVProjector.object UVWarpModifier.object_from UVWarpModifier.object_to VertexWeightEditModifier.mask_tex_map_object VertexWeightMixModifier.mask_tex_map_object VertexWeightProximityModifier.mask_tex_map_object VertexWeightProximityModifier.target ViewLayer.objects VolumeDisplaceModifier.texture_map_object VolumeToMeshModifier.object WarpModifier.object_from WarpModifier.object_to WarpModifier.texture_coords_object WaveModifier.start_position_object WaveModifier.texture_coords_object XrSessionSettings.base_pose_object Next ObjectBase(bpy_struct) Previous NormalEditModifier(Modifier) Copyright &#169; Blender Authors Made with Furo Report issue on this page On this page Object(ID) Basic Object Operations Example Object Object.active_material Object.active_material_index Object.active_selection_set Object.active_shape_key Object.active_shape_key_index Object.add_rest_position_attribute Object.animation_data Object.animation_visualization Object.bound_box Object.collision Object.color Object.constraints Object.cycles Object.data Object.delta_location Object.delta_rotation_euler Object.delta_rotation_quaternion Object.delta_scale Object.dimensions Object.display Object.display_bounds_type Object.display_type Object.empty_display_size Object.empty_display_type Object.empty_image_depth Object.empty_image_offset Object.empty_image_side Object.field Object.hide_probe_plane Object.hide_probe_sphere Object.hide_probe_volume Object.hide_render Object.hide_select Object.hide_surface_pick Object.hide_viewport Object.image_user Object.instance_collection Object.instance_faces_scale Object.instance_type Object.is_from_instancer Object.is_from_set Object.is_holdout Object.is_instancer Object.is_shadow_catcher Object.light_linking Object.lightgroup Object.lineart Object.location Object.lock_location Object.lock_rotation Object.lock_rotation_w Object.lock_rotations_4d Object.lock_scale Object.material_slots Object.matrix_basis Object.matrix_local Object.matrix_parent_inverse Object.matrix_world Object.mode Object.modifiers Object.motion_path Object.parent Object.parent_bone Object.parent_type Object.parent_vertices Object.particle_systems Object.pass_index Object.pose Object.rigid_body Object.rigid_body_constraint Object.rotation_axis_angle Object.rotation_euler Object.rotation_mode Object.rotation_quaternion Object.scale Object.selection_sets Object.shader_effects Object.shadow_terminator_geometry_offset Object.shadow_terminator_normal_offset Object.shadow_terminator_shading_offset Object.show_all_edges Object.show_axis Object.show_bounds Object.show_empty_image_only_axis_aligned Object.show_empty_image_orthographic Object.show_empty_image_perspective Object.show_in_front Object.show_instancer_for_render Object.show_instancer_for_viewport Object.show_name Object.show_only_shape_key Object.show_texture_space Object.show_transparent Object.show_wire Object.soft_body Object.track_axis Object.type Object.up_axis Object.use_camera_lock_parent Object.use_dynamic_topology_sculpting Object.use_empty_image_alpha Object.use_grease_pencil_lights Object.use_instance_faces_scale Object.use_instance_vertices_rotation Object.use_mesh_mirror_x Object.use_mesh_mirror_y Object.use_mesh_mirror_z Object.use_parent_final_indices Object.use_shape_key_edit_mode Object.use_simulation_cache Object.vertex_groups Object.visible_camera Object.visible_diffuse Object.visible_glossy Object.visible_shadow Object.visible_transmission Object.visible_volume_scatter Object.children Object.children_recursive Object.users_collection Object.users_scene Object.select_get() Object.select_set() Object.hide_get() Object.hide_set() Object.visible_get() Object.holdout_get() Object.indirect_only_get() Object.local_view_get() Object.local_view_set() Object.visible_in_viewport_get() Object.convert_space() Object.calc_matrix_camera() Object.camera_fit_coords() Object.crazyspace_eval() Object.crazyspace_displacement_to_deformed() Object.crazyspace_displacement_to_original() Object.crazyspace_eval_clear() Object.to_mesh() Object.to_mesh_clear() Object.to_curve() Object.to_curve_clear() Object.find_armature() Object.shape_key_add() Object.shape_key_remove() Object.shape_key_clear() Object.ray_cast() Object.closest_point_on_mesh() Object.is_modified() Object.is_deform_modified() Object.update_from_editmode() Object.cache_release() Object.evaluated_geometry() Object.bl_rna_get_subclass() Object.bl_rna_get_subclass_py() Inherited Properties Inherited Functions References