EditorResourcePreviewGenerator
继承： RefCounted < Object
Custom generator of previews.
描述
Custom code to generate previews. Please check file_dialog/thumbnail_size in EditorSettings to find out the right size to do previews at.
方法
bool | _can_generate_small_preview ( ) virtual1 const2 |
Texture2D | _generate ( resource: Resource, size: Vector2i, metadata: Dictionary ) virtual1 const2 |
Texture2D | _generate_from_path ( path: String, size: Vector2i, metadata: Dictionary ) virtual1 const2 |
bool | _generate_small_preview_automatically ( ) virtual1 const2 |
bool | _handles ( type: String ) virtual1 const2 |
方法说明
bool _can_generate_small_preview ( ) virtual1 const2
If this function returns true, the generator will call _generate or _generate_from_path for small previews as well.
By default, it returns false.
Texture2D _generate ( resource: Resource, size: Vector2i, metadata: Dictionary ) virtual1 const2
Generate a preview from a given resource with the specified size. This must always be implemented.
Returning null is an OK way to fail and let another generator take care.
Care must be taken because this function is always called from a thread (not the main thread).
metadata dictionary can be modified to store file-specific metadata that can be used in EditorResourceTooltipPlugin._make_tooltip_for_path (like image size, sample length etc.).
Texture2D _generate_from_path ( path: String, size: Vector2i, metadata: Dictionary ) virtual1 const2
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call _generate.
Returning null is an OK way to fail and let another generator take care.
Care must be taken because this function is always called from a thread (not the main thread).
metadata dictionary can be modified to store file-specific metadata that can be used in EditorResourceTooltipPlugin._make_tooltip_for_path (like image size, sample length etc.).
bool _generate_small_preview_automatically ( ) virtual1 const2
If this function returns true, the generator will automatically generate the small previews from the normal preview texture generated by the methods _generate or _generate_from_path.
By default, it returns false.
bool _handles ( type: String ) virtual1 const2
Returns true if your generator supports the resource of type type.
本方法通常需要用户覆盖才能生效。
本方法无副作用，不会修改该实例的任何成员变量。
本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。
本方法用于构造某个类型。
调用本方法无需实例，可直接使用类名进行调用。
本方法描述的是使用本类型作为左操作数的有效运算符。
这个值是由下列位标志构成位掩码的整数。
无返回值。