[go: up one dir, main page]
Menu ▾ ▴

[dfe9bc]: / dbr / image.py  Maximize  Restore  History

Download this file

94 lines (72 with data), 2.8 kB 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# ******************************************************

# * Copyright © 2017-2023 - Jordan Irwin (AntumDeluge) *

# ******************************************************

# * This software is licensed under the MIT license.   *

# * See: LICENSE.txt for details.                      *

# ******************************************************



## @module dbr.image



import os



import wx



from globals.paths import getBitmapsDir

from libdbr        import strings





## Retrieves an image from bitmaps dir & creates a wx.Cursor.

#

#  @param name

#    \b \e string : Base filename of the image.

#  @param size

#    \b \e int : Image size (denotes subfolder to search).

#  @param cat

#    Sub-directory to search for images.

#  @param img_type

#    \b \e string : Image type / filename suffix.

#  @return

#    \b \e string : Either pathname of image or None if file not found.

def GetImagePath(name, size=16, cat=None, img_type="png"):

  name = "{}.{}".format(name, img_type)



  if cat:

    b_paths = (getBitmapsDir(), cat, strings.toString(size), name)



  else:

    b_paths = (getBitmapsDir(), strings.toString(size), name)



  image_path = os.path.join(*b_paths)



  # Attempt to use failsafe image if file does not exists

  if not os.path.isfile(image_path):

    image_path = os.path.join(getBitmapsDir(), strings.toString(size), "failsafe.png")



  # Last resort is to return None if a failsafe image was not found

  if not os.path.isfile(image_path):

    return None



  return image_path





## Retrieves an image from bitmaps dir & creates a wx.Cursor.

#

#  @param name

#    \b \e string : Base filename of the image.

#  @param size

#    \b \e int : Image size (denotes subfolder to search).

#  @param cat

#    Sub-directory to search for images.

#  @param img_type

#    \b \e string : Image type / filename suffix.

#  @return

#    \b \e wx.Cursor : Either a new cursor using the retrieved image, or wx.NullCursor.

def GetCursor(name, size=16, cat=None, img_type="png"):

  image_path = GetImagePath(name, size, cat, img_type)



  if not image_path:

    return wx.NullCursor



  return wx.Cursor(image_path, wx.BITMAP_TYPE_PNG)





## Retrieves an image from bitmaps dir & creates a wx.Bitmap.

#

#  @param name

#    \b \e string : Base filename of the image.

#  @param size

#    \b \e int : Image size (denotes subfolder to search).

#  @param cat

#    Sub-directory to search for images.

#  @param img_type

#    \b \e string : Image type / filename suffix.

#  @return

#    Either a new \b \e wx.Bitmap using the retrieved image, or \b \e wx.NullBitmap.

def GetBitmap(name, size=16, cat=None, img_type="png"):

  image_path = GetImagePath(name, size, cat, img_type)



  if not image_path:

    #return wx.NullBitmap

    return wx.Bitmap(os.path.join(getBitmapsDir(), "24", "failsafe.png"))



  return wx.Bitmap(image_path, wx.BITMAP_TYPE_PNG)