Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.DisplayVideo Class Reference
Inheritance diagram for Dragengine.Gui.DisplayVideo:
Dragengine.Gui.Widget

Public Member Functions

void advancePlayPosition (float seconds)
 Advance play position wrapping around. More...
 
void dispose ()
 Dispose of widget. More...
 
bool getLooping ()
 Looping playback. More...
 
Point getMinimumSize ()
 
float getPlayPosition ()
 Playback position in seconds. More...
 
float getPlayTime ()
 Get play time in seconds. More...
 
bool getProtectVideoColorTransform ()
 Protect custom set video color transform. More...
 
RepeatMode getRepeatMode ()
 
Speaker getSpeaker ()
 Speaker or null. More...
 
Video getVideo ()
 
ColorMatrix getVideoColorTransform ()
 Video color transform. More...
 
bool isPaused ()
 Video is paused. More...
 
bool isPlaying ()
 Video is playing back. More...
 
bool isStopped ()
 Video is stopped. More...
 
DisplayVideo new ()
 Create display video widget. More...
 
DisplayVideo new (Video video)
 
DisplayVideo new (Video video, RepeatMode repeatMode)
 
DisplayVideo new (Video video, RepeatMode repeatMode, bool autoPlay)
 
DisplayVideo new (Video video, RepeatMode repeatMode, bool autoPlay, Speaker speaker)
 
DisplayVideo new (Video video, String designerSelector)
 
void onFrameUpdate (float elapsed)
 Do frame update. More...
 
void onPaddingChanged ()
 Padding changed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
void pause ()
 Pause playback. More...
 
void play ()
 Start playback. More...
 
void setLooping (bool looping)
 Set if playback is looping. More...
 
void setPlayPosition (float position)
 Set playback position in seconds clamped to play range. More...
 
void setProtectVideoColorTransform (bool protect)
 Set protect custom set video color transform. More...
 
void setRepeatMode (RepeatMode repeatMode)
 
void setSpeaker (Speaker speaker)
 Set speaker or null. More...
 
void setVideo (Video video)
 
void setVideoColorTransform (ColorMatrix transform)
 Set color transformation. More...
 
void stop ()
 Stop playback. More...
 
void updateCanvasVideo ()
 
- 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...
 
Widget findFocusableWidget ()
 
Widget findLastFocusableWidget ()
 
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 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...
 
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 ()
 
Widget getWidgetAt (Point position)
 Widget at coordinates or null if not found. More...
 
int getWidth ()
 Width of widget. More...
 
Window getWindow ()
 
Point getWindowPosition ()
 Widget position in window coordinates. More...
 
int getX ()
 X position of widget. More...
 
int getY ()
 Y position of widget. More...
 
void grabFocus ()
 
bool hasParent (Container container)
 
bool isDesignerSet ()
 Custom designer is set. More...
 
bool isFullEnabled ()
 Widget and all parent widgets are enabled. More...
 
bool isMinimumSizeSet ()
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
bool isPointInside (Point position)
 
bool isTransformationSet ()
 
void layoutParent ()
 
void layoutParentIfBlocked ()
 Calls layoutParent if getHasBlockedLayoutParent() is true. More...
 
Widget new (int x, int y, int width, int height)
 Create widget with initial location and size. More...
 
Widget new (Point position, Point size)
 Create widget with initial location and size. More...
 
Widget nextFocusWidget ()
 Find next widget in the focus cycle that can grab the focus. More...
 
void notifyBorderParametersChanged ()
 
void onDesignerChanged ()
 Designer changed. More...
 
void onDesignerSelectorChanged ()
 Designer selector changed. More...
 
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 onGuiThemeChanged ()
 
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 onSetFont ()
 
void onSetTextColor ()
 Text color changed. More...
 
void onShown (WidgetEvent event)
 Widget has been shown. More...
 
void onTranslationChanged ()
 Translation manager or active language pack changed. 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 requestGrabFocus (Widget widget)
 
void runWhileBlockingLayoutParent (Block ablock)
 Run block while layouting is blocked. More...
 
void safeDispose ()
 Safely dispose of widget. More...
 
void sendEvent (Event event)
 
void sendEventToListeners (Event event, bool sendToParent)
 Send event to all appropriate listeners for events of its kind. More...
 
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 setEnabled (bool enabled)
 
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 setMousePointer (MousePointerFactory mousePointer)
 Set mouse pointer to use. More...
 
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 setTitle (String title)
 Set widget title. 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...
 

Public Attributes

CanvasVideoPlayer pCanvasVideo
 
bool pProtectVideoColorTransform
 
RepeatMode pRepeatMode
 
Speaker pSpeaker
 
Video pVideo
 
VideoPlayer pVideoPlayer
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner getDesignerFromTheme ()
 Get designer from gui theme. More...
 
void updateCanvasBackground ()
 Update background canvas content. More...
 
void updateCanvasGeometry ()
 Update canvas position and size. More...
 

Detailed Description

Displays video in the widget.

Uses a video player to play back the video. The widget updates the playback. To share video playback between multiple widgets use one DisplayVideo widget as the master and DisplayCanvas widgets as slave using getCanvasContent() as their source.

By default no audio is played if the video has audio. To play audio assign a Speaker.

Member Function Documentation

◆ advancePlayPosition()

void Dragengine.Gui.DisplayVideo.advancePlayPosition ( float  seconds)

Advance play position wrapping around.

Use this if you want to advance the play time in variable time steps independend of the game frame time. Negative values advance the time backward.

◆ dispose()

void Dragengine.Gui.DisplayVideo.dispose ( )

Dispose of widget.

Reimplemented from Dragengine.Gui.Widget.

◆ getLooping()

bool Dragengine.Gui.DisplayVideo.getLooping ( )

Looping playback.

◆ getMinimumSize()

Point Dragengine.Gui.DisplayVideo.getMinimumSize ( )

Minimal size of widget.

Reimplemented from Dragengine.Gui.Widget.

◆ getPlayPosition()

float Dragengine.Gui.DisplayVideo.getPlayPosition ( )

Playback position in seconds.

◆ getPlayTime()

float Dragengine.Gui.DisplayVideo.getPlayTime ( )

Get play time in seconds.

◆ getProtectVideoColorTransform()

bool Dragengine.Gui.DisplayVideo.getProtectVideoColorTransform ( )

Protect custom set video color transform.

◆ getRepeatMode()

RepeatMode Dragengine.Gui.DisplayVideo.getRepeatMode ( )

Repeat mode.

◆ getSpeaker()

Speaker Dragengine.Gui.DisplayVideo.getSpeaker ( )

Speaker or null.

◆ getVideo()

Video Dragengine.Gui.DisplayVideo.getVideo ( )

Video to display or null if not set.

◆ getVideoColorTransform()

ColorMatrix Dragengine.Gui.DisplayVideo.getVideoColorTransform ( )

Video color transform.

◆ isPaused()

bool Dragengine.Gui.DisplayVideo.isPaused ( )

Video is paused.

◆ isPlaying()

bool Dragengine.Gui.DisplayVideo.isPlaying ( )

Video is playing back.

◆ isStopped()

bool Dragengine.Gui.DisplayVideo.isStopped ( )

Video is stopped.

◆ new() [1/6]

DisplayVideo Dragengine.Gui.DisplayVideo.new ( )

Create display video widget.

Reimplemented from Dragengine.Gui.Widget.

◆ new() [2/6]

DisplayVideo Dragengine.Gui.DisplayVideo.new ( Video  video)

◆ new() [3/6]

DisplayVideo Dragengine.Gui.DisplayVideo.new ( Video  video,
RepeatMode  repeatMode 
)

◆ new() [4/6]

DisplayVideo Dragengine.Gui.DisplayVideo.new ( Video  video,
RepeatMode  repeatMode,
bool  autoPlay 
)

◆ new() [5/6]

DisplayVideo Dragengine.Gui.DisplayVideo.new ( Video  video,
RepeatMode  repeatMode,
bool  autoPlay,
Speaker  speaker 
)

◆ new() [6/6]

DisplayVideo Dragengine.Gui.DisplayVideo.new ( Video  video,
String  designerSelector 
)

◆ onFrameUpdate()

void Dragengine.Gui.DisplayVideo.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.

◆ onPaddingChanged()

void Dragengine.Gui.DisplayVideo.onPaddingChanged ( )

Padding changed.

Reimplemented from Dragengine.Gui.Widget.

◆ onResize()

void Dragengine.Gui.DisplayVideo.onResize ( WidgetEvent  event)

Size changed.

Reimplemented from Dragengine.Gui.Widget.

◆ onStateChanged()

void Dragengine.Gui.DisplayVideo.onStateChanged ( StateChangeEvent  event)

State changed.

Sends event to listeners.

Reimplemented from Dragengine.Gui.Widget.

◆ pause()

void Dragengine.Gui.DisplayVideo.pause ( )

Pause playback.

◆ play()

void Dragengine.Gui.DisplayVideo.play ( )

Start playback.

◆ setLooping()

void Dragengine.Gui.DisplayVideo.setLooping ( bool  looping)

Set if playback is looping.

◆ setPlayPosition()

void Dragengine.Gui.DisplayVideo.setPlayPosition ( float  position)

Set playback position in seconds clamped to play range.

◆ setProtectVideoColorTransform()

void Dragengine.Gui.DisplayVideo.setProtectVideoColorTransform ( bool  protect)

Set protect custom set video color transform.

◆ setRepeatMode()

void Dragengine.Gui.DisplayVideo.setRepeatMode ( RepeatMode  repeatMode)

Set repeat mode. Has to be one of REPEAT_* .

◆ setSpeaker()

void Dragengine.Gui.DisplayVideo.setSpeaker ( Speaker  speaker)

Set speaker or null.

◆ setVideo()

void Dragengine.Gui.DisplayVideo.setVideo ( Video  video)

Set video to display.

◆ setVideoColorTransform()

void Dragengine.Gui.DisplayVideo.setVideoColorTransform ( ColorMatrix  transform)

Set color transformation.

◆ stop()

void Dragengine.Gui.DisplayVideo.stop ( )

Stop playback.

◆ updateCanvasVideo()

void Dragengine.Gui.DisplayVideo.updateCanvasVideo ( )

Update canvas video.

Member Data Documentation

◆ pCanvasVideo

CanvasVideoPlayer Dragengine.Gui.DisplayVideo.pCanvasVideo

◆ pProtectVideoColorTransform

bool Dragengine.Gui.DisplayVideo.pProtectVideoColorTransform

◆ pRepeatMode

RepeatMode Dragengine.Gui.DisplayVideo.pRepeatMode

◆ pSpeaker

Speaker Dragengine.Gui.DisplayVideo.pSpeaker

◆ pVideo

Video Dragengine.Gui.DisplayVideo.pVideo

◆ pVideoPlayer

VideoPlayer Dragengine.Gui.DisplayVideo.pVideoPlayer

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