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:

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

Static Public Member Functions
static WindowLogo	showDragengineLogo (Desktop desktop, ActionListener actionFinished)
	Show Drag[en]gine Game Engine logo and calling action if finished.
static WindowLogo	showImageLogo (Desktop desktop, Image image, ActionListener actionFinished)
	Convenience method to show image logo calling action if finished.
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.
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.
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.

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
CanvasView	pCanvasWidget
Clipboard	pClipboard
WidgetDesigner	pDesigner
String	pDesignerSelector
Font	pFont
FrameUpdater	pFrameUpdater
bool	pIsDesignerSet
Array	pKeyListeners
MousePointerFactory	pMousePointer
BorderSize	pPadding
Container	pParent
Point	pPosition
bool	pProtectBackgroundCanvasCreator
RepeatKeyEventTimer	pRepeatEventTimer
Color	pTextColor
GuiTheme	pTheme
String	pThemeSelector
String	pTitle
Object	pToolTip
TexMatrix2	pTransformation
TranslationManager	pTranslationManager
float	pTransparency
bool	pVisible

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

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

elapsed

Elapsed 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:

• WindowLogo.ds