| Both sides previous revisionPrevious revision | |
| dragengine:modules:dragonscript:xmlguitheme:mousepointer [2020/04/03 10:21] – url move dragonlord | dragengine:modules:dragonscript:xmlguitheme:mousepointer [2024/03/14 16:42] (current) – dragonlord |
|---|
| Mouse pointer factories are always based directly or indirectly on a type. This type is the //Mouse Pointer Prototype// and defines what instance of //MousePointerFactory// is used in the scripts. The choice of prototype affects the appearance of the mouse pointer and the factory configuration possibilities. | Mouse pointer factories are always based directly or indirectly on a type. This type is the //Mouse Pointer Prototype// and defines what instance of //MousePointerFactory// is used in the scripts. The choice of prototype affects the appearance of the mouse pointer and the factory configuration possibilities. |
| |
| The following prototypes are provided by default by the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1MousePointerFactories.html|MousePointerFactories]] script class: | The following prototypes are provided by default by the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1MousePointerFactories.html,MousePointerFactories~@# script class: |
| ^ Name ^ Script Class ^ Description ^ | ^ Name ^ Script Class ^ Description ^ |
| | [[#default|Default]] | [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1DefaultMousePointerFactory.html|DefaultMousePointerFactory]] | Default mouse pointer without visual appearance | | | [[#default|Default]] | #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1DefaultMousePointerFactory.html,DefaultMousePointerFactory~@# | Default mouse pointer without visual appearance | |
| | [[#image|Image]] | [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1ImageMousePointerFactory.html|ImageMousePointerFactory]] | Use image as mouse pointer | | | [[#image|Image]] | #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1ImageMousePointerFactory.html,ImageMousePointerFactory~@# | Use image as mouse pointer | |
| | [[#video|Video]] | [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1VideoMousePointerFactory.html|VideoMousePointerFactory]] | Use video as mouse pointer | | | [[#video|Video]] | #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1VideoMousePointerFactory.html,VideoMousePointerFactory~@# | Use video as mouse pointer | |
| | [[#canvascreator|CanvasCreator]] | [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1CanvasCreatorMousePointerFactory.html|CanvasCreatorMousePointerFactory]] | Use canvas creator as mouse pointer | | | [[#canvascreator|CanvasCreator]] | #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1CanvasCreatorMousePointerFactory.html,CanvasCreatorMousePointerFactory~@# | Use canvas creator as mouse pointer | |
| |
| You can use custom prototypes by adding them to [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1MousePointerFactories.html|MousePointerFactories]] instance before loading gui themes. This is useful if you created custom mouse pointer factory subclasses requiring custom parameters. | You can use custom prototypes by adding them to #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1MousePointerFactories.html,MousePointerFactories~@# instance before loading gui themes. This is useful if you created custom mouse pointer factory subclasses requiring custom parameters. |
| |
| This example defines an image mouse pointer factory based on the //Image// prototype. | This example defines an image mouse pointer factory based on the //Image// prototype. |
| |
| ===== Default ===== | ===== Default ===== |
| The most basic mouse pointer factory with no visual appearance. This equals no mouse pointer at all. Creates an instance of the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1DefaultMousePointerFactory.html|DefaultMousePointerFactory]] script class. | The most basic mouse pointer factory with no visual appearance. This equals no mouse pointer at all. Creates an instance of the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1DefaultMousePointerFactory.html,DefaultMousePointerFactory~@# script class. |
| |
| These parameters can be used: | These parameters can be used: |
| |
| ===== Image ===== | ===== Image ===== |
| Creates a mouse pointer factory using an image as mouse pointer. Creates an instance of the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1ImageMousePointerFactory.html|ImageMousePointerFactory]] script class. The image is drawn at an offset relative to the mouse pointer position. Make sure to set the right //size// parameter to match the image size. If not matching the image is scaled to fit the mouse pointer size. | Creates a mouse pointer factory using an image as mouse pointer. Creates an instance of the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1ImageMousePointerFactory.html,ImageMousePointerFactory~@# script class. The image is drawn at an offset relative to the mouse pointer position. Make sure to set the right //size// parameter to match the image size. If not matching the image is scaled to fit the mouse pointer size. |
| |
| These additional parameters compared to //Default// type can be used: | These additional parameters compared to //Default// type can be used: |
| |
| ===== Video ===== | ===== Video ===== |
| Creates a mouse pointer factory using a video as mouse pointer. Creates an instance of the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1VideoMousePointerFactory.html|VideoMousePointerFactory]] script class. The video is drawn at an offset relative to the mouse pointer position. Make sure to set the right //size// parameter to match the video size. If not matching the video is scaled to fit the mouse pointer size. The mouse pointer uses a video player to play the video at regular speed. | Creates a mouse pointer factory using a video as mouse pointer. Creates an instance of the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1VideoMousePointerFactory.html,VideoMousePointerFactory~@# script class. The video is drawn at an offset relative to the mouse pointer position. Make sure to set the right //size// parameter to match the video size. If not matching the video is scaled to fit the mouse pointer size. The mouse pointer uses a video player to play the video at regular speed. |
| |
| These additional parameters compared to //Default// type can be used: | These additional parameters compared to //Default// type can be used: |
| |
| ===== CanvasCreator ===== | ===== CanvasCreator ===== |
| Creates a mouse pointer factory using a canvas creator. Creates an instance of the [[https://developer.dragondreams.ch/docs/dragonscript/scriptapi/latest/classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1CanvasCreatorMousePointerFactory.html|CanvasCreatorMousePointerFactory]] script class. Make sure to set the right //size// parameter. The canvas creator is adjusted to fit into the set size. | Creates a mouse pointer factory using a canvas creator. Creates an instance of the #@LinkApiDocDEDS2_HTML~classDragengine_1_1Gui_1_1MousePointers_1_1Factories_1_1CanvasCreatorMousePointerFactory.html,CanvasCreatorMousePointerFactory~@# script class. Make sure to set the right //size// parameter. The canvas creator is adjusted to fit into the set size. |
| |
| These additional parameters compared to //Default// type can be used: | These additional parameters compared to //Default// type can be used: |
