Missing documentation for image_user parameter in template_image #105215

New Issue

Harry McKenzie · 2023-02-26T06:10:27+01:00

Harry McKenzie commented

2023-02-26 06:10:27 +01:00

System Information
Operating system: N/A
Graphics card: N/A

Blender Version
Broken: N/A
Worked: N/A

Short description of error
Missing documentation for image_user parameter in template_image in https://docs.blender.org/api/current/bpy.types.UILayout.html#bpy.types.UILayout.template_image

This documentation is crucial because we don't know what is to be passed as ImageUser. There was a question on Blender Stack Exchange asking the same thing: https://blender.stackexchange.com/questions/287185/what-should-be-the-value-of-image-user-in-template-user#287185

For example in this code, we wouldn't know what to pass as image_user

import bpy

class SetImageOperator(bpy.types.Operator):
    bl_idname = "my.set_image"
    bl_label = "Set Image"

    image_name: bpy.props.StringProperty()

    def execute(self, context):
        prop_group = context.scene.prop
        prop_group.image = bpy.data.images.get(self.image_name)
        return {'FINISHED'}

class MyPanel(bpy.types.Panel):
    bl_idname = "MY_PT_panel"
    bl_label = "My Panel"
    bl_space_type = "VIEW_3D"
    bl_region_type = "UI"

    def __init__(self):
        bpy.ops.my.set_image(image_name="Untitled")

    def draw(self, context):
        layout = self.layout
        prop_group = context.scene.prop
        row = layout.row()
        #==================================================
        image_user = ??? # What do you pass here???
        row.template_image(prop_group, "image", image_user)
        #==================================================

class Prop(bpy.types.PropertyGroup):
    image : bpy.props.PointerProperty(type=bpy.types.Image)

def register():
    bpy.utils.register_class(MyPanel)
    bpy.utils.register_class(Prop)
    bpy.utils.register_class(SetImageOperator)
    bpy.types.Scene.prop = bpy.props.PointerProperty(type=Prop)

def unregister():
    del bpy.types.Scene.prop
    bpy.utils.unregister_class(SetImageOperator)
    bpy.utils.unregister_class(Prop)
    bpy.utils.unregister_class(MyPanel)

if __name__ == "__main__":
    register()

**System Information** Operating system: N/A Graphics card: N/A **Blender Version** Broken: N/A Worked: N/A **Short description of error** Missing documentation for `image_user` parameter in `template_image` in https://docs.blender.org/api/current/bpy.types.UILayout.html#bpy.types.UILayout.template_image This documentation is crucial because we don't know what is to be passed as `ImageUser`. There was a question on Blender Stack Exchange asking the same thing: https://blender.stackexchange.com/questions/287185/what-should-be-the-value-of-image-user-in-template-user#287185 For example in this code, we wouldn't know what to pass as image_user ``` import bpy class SetImageOperator(bpy.types.Operator): bl_idname = "my.set_image" bl_label = "Set Image" image_name: bpy.props.StringProperty() def execute(self, context): prop_group = context.scene.prop prop_group.image = bpy.data.images.get(self.image_name) return {'FINISHED'} class MyPanel(bpy.types.Panel): bl_idname = "MY_PT_panel" bl_label = "My Panel" bl_space_type = "VIEW_3D" bl_region_type = "UI" def __init__(self): bpy.ops.my.set_image(image_name="Untitled") def draw(self, context): layout = self.layout prop_group = context.scene.prop row = layout.row() #================================================== image_user = ??? # What do you pass here??? row.template_image(prop_group, "image", image_user) #================================================== class Prop(bpy.types.PropertyGroup): image : bpy.props.PointerProperty(type=bpy.types.Image) def register(): bpy.utils.register_class(MyPanel) bpy.utils.register_class(Prop) bpy.utils.register_class(SetImageOperator) bpy.types.Scene.prop = bpy.props.PointerProperty(type=Prop) def unregister(): del bpy.types.Scene.prop bpy.utils.unregister_class(SetImageOperator) bpy.utils.unregister_class(Prop) bpy.utils.unregister_class(MyPanel) if __name__ == "__main__": register() ```

Harry McKenzie added the

labels 2023-02-26 06:10:28 +01:00

Iliya Katushenock added the