Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.WindowLogo Class Reference

Window showing a logo image or video typically used while starting up a game. More...

Inheritance diagram for Dragengine.Gui.WindowLogo:
Dragengine.Gui.Window Dragengine.Gui.Container Dragengine.Gui.Widget

Classes

class  ActivateMicrophoneWhileShown
 Activate microphone while window is shown. More...
 
class  ShowLogoAction
 Action finished showing another WindowLogo. More...
 
enum  State
 States. More...
 

Public Member Functions

void dispose ()
 Dispose of Widget. More...
 
ActionListener getActionFinished ()
 Action listener to call when the window closes. More...
 
bool getAllowSkip ()
 Allow player to skip the logo. More...
 
float getElapsed ()
 Elapsed time in the current state. More...
 
Image getImageLogo ()
 Image logo or null if not set. More...
 
Microphone getMicrophone ()
 Window microphone. More...
 
Sound getSound ()
 Sound to play or null if not set. More...
 
Speaker getSpeakerSound ()
 Sound speaker. More...
 
Speaker getSpeakerVideo ()
 Video speaker. More...
 
State getState ()
 Current state. More...
 
float getTimeDelayAction ()
 Time in seconds to wait before calling action. More...
 
float getTimeDelayFadeIn ()
 Time in seconds to wait before fade in content. More...
 
float getTimeFadeIn ()
 Time in seconds to fade in content. More...
 
float getTimeFadeOut ()
 Time in seconds to fade out content. More...
 
float getTimeout ()
 Time in seconds to show content. More...
 
Video getVideoLogo ()
 Video logo or null if not set. More...
 
WindowLogo new ()
 Create window. More...
 
void onButtonRelease (MouseEvent event)
 Mouse button has been released. More...
 
void onFrameUpdate (float elapsed)
 Do frame update. More...
 
void onKeyRelease (KeyEvent event)
 Key on the keyboard has been released. More...
 
void setActionFinished (ActionListener listener)
 Set action listener to call when the window closes. More...
 
void setAllowSkip (bool allowSkip)
 Set if player is allowed to skip the logo. More...
 
void setBgStyle (String style)
 Set window style, for example "Bg1". More...
 
void setImageLogo (Image image)
 Set image logo or null if not set. More...
 
void setSound (Sound sound)
 Set sound to play or null if not set. More...
 
void setTimeDelayAction (float time)
 Set time in seconds to wait before calling action. More...
 
void setTimeDelayFadeIn (float time)
 Set time in seconds to wait before fade in content. More...
 
void setTimeFadeIn (float time)
 Set time in seconds to fade in content. More...
 
void setTimeFadeOut (float time)
 Set time in seconds to fade out content. More...
 
void setTimeout (float time)
 Set time in seconds to show content. More...
 
void setVideoLogo (Video video)
 Set video logo or null if not set. More...
 
void showLogo (Desktop desktop)
 Show window and start fading in. More...
 
void showLogo (Desktop desktop, ActionListener actionFinished)
 Show window and start fading in. More...
 
void skip ()
 Skip logo if not in READY or State.finished state. More...
 
- Public Member Functions inherited from Dragengine.Gui.Window
void activeWidgetGrabFocus ()
 
void addWindowListener (WindowListener listener)
 Add window listener. More...
 
void becomeBackgroundWindow ()
 Set window to act as a non-interactive background window. More...
 
void centerWindow ()
 Move window to the center of the parent desktop. More...
 
void close ()
 Close window. More...
 
void fitToContent ()
 Fit window size to content size. More...
 
bool getActivated ()
 Window is activated. More...
 
Widget getActiveWidget ()
 Active widget or null if there is none. More...
 
bool getAlwaysOnTop ()
 Window is always on top of all others. More...
 
WindowModal getBlockingWindow ()
 Modal window blocking this window or null. More...
 
bool getCanActivate ()
 Window can be activated. More...
 
bool getCanClose ()
 Window can be closed. More...
 
bool getCanMaximize ()
 Window can be maximized. More...
 
bool getCanMinimize ()
 Window can be minimized. More...
 
bool getCanMove ()
 Window can be moved. More...
 
bool getCanReorder ()
 Window can be reordered. More...
 
bool getCanResize ()
 Window can be resized. More...
 
Decoration getDecoration ()
 Decoration of window. More...
 
BorderSize getDecorationSize ()
 Get decoration size. More...
 
Color getModalDarkenColor ()
 Darkening color while modal window is in use. More...
 
bool getProtectDecoration ()
 Protect custom set decoration. More...
 
bool getProtectModalDarkenColor ()
 Protect custom set modal window darkening color. More...
 
Window getTopBlockingWindow ()
 Get top most blocking window or null. More...
 
Window getWindow ()
 Window or null if this widget is not part of a window. More...
 
Point getWindowPosition ()
 Widget position in window coordinates. More...
 
WindowState getWindowState ()
 Window state. More...
 
void grabFocus ()
 Grab the focus if possible. More...
 
void moveAbove (Window window)
 Move window right above the given window. More...
 
void moveBelow (Window window)
 Move window right below the given window. More...
 
void moveToBottom ()
 Move window to the bottom. More...
 
void moveToTop ()
 Move window to the top. More...
 
Window new (int x, int y, int width, int height)
 Create window with the given geometry. More...
 
Window new (Point position, Point size)
 Create window with the given geometry. More...
 
Widget nextFocusWidgetAfter (Widget widget)
 Find next widget in the focus cycle that can grab the focus. More...
 
void onDesignerChanged ()
 Designer changed. More...
 
void onDesignerSelectorChanged ()
 Designer selector changed. More...
 
void onDesktopResized ()
 Desktop size changed. More...
 
void onGuiThemeChanged ()
 Gui theme changed. More...
 
void onMaximized (WindowEvent event)
 Window has been maximized. More...
 
void onMinimized (WindowEvent event)
 Window has been minimized. More...
 
void onTranslationChanged ()
 Translation manager or active language pack changed. More...
 
Widget prevFocusWidgetAfter (Widget widget)
 Find previous widget in the focus cycle that can grab the focus. More...
 
void removeWindowListener (WindowListener listener)
 Remove window listener. More...
 
void requestClose ()
 Request closing window. More...
 
void requestGrabFocus (Widget widget)
 Request to focus the specified widget. More...
 
void sendEventToListeners (Event event, bool sendToParent)
 Send event to all appropriate listeners for events of its kind. More...
 
void setActivated (bool activated)
 Set if window is activated. More...
 
void setActiveWidget (Widget widget)
 Set active widget. More...
 
void setAlwaysOnTop (bool alwaysOnTop)
 Set if window is always on top of all others. More...
 
void setBlockingWindow (WindowModal window)
 Set modal window blocking this window or null. More...
 
void setCanActivate (bool canActivate)
 Set if window can be activated. More...
 
void setCanClose (bool canClose)
 Set if window can be closed. More...
 
void setCanMaximize (bool canMaximize)
 Set if window can be maximized. More...
 
void setCanMinimize (bool canMinimize)
 Set if window can be minimized. More...
 
void setCanMove (bool canMove)
 Set if window can be moved. More...
 
void setCanReorder (bool canReorder)
 Set if window can be reordered. More...
 
void setCanResize (bool canResize)
 Set window can be resized. More...
 
void setDecoration (Decoration decoration)
 Set decoration of window. More...
 
void setModalDarkenColor (Color color)
 Set darkening color while modal window is in use. More...
 
void setProtectDecoration (bool protect)
 Set protect custom set decoration. More...
 
void setProtectModalDarkenColor (bool protect)
 Set protect custom set modal window darkening color. More...
 
void setTitle (String title)
 Set window title. More...
 
void setWindowState (WindowState state)
 Set window state. More...
 
- Public Member Functions inherited from Dragengine.Gui.Container
void addWidget (Widget widget)
 
void addWidget (Widget widget, Object settings)
 
bool allowsChildGrabFocus ()
 
void doLayout ()
 
Widget findFocusableWidget ()
 
Widget findLastFocusableWidget ()
 
Widget findWidget (Block ablock)
 Find widget using block or null if not found. More...
 
int getContainerHeight ()
 
Point getContainerSize ()
 
int getContainerWidth ()
 
bool getHasBlockedDoLayout ()
 doLayout calls happened during runWhileBlockingLayout. More...
 
Layout getLayout ()
 
Point getMinimumSize ()
 
Point getMinimumSizeForHeight (int height)
 Minimum size of widget using reference widget height and variable width. More...
 
Point getMinimumSizeForWidth (int width)
 Minimum size of widget using reference widget width and variable height. More...
 
bool getStateChangeNotifyChildren ()
 Notify children if state changed. More...
 
Widget getWidget (int index)
 
Widget getWidgetAt (Point position)
 Widget at coordinates or null if not found. More...
 
int getWidgetCount ()
 
void giveUpFocus ()
 
bool hasFocusWidget ()
 Focus widget is inside container somewhere. More...
 
bool hasWidget (Widget widget)
 
int indexOfWidget (Widget widget)
 
Object injectWidget (Object injectValue, Block ablock)
 Process value visiting widgets using block. More...
 
bool isChildVisible (Widget child)
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
void layoutParent ()
 
void moveWidget (Widget widget, int newPosition)
 
Container new (Layout layout)
 Create container with layout. More...
 
Container new (Layout layout, Block blockAddContent)
 Create container with layout calling block to add content. More...
 
void onPaddingChanged ()
 Padding changed. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
void removeAllWidgets ()
 Remove and dispose all widgets. More...
 
void removeWidget (Widget widget)
 Remove widget without disposing. More...
 
bool requestCaptureMouse (Widget widget)
 
bool requestReleaseMouse (Widget widget)
 
void runWhileBlockingLayout (Block ablock)
 Run block while layouting is blocked. More...
 
void setEnabled (bool enabled)
 
void setHasBlockedDoLayout (bool hasBlockedDoLayout)
 Set if doLayout calls happened during runWhileBlockingLayout. More...
 
void setLayout (Layout layout)
 
void setMousePointer (MousePointerFactory mousePointer)
 Set mouse pointer to use. More...
 
void setStateChangeNotifyChildren (bool notify)
 Set to notify children if state changed. More...
 
- Public Member Functions inherited from Dragengine.Gui.Widget
void addDragListener (DragListener listener)
 
void addFocusListener (FocusListener listener)
 Add focus listener. More...
 
void addGamepadListener (GamepadListener listener)
 Add gamepad listener. More...
 
void addKeyListener (KeyListener listener)
 
void addMouseListener (MouseListener listener)
 
void addStateChangeListener (StateChangeListener listener)
 Add state change listener. More...
 
void addWidgetListener (WidgetListener listener)
 Add widget listener. More...
 
bool canGrabFullFocus ()
 
void captureMouse ()
 
void design ()
 Design widget using WidgetDesigner. More...
 
CanvasCreator getBackgroundCanvasCreator ()
 Background canvas creator or null to use background color. More...
 
bool getBlockLayoutParent ()
 Block layoutParent calls. More...
 
Border getBorder ()
 
BorderSize getBorderSize ()
 
RectArea getBoundary ()
 Rectangulare boundary of the widget. More...
 
RectArea getBoundaryWithBorder ()
 Rectangulare boundary of the widget including border. More...
 
bool getCanFocus ()
 
CanvasView getCanvasBackground ()
 
CanvasView getCanvasContent ()
 
CanvasView getCanvasWidget ()
 
Clipboard getClipboard ()
 Clipboard or null to use parent clipboard. More...
 
ColorMatrix getColorTransformation ()
 Color transformation. More...
 
WidgetDesigner getDesigner ()
 Designer. More...
 
String getDesignerSelector ()
 Designer selector. More...
 
Desktop getDesktop ()
 
Point getDesktopPosition ()
 Widget position in desktop coordinates. More...
 
bool getEnabled ()
 
MousePointerFactory getFirstMousePointer ()
 First assigned mouse pointer. More...
 
Font getFont ()
 
bool getHasBlockedLayoutParent ()
 layoutParent calls happened during runWhileBlockingLayoutParent. More...
 
bool getHasFocus ()
 
int getHeight ()
 Height of widget. More...
 
RangeModel getHorizontalRangeModel ()
 Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
 
Widget getHoverWidget ()
 Widget the mouse hovers above or null. More...
 
Point getLocalMouseLocation ()
 Parent desktop mouse location in widget coordinates. More...
 
Point getMinimumSizeWithBorder ()
 
Point getMinimumSizeWithBorderForHeight (int height)
 Minimum size of widget with border using reference height. More...
 
Point getMinimumSizeWithBorderForWidth (int width)
 Minimum size of widget with border for reference width. More...
 
MousePointerFactory getMousePointer ()
 Mouse pointer to use. More...
 
BorderSize getPadding ()
 Padding. More...
 
Container getParent ()
 
Point getPosition ()
 Position of the widget. More...
 
bool getProtectBackgroundCanvasCreator ()
 Protect custom set background canvas creator. More...
 
bool getProtectBorder ()
 Protect custom set border. More...
 
bool getProtectFont ()
 Protect custom set font. More...
 
bool getProtectMinimumSize ()
 Protect custom set minimumsize. More...
 
bool getProtectMousePointer ()
 Protect custom set mouse pointer. More...
 
bool getProtectPadding ()
 Protect custom set padding. More...
 
bool getProtectTextColor ()
 Protect custom set text color. More...
 
Point getRelativePosition (Container parent)
 Widget position in parent widget coordinates. More...
 
Point getScreenPosition ()
 Widget position in screen coordinates. More...
 
RectArea getScreenRectArea ()
 
Point getSetMinimumSize ()
 
Point getSize ()
 Size of the widget. More...
 
Color getTextColor ()
 Text color. More...
 
String getTitle ()
 Widget title. More...
 
Object getToolTip ()
 Tooltip or null. More...
 
float getTotalTransparency ()
 
TexMatrix2 getTransformation ()
 
float getTransparency ()
 
RangeModel getVerticalRangeModel ()
 Vertical range model for viewports to synchronize the vertical scrollbar. More...
 
bool getVisible ()
 
int getWidth ()
 Width of widget. More...
 
int getX ()
 X position of widget. More...
 
int getY ()
 Y position of widget. More...
 
bool hasParent (Container container)
 
bool isDesignerSet ()
 Custom designer is set. More...
 
bool isFullEnabled ()
 Widget and all parent widgets are enabled. More...
 
bool isMinimumSizeSet ()
 
bool isPointInside (Point position)
 
bool isTransformationSet ()
 
void layoutParentIfBlocked ()
 Calls layoutParent if getHasBlockedLayoutParent() is true. More...
 
Widget nextFocusWidget ()
 Find next widget in the focus cycle that can grab the focus. More...
 
void notifyBorderParametersChanged ()
 
void onDispose (WidgetEvent event)
 Window is disposing. More...
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGamepadButtonPressed (GamepadEvent event)
 Gamepad button has been pressed. More...
 
void onGamepadButtonReleased (GamepadEvent event)
 Gamepad button has been released. More...
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onParentStateChanged ()
 Parent state changed. More...
 
void onParentStateChanged (bool force)
 Parent state changed. More...
 
void onReposition (WidgetEvent event)
 Position changed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onSetFont ()
 
void onSetTextColor ()
 Text color changed. More...
 
void onShown (WidgetEvent event)
 Widget has been shown. More...
 
void popdownVirtualKeyboard ()
 Popdown virtual keyboard if Desktop has one assigned. More...
 
void popupVirtualKeyboard ()
 Popup virtual keyboard if Desktop has one assigned. More...
 
Widget prevFocusWidget ()
 Find previous widget in the focus cycle that can grab the focus. More...
 
void processEvent (Event event)
 
void releaseMouse ()
 
void removeDragListener (DragListener listener)
 
void removeFocusListener (FocusListener listener)
 Remove focus listener. More...
 
void removeGamepadListener (GamepadListener listener)
 Remove gamepad listener. More...
 
void removeKeyListener (KeyListener listener)
 
void removeMouseListener (MouseListener listener)
 
void removeStateChangeListener (StateChangeListener listener)
 Remove state change listener. More...
 
void removeWidgetListener (WidgetListener listener)
 Remove widget listener. More...
 
void runWhileBlockingLayoutParent (Block ablock)
 Run block while layouting is blocked. More...
 
void safeDispose ()
 Safely dispose of widget. More...
 
void sendEvent (Event event)
 
void setBackgroundCanvasCreator (CanvasCreator creator)
 Set background canvas creator or null to use background color. More...
 
void setBlockLayoutParent (bool blockLayoutParent)
 Set block layoutParent calls. More...
 
void setBorder (Border border)
 
void setCanFocus (bool canFocus)
 
void setClipboard (Clipboard clipboard)
 Set clipboard or null to use parent clipboard. More...
 
void setColorTransformation (ColorMatrix transformation)
 Set color transformation. More...
 
void setDesigner (WidgetDesigner designer)
 Set designer. More...
 
void setDesignerSelector (String selector)
 Set designer selector. More...
 
void setFont (Font font)
 
void setHasBlockedLayoutParent (bool hasBlockedLayoutParent)
 Set if layoutParent calls happened during runWhileBlockingLayoutParent. More...
 
void setHasFocus (bool hasFocus)
 
void setHeight (int height)
 Set height of widget. More...
 
void setMinimumSize (Point size)
 
void setPadding (BorderSize padding)
 Set padding. More...
 
void setParent (Container parent)
 
void setPosition (Point position)
 Set position of widget. More...
 
void setProtectBackgroundCanvasCreator (bool protect)
 Set protect custom set background canvas creator. More...
 
void setProtectBorder (bool protect)
 Set protect custom set border. More...
 
void setProtectFont (bool protect)
 Set protect custom set font. More...
 
void setProtectMinimumSize (bool protect)
 Set protect custom set minimumsize. More...
 
void setProtectMousePointer (bool protect)
 Set protect custom set mouse pointer. More...
 
void setProtectPadding (bool protect)
 Set protect custom set padding. More...
 
void setProtectTextColor (bool protect)
 Set protect custom set text color. More...
 
void setSize (Point size)
 Set size of widget. More...
 
void setTextColor (Color color)
 Set text color. More...
 
void setToolTip (Object toolTip)
 Set tooltip or null. More...
 
void setTransformation (TexMatrix2 transformation)
 
void setTransparency (float transparency)
 
void setVisible (bool visible)
 
void setWidth (int width)
 Set width of widget. More...
 
void setX (int x)
 Set X position of widget. More...
 
void setY (int y)
 Set Y Position of widget. More...
 
void startFrameUpdater ()
 Start frame updater if not running. More...
 
void stopFrameUpdater ()
 Stop frame updater if running. More...
 

Static Public Member Functions

static WindowLogo showDragengineLogo (Desktop desktop, ActionListener actionFinished)
 Show Drag[en]gine Game Engine logo and calling action if finished. More...
 
static WindowLogo showImageLogo (Desktop desktop, Image image, ActionListener actionFinished)
 Convenience method to show image logo calling action if finished. More...
 
static WindowLogo showImageLogo (Desktop desktop, Image image, float timeDelayFadeIn, float timeFadeIn, float timeFadeOut, float timeDelayAction, float timeout, ActionListener actionFinished)
 Convenience method to show image logo calling action if finished. More...
 
static WindowLogo showImageLogo (Desktop desktop, Image image, Sound sound, ActionListener actionFinished)
 
static WindowLogo showImageLogo (Desktop desktop, Image image, Sound sound, float timeDelayFadeIn, float timeFadeIn, float timeFadeOut, float timeDelayAction, float timeout, ActionListener actionFinished)
 
static WindowLogo showVideoLogo (Desktop desktop, Video video, ActionListener actionFinished)
 Convenience method to show video logo calling action if finished. More...
 
static WindowLogo showVideoLogo (Desktop desktop, Video video, float timeDelayFadeIn, float timeFadeIn, float timeFadeOut, float timeDelayAction, ActionListener actionFinished)
 Convenience method to show video logo calling action if finished. More...
 

Public Attributes

ActionListener pActionFinished
 
bool pAllowSkip
 
DisplayImage pDisplayImage
 
DisplayVideo pDisplayVideo
 
float pElapsed
 
Microphone pMicrophone
 
Panel pPanelContent
 
Speaker pSpeakerSound
 
Speaker pSpeakerVideo
 
State pState
 
float pTimeDelayAction
 
float pTimeDelayFadeIn
 
float pTimeFadeIn
 
float pTimeFadeOut
 
float pTimeout
 
- Public Attributes inherited from Dragengine.Gui.Window
bool pActivated
 
Widget pActiveWidget
 
bool pAlwaysOnTop
 
WindowModal pBlockingWindow
 
bool pCanActivate
 
bool pCanClose
 
bool pCanMaximize
 
bool pCanMinimize
 
bool pCanMove
 
bool pCanReorder
 
bool pCanResize
 
Decoration pDecoration
 
Color pModalDarkenColor
 
bool pProtectDecoration
 
bool pProtectModalDarkenColor
 
Array pWindowListeners
 
WindowState pWindowState
 
- Public Attributes inherited from Dragengine.Gui.Container
bool pBlockLayout
 
Point pCachedMinSize
 
int pCachedMinSizeForHeightHeight
 
Point pCachedMinSizeForHeightSize
 
Point pCachedMinSizeForWidthSize
 
int pCachedMinSizeForWidthWidth
 
Array pChildren
 
bool pHasBlockedDoLayout
 
Layout pLayout
 
bool pStateChangeNotifyChildren
 
- Public Attributes inherited from Dragengine.Gui.Widget
CanvasCreator pBackgroundCanvasCreator
 
bool pBlockLayoutParent
 
Border pBorder
 
bool pCanFocus
 
CanvasView pCanvasBackground
 
CanvasView pCanvasContent
 
CanvasView pCanvasWidget
 
Clipboard pClipboard
 
WidgetDesigner pDesigner
 
String pDesignerSelector
 
Array pDragListeners
 
bool pEnabled
 
Array pFocusListeners
 
Font pFont
 
FrameUpdater pFrameUpdater
 
Array pGamepadListeners
 
bool pHasBlockedLayoutParent
 
bool pHasFocus
 
bool pIsDesignerSet
 
Array pKeyListeners
 
Point pMinSize
 
Array pMouseListeners
 
MousePointerFactory pMousePointer
 
BorderSize pPadding
 
Container pParent
 
Point pPosition
 
bool pProtectBackgroundCanvasCreator
 
bool pProtectBorder
 
bool pProtectFont
 
bool pProtectMinimumSize
 
bool pProtectMousePointer
 
bool pProtectPadding
 
bool pProtectTextColor
 
RepeatKeyEventTimer pRepeatEventTimer
 
Point pSize
 
Array pStateChangeListeners
 
Color pTextColor
 
GuiTheme pTheme
 
String pThemeSelector
 
String pTitle
 
Object pToolTip
 
TexMatrix2 pTransformation
 
TranslationManager pTranslationManager
 
float pTransparency
 
bool pVisible
 
Array pWidgetListeners
 

Protected Member Functions

void createWindowContent ()
 Create window content. More...
 
DisplayImage getDisplayImage ()
 Display image widget. More...
 
DisplayVideo getDisplayVideo ()
 Display video widget. More...
 
Panel getPanelContent ()
 Content panel. More...
 
void onFadeInBegin ()
 Begin fading in. More...
 
void onFadeInEnd ()
 Finished fading in. More...
 
void onFadeOutBegin ()
 Begin fading out. More...
 
void onFadeOutEnd ()
 Finished fading out. More...
 
void onPlayerSkip ()
 Player wants to skip. More...
 
void setElapsed (float elapsed)
 Set elapsed time in the current state. More...
 
void setState (State state)
 Set current state. More...
 
void updateTransparency ()
 Update content transparency depending on state and elapsed time. More...
 
- Protected Member Functions inherited from Dragengine.Gui.Window
void setDecorationFromDesigner ()
 Set decoration from designer if not protected. More...
 
void updateCanvasGeometry ()
 Update canvas position and size. More...
 
- Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner getDesignerFromTheme ()
 Get designer from gui theme. More...
 
void updateCanvasBackground ()
 Update background canvas content. More...
 

Detailed Description

Window showing a logo image or video typically used while starting up a game.

Window composes of a single panel containing a widget stack of a DisplayVideo and a DisplayImage ontop of it. Usually either a video or an image is assigned but both can be used to have a video overlay. The window background can be styled using setBgStyle(). This assigns the window the designer selector "WindowLogo.{style-name}". Typically this extends the basic Window designer with a background image paired with padding for example to show a company logo at all times at the bottom or adding a framing. The image and video widget can also be styled using "Image.WindowLogo" and "Video.WindowLogo". The content panel stack layout is set to fit the video and image into the window without changing the aspect ratio. This potentially leaves the background of the window visible so you might want to style the background for this case.

Optionally fading in and out the panel with the image and video is supported. This can be used for image where you can not encode fading like with videos.

Once the video finished playing and after a timeout the window is closed and an assigned ActionListener is called.

Member Function Documentation

◆ createWindowContent()

void Dragengine.Gui.WindowLogo.createWindowContent ( )
protected

Create window content.

Called during constructor time.

◆ dispose()

void Dragengine.Gui.WindowLogo.dispose ( )

Dispose of Widget.

Reimplemented from Dragengine.Gui.Window.

◆ getActionFinished()

ActionListener Dragengine.Gui.WindowLogo.getActionFinished ( )

Action listener to call when the window closes.

◆ getAllowSkip()

bool Dragengine.Gui.WindowLogo.getAllowSkip ( )

Allow player to skip the logo.

◆ getDisplayImage()

DisplayImage Dragengine.Gui.WindowLogo.getDisplayImage ( )
protected

Display image widget.

◆ getDisplayVideo()

DisplayVideo Dragengine.Gui.WindowLogo.getDisplayVideo ( )
protected

Display video widget.

◆ getElapsed()

float Dragengine.Gui.WindowLogo.getElapsed ( )

Elapsed time in the current state.

◆ getImageLogo()

Image Dragengine.Gui.WindowLogo.getImageLogo ( )

Image logo or null if not set.

◆ getMicrophone()

Microphone Dragengine.Gui.WindowLogo.getMicrophone ( )

Window microphone.

◆ getPanelContent()

Panel Dragengine.Gui.WindowLogo.getPanelContent ( )
protected

Content panel.

◆ getSound()

Sound Dragengine.Gui.WindowLogo.getSound ( )

Sound to play or null if not set.

◆ getSpeakerSound()

Speaker Dragengine.Gui.WindowLogo.getSpeakerSound ( )

Sound speaker.

◆ getSpeakerVideo()

Speaker Dragengine.Gui.WindowLogo.getSpeakerVideo ( )

Video speaker.

◆ getState()

State Dragengine.Gui.WindowLogo.getState ( )

Current state.

◆ getTimeDelayAction()

float Dragengine.Gui.WindowLogo.getTimeDelayAction ( )

Time in seconds to wait before calling action.

◆ getTimeDelayFadeIn()

float Dragengine.Gui.WindowLogo.getTimeDelayFadeIn ( )

Time in seconds to wait before fade in content.

◆ getTimeFadeIn()

float Dragengine.Gui.WindowLogo.getTimeFadeIn ( )

Time in seconds to fade in content.

◆ getTimeFadeOut()

float Dragengine.Gui.WindowLogo.getTimeFadeOut ( )

Time in seconds to fade out content.

◆ getTimeout()

float Dragengine.Gui.WindowLogo.getTimeout ( )

Time in seconds to show content.

◆ getVideoLogo()

Video Dragengine.Gui.WindowLogo.getVideoLogo ( )

Video logo or null if not set.

◆ new()

WindowLogo Dragengine.Gui.WindowLogo.new ( )

Create window.

Reimplemented from Dragengine.Gui.Window.

◆ onButtonRelease()

void Dragengine.Gui.WindowLogo.onButtonRelease ( MouseEvent  event)

Mouse button has been released.

◆ onFadeInBegin()

void Dragengine.Gui.WindowLogo.onFadeInBegin ( )
protected

Begin fading in.

◆ onFadeInEnd()

void Dragengine.Gui.WindowLogo.onFadeInEnd ( )
protected

Finished fading in.

Called after video has started playing.

◆ onFadeOutBegin()

void Dragengine.Gui.WindowLogo.onFadeOutBegin ( )
protected

Begin fading out.

Called before finished action is triggered.

◆ onFadeOutEnd()

void Dragengine.Gui.WindowLogo.onFadeOutEnd ( )
protected

Finished fading out.

Called before finished action is triggered. Window.close() will be called after this method returns.

◆ onFrameUpdate()

void Dragengine.Gui.WindowLogo.onFrameUpdate ( float  elapsed)

Do frame update.

Called every frame update if startFrameUpdater() is called.

Parameters
elapsedElapsed time since the last frame update. Equals Engine.getElapsedTime().

Reimplemented from Dragengine.Gui.Widget.

◆ onKeyRelease()

void Dragengine.Gui.WindowLogo.onKeyRelease ( KeyEvent  event)

Key on the keyboard has been released.

◆ onPlayerSkip()

void Dragengine.Gui.WindowLogo.onPlayerSkip ( )
protected

Player wants to skip.

◆ setActionFinished()

void Dragengine.Gui.WindowLogo.setActionFinished ( ActionListener  listener)

Set action listener to call when the window closes.

◆ setAllowSkip()

void Dragengine.Gui.WindowLogo.setAllowSkip ( bool  allowSkip)

Set if player is allowed to skip the logo.

◆ setBgStyle()

void Dragengine.Gui.WindowLogo.setBgStyle ( String  style)

Set window style, for example "Bg1".

◆ setElapsed()

void Dragengine.Gui.WindowLogo.setElapsed ( float  elapsed)
protected

Set elapsed time in the current state.

◆ setImageLogo()

void Dragengine.Gui.WindowLogo.setImageLogo ( Image  image)

Set image logo or null if not set.

◆ setSound()

void Dragengine.Gui.WindowLogo.setSound ( Sound  sound)

Set sound to play or null if not set.

◆ setState()

void Dragengine.Gui.WindowLogo.setState ( State  state)
protected

Set current state.

◆ setTimeDelayAction()

void Dragengine.Gui.WindowLogo.setTimeDelayAction ( float  time)

Set time in seconds to wait before calling action.

◆ setTimeDelayFadeIn()

void Dragengine.Gui.WindowLogo.setTimeDelayFadeIn ( float  time)

Set time in seconds to wait before fade in content.

◆ setTimeFadeIn()

void Dragengine.Gui.WindowLogo.setTimeFadeIn ( float  time)

Set time in seconds to fade in content.

◆ setTimeFadeOut()

void Dragengine.Gui.WindowLogo.setTimeFadeOut ( float  time)

Set time in seconds to fade out content.

◆ setTimeout()

void Dragengine.Gui.WindowLogo.setTimeout ( float  time)

Set time in seconds to show content.

◆ setVideoLogo()

void Dragengine.Gui.WindowLogo.setVideoLogo ( Video  video)

Set video logo or null if not set.

◆ showDragengineLogo()

static WindowLogo Dragengine.Gui.WindowLogo.showDragengineLogo ( Desktop  desktop,
ActionListener  actionFinished 
)
static

Show Drag[en]gine Game Engine logo and calling action if finished.

It is not required to show the Drag[en]gine Game Engine logo if you are using this game engine for whatever purpose but we would appreciate it if you do so.

◆ showImageLogo() [1/4]

static WindowLogo Dragengine.Gui.WindowLogo.showImageLogo ( Desktop  desktop,
Image  image,
ActionListener  actionFinished 
)
static

Convenience method to show image logo calling action if finished.

Same as creating window, assigining the image and calling showLogo(). Uses these values:

  • Time delay fade in: 1s
  • Time fade in: 2s
  • Time fade out: 2s
  • Time delay action: 1s
  • Timeout before fade out: 5s

◆ showImageLogo() [2/4]

static WindowLogo Dragengine.Gui.WindowLogo.showImageLogo ( Desktop  desktop,
Image  image,
float  timeDelayFadeIn,
float  timeFadeIn,
float  timeFadeOut,
float  timeDelayAction,
float  timeout,
ActionListener  actionFinished 
)
static

Convenience method to show image logo calling action if finished.

Same as creating window, assigining the image and calling showLogo().

◆ showImageLogo() [3/4]

static WindowLogo Dragengine.Gui.WindowLogo.showImageLogo ( Desktop  desktop,
Image  image,
Sound  sound,
ActionListener  actionFinished 
)
static

◆ showImageLogo() [4/4]

static WindowLogo Dragengine.Gui.WindowLogo.showImageLogo ( Desktop  desktop,
Image  image,
Sound  sound,
float  timeDelayFadeIn,
float  timeFadeIn,
float  timeFadeOut,
float  timeDelayAction,
float  timeout,
ActionListener  actionFinished 
)
static

◆ showLogo() [1/2]

void Dragengine.Gui.WindowLogo.showLogo ( Desktop  desktop)

Show window and start fading in.

Once finished stored action finished is called.

◆ showLogo() [2/2]

void Dragengine.Gui.WindowLogo.showLogo ( Desktop  desktop,
ActionListener  actionFinished 
)

Show window and start fading in.

Once finished actionFinished is called.

◆ showVideoLogo() [1/2]

static WindowLogo Dragengine.Gui.WindowLogo.showVideoLogo ( Desktop  desktop,
Video  video,
ActionListener  actionFinished 
)
static

Convenience method to show video logo calling action if finished.

Same as creating window, assigining the video and calling showLogo().

Uses these values:

  • Time delay fade in: 1s
  • Time fade in: 0s
  • Time fade out: 0s
  • Time delay action: 1s

◆ showVideoLogo() [2/2]

static WindowLogo Dragengine.Gui.WindowLogo.showVideoLogo ( Desktop  desktop,
Video  video,
float  timeDelayFadeIn,
float  timeFadeIn,
float  timeFadeOut,
float  timeDelayAction,
ActionListener  actionFinished 
)
static

Convenience method to show video logo calling action if finished.

Same as creating window, assigining the video and calling showLogo().

◆ skip()

void Dragengine.Gui.WindowLogo.skip ( )

Skip logo if not in READY or State.finished state.

Sets the state to State.finished, hides the window then calls the action finished if present.

◆ updateTransparency()

void Dragengine.Gui.WindowLogo.updateTransparency ( )
protected

Update content transparency depending on state and elapsed time.

Member Data Documentation

◆ pActionFinished

ActionListener Dragengine.Gui.WindowLogo.pActionFinished

◆ pAllowSkip

bool Dragengine.Gui.WindowLogo.pAllowSkip

◆ pDisplayImage

DisplayImage Dragengine.Gui.WindowLogo.pDisplayImage

◆ pDisplayVideo

DisplayVideo Dragengine.Gui.WindowLogo.pDisplayVideo

◆ pElapsed

float Dragengine.Gui.WindowLogo.pElapsed

◆ pMicrophone

Microphone Dragengine.Gui.WindowLogo.pMicrophone

◆ pPanelContent

Panel Dragengine.Gui.WindowLogo.pPanelContent

◆ pSpeakerSound

Speaker Dragengine.Gui.WindowLogo.pSpeakerSound

◆ pSpeakerVideo

Speaker Dragengine.Gui.WindowLogo.pSpeakerVideo

◆ pState

State Dragengine.Gui.WindowLogo.pState

◆ pTimeDelayAction

float Dragengine.Gui.WindowLogo.pTimeDelayAction

◆ pTimeDelayFadeIn

float Dragengine.Gui.WindowLogo.pTimeDelayFadeIn

◆ pTimeFadeIn

float Dragengine.Gui.WindowLogo.pTimeFadeIn

◆ pTimeFadeOut

float Dragengine.Gui.WindowLogo.pTimeFadeOut

◆ pTimeout

float Dragengine.Gui.WindowLogo.pTimeout

The documentation for this class was generated from the following file: