MythTV  master
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
MythUIProcedural Class Reference

#include <mythuiprocedural.h>

Inheritance diagram for MythUIProcedural:
Inheritance graph
Collaboration diagram for MythUIProcedural:
Collaboration graph

Public Member Functions

 MythUIProcedural (MythUIType *Parent, const QString &Name)
 A procedural texture class. More...
- Public Member Functions inherited from MythUIType
 MythUIType (QObject *parent, const QString &name)
virtual void Reset (void)
 Reset the widget to it's original state, should not reset changes made by the theme. More...
void AddChild (MythUIType *child)
 Add a child UIType. More...
MythUITypeGetChild (const QString &name) const
 Get a named child of this UIType. More...
MythUITypeGetChildAt (QPoint p, bool recursive=true, bool focusable=true) const
 Return the first MythUIType at the given coordinates. More...
QList< MythUIType * > * GetAllChildren (void)
 Return a list of all child widgets. More...
QList< MythUIType * > GetAllDescendants (void)
void DeleteChild (const QString &name)
 Delete a named child of this UIType. More...
void DeleteChild (MythUIType *child)
 Delete the given UIType if it is a child of this UIType. More...
void DeleteAllChildren (void)
 Delete all child widgets. More...
bool NeedsRedraw (void) const
void ResetNeedsRedraw (void)
void SetRedraw (void)
void SetChildNeedsRedraw (MythUIType *child)
bool CanTakeFocus (void) const
 Return if this widget can accept input focus. More...
void SetCanTakeFocus (bool set=true)
 Set whether this widget can take focus. More...
void SetFocusOrder (int order)
bool IsEnabled (void) const
void SetEnabled (bool enable)
bool MoveToTop (void)
bool MoveChildToTop (MythUIType *child)
void ActivateAnimations (MythUIAnimation::Trigger trigger)
QList< MythUIAnimation * > * GetAnimations (void)
void Draw (MythPainter *p, int xoffset, int yoffset, int alphaMod=255, QRect clipRect=QRect())
void SetPosition (int x, int y)
 Convenience method, calls SetPosition(const MythPoint&) Override that instead to change functionality. More...
void SetPosition (QPoint point)
virtual void SetPosition (const MythPoint &point)
virtual MythPoint GetPosition (void) const
virtual void SetSize (QSize size)
virtual void SetMinSize (const MythPoint &size)
 Set the minimum size of this widget, for widgets which can be rescaled. More...
virtual QSize GetMinSize (void) const
virtual void SetArea (const MythRect &rect)
virtual void AdjustMinArea (int delta_x, int delta_y, int delta_w, int delta_h)
 Adjust the size of a sibling. More...
virtual void VanishSibling (void)
virtual void SetMinAreaParent (MythRect actual_area, MythRect allowed_area, MythUIType *child)
 Adjust the size of sibling objects within the button. More...
virtual void SetMinArea (const MythRect &rect)
 Set the minimum area based on the given size. More...
virtual MythRect GetArea (void) const
 If the object has a minimum area defined, return it, other wise return the default area. More...
virtual MythRect GetFullArea (void) const
virtual void RecalculateArea (bool recurse=true)
void ExpandArea (QRect rect)
virtual QRegion GetDirtyArea (void) const
bool IsVisible (bool recurse=false) const
virtual void SetVisible (bool visible)
void MoveTo (QPoint destXY, QPoint speedXY)
void AdjustAlpha (int mode, int alphachange, int minalpha=0, int maxalpha=255)
void SetAlpha (int newalpha)
int GetAlpha (void) const
virtual bool keyPressEvent (QKeyEvent *event)
 Key event handler. More...
virtual bool inputMethodEvent (QInputMethodEvent *event)
 Input Method event handler. More...
virtual bool gestureEvent (MythGestureEvent *event)
 Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop. More...
virtual void mediaEvent (MythMediaEvent *event)
 Media/Device status event handler, received from MythMediaMonitor. More...
MythFontPropertiesGetFont (const QString &text) const
bool AddFont (const QString &text, MythFontProperties *fontProp)
void SetHelpText (const QString &text)
QString GetHelpText (void) const
void SetXMLLocation (const QString &filename, int where)
QString GetXMLLocation (void) const
void SetXMLName (const QString &name)
QString GetXMLName (void) const
bool IsDeferredLoading (bool recurse=false) const
void SetDeferLoad (bool defer)
virtual void LoadNow (void)
 Cause images in this and child widgets to be loaded. More...
bool ContainsPoint (QPoint point) const
 Check if the given point falls within this widgets area. More...
virtual MythPainterGetPainter (void)
void SetPainter (MythPainter *painter)
void SetCentre (UIEffects::Centre centre)
void SetZoom (float zoom)
void SetHorizontalZoom (float zoom)
void SetVerticalZoom (float zoom)
void SetAngle (float angle)
void SetDependIsDefault (bool isDefault)
void SetReverseDependence (MythUIType *dependee, bool reverse)
void SetDependsMap (QMap< QString, QString > dependsMap)
QMap< QString, QString > GetDependsMap () const

Protected Member Functions

void DrawSelf (MythPainter *Painter, int XOffset, int YOffset, int AlphaMod, QRect ClipRect) override
bool ParseElement (const QString &FileName, QDomElement &Element, bool ShowWarnings) override
 Parse the xml definition of this widget setting the state of the object accordingly. More...
void CopyFrom (MythUIType *Base) override
 Copy this widgets state from another. More...
void CreateCopy (MythUIType *Parent) override
 Copy the state of this widget to the one given, it must be of the same type. More...
void Pulse () override
 Pulse is called 70 times a second to trigger a single frame of an animation. More...
void Finalize (void) override
 Perform any post-xml parsing initialisation tasks. More...
- Protected Member Functions inherited from MythUIType
 ~MythUIType () override
void customEvent (QEvent *event) override
void AddFocusableChildrenToList (FocusInfoType &focusList)
void HandleAlphaPulse ()
 Handle one frame of an alpha (transparency) change animation. More...
void HandleMovementPulse ()
 Handle one frame of a movement animation. More...
int CalcAlpha (int alphamod) const
void ConnectDependants (bool recurse=false)

Static Protected Member Functions

static ShaderSource LoadShaderSource (const QString &filename)
- Static Protected Member Functions inherited from MythUIType
static int NormX (int width)
static int NormY (int height)

Protected Attributes

QString m_hash
ShaderSource m_vertexSource { nullptr }
ShaderSource m_fragmentSource { nullptr }
- Protected Attributes inherited from MythUIType
QList< MythUIType * > m_childrenList
QMap< QString, QString > m_dependsMap
QList< QPair< MythUIType *, bool > > m_dependsValue
QList< int > m_dependOperator
bool m_visible {true}
bool m_hasFocus {false}
bool m_canHaveFocus {false}
bool m_enabled {true}
bool m_enableInitiator {false}
bool m_initiator {false}
bool m_vanish {false}
bool m_vanished {false}
bool m_isDependDefault {false}
QMap< MythUIType *, boolm_reverseDepend
int m_focusOrder {0}
MythRect m_area {0,0,0,0}
MythRect m_minArea {0,0,0,0}
MythPoint m_minSize
QRegion m_dirtyRegion {0,0,0,0}
bool m_needsRedraw {false}
UIEffects m_effects
int m_alphaChangeMode {0}
int m_alphaChange {0}
int m_alphaMin {0}
int m_alphaMax {255}
bool m_moving {false}
QPoint m_xyDestination {0,0}
QPoint m_xySpeed {0,0}
FontMapm_fonts {nullptr}
MythUITypem_parent {nullptr}
MythPainterm_painter {nullptr}
QList< MythUIAnimation * > m_animations
QString m_helptext
QString m_xmlName
QString m_xmlLocation
bool m_deferload {false}
QColor m_borderColor {Qt::black}

Additional Inherited Members

- Public Slots inherited from MythUIType
void LoseFocus ()
bool TakeFocus ()
void Activate ()
void Hide (void)
void Show (void)
void Refresh (void)
void UpdateDependState (bool isDefault)
void UpdateDependState (MythUIType *dependee, bool isDefault)
- Signals inherited from MythUIType
void RequestUpdate ()
void RequestRegionUpdate (const QRect &)
void TakingFocus ()
void LosingFocus ()
void VisibilityChanged (bool Visible)
void Showing ()
void Hiding ()
void Enabling ()
void Disabling ()
void FinishedMoving ()
void FinishedFading ()
void DependChanged (bool isDefault)
- Static Public Member Functions inherited from XMLParseBase
static QString getFirstText (QDomElement &element)
static bool parseBool (const QString &text)
static bool parseBool (QDomElement &element)
static MythPoint parsePoint (const QString &text, bool normalize=true)
static MythPoint parsePoint (QDomElement &element, bool normalize=true)
static QSize parseSize (const QString &text, bool normalize=true)
static QSize parseSize (QDomElement &element, bool normalize=true)
static MythRect parseRect (const QString &text, bool normalize=true)
static MythRect parseRect (QDomElement &element, bool normalize=true)
static int parseAlignment (const QString &text)
static int parseAlignment (QDomElement &element)
static QBrush parseGradient (const QDomElement &element)
static QString parseText (QDomElement &element)
static MythUITypeGetGlobalObjectStore (void)
static void ClearGlobalObjectStore (void)
static void ParseChildren (const QString &filename, QDomElement &element, MythUIType *parent, bool showWarnings)
static MythUITypeParseUIType (const QString &filename, QDomElement &element, const QString &type, MythUIType *parent, MythScreenType *screen, bool showWarnings, QMap< QString, QString > &parentDependsMap)
static bool WindowExists (const QString &xmlfile, const QString &windowname)
static bool LoadWindowFromXML (const QString &xmlfile, const QString &windowname, MythUIType *parent)
static bool LoadBaseTheme (void)
static bool LoadBaseTheme (const QString &baseTheme)
static bool CopyWindowFromBase (const QString &windowname, MythScreenType *win)

Detailed Description

Definition at line 12 of file mythuiprocedural.h.

Constructor & Destructor Documentation

◆ MythUIProcedural()

MythUIProcedural::MythUIProcedural ( MythUIType Parent,
const QString &  Name 

A procedural texture class.

Data to provide to any shader; assuming projection already handled:-

             Type             Bytes          Notes

Transform 16*float(4x4) 64 Vertices 4*float 16 Texcoords 4*float 16 Optional Alpha float 4 Seconds uint 4 Seconds since epoch to prog start Milliseconds uint 4 Centiseconds since prog start Visible uint 4 Activated uint 4 Deactivated uint 4 Hidden uint 4 Index ushort 2 Elements ushort 2 Total 128 Max Vulkan 128

Full millisecond accuracy requires 64bit - or 8bytes - but 64bit integer support is limited. Max 32bit int: 2,147,483,647 Centiseconds in day: 8,640,000 - wraps after 248.5 days Milliseconds in day: 86,400,000 - wraps after 24.8 days

Definition at line 38 of file mythuiprocedural.cpp.

Referenced by CreateCopy().

Member Function Documentation

◆ DrawSelf()

void MythUIProcedural::DrawSelf ( MythPainter Painter,
int  XOffset,
int  YOffset,
int  AlphaMod,
QRect  ClipRect 

Reimplemented from MythUIType.

Definition at line 43 of file mythuiprocedural.cpp.

◆ ParseElement()

bool MythUIProcedural::ParseElement ( const QString &  filename,
QDomElement &  element,
bool  showWarnings 

Parse the xml definition of this widget setting the state of the object accordingly.

Reimplemented from MythUIType.

Definition at line 52 of file mythuiprocedural.cpp.

◆ CopyFrom()

void MythUIProcedural::CopyFrom ( MythUIType base)

Copy this widgets state from another.

Reimplemented from MythUIType.

Definition at line 68 of file mythuiprocedural.cpp.

◆ CreateCopy()

void MythUIProcedural::CreateCopy ( MythUIType parent)

Copy the state of this widget to the one given, it must be of the same type.

Reimplemented from MythUIType.

Definition at line 80 of file mythuiprocedural.cpp.

◆ Pulse()

void MythUIProcedural::Pulse ( )

Pulse is called 70 times a second to trigger a single frame of an animation.

This changes the alpha value of the widget

Reimplemented from MythUIType.

Definition at line 86 of file mythuiprocedural.cpp.

◆ Finalize()

void MythUIProcedural::Finalize ( void  )

Perform any post-xml parsing initialisation tasks.

This is called after the widget has been created and it's state established by ParseElement() or CopyFrom(). A derived class should use this to perform any initialisation tasks which should occur after this point.

Reimplemented from MythUIType.

Definition at line 92 of file mythuiprocedural.cpp.

◆ LoadShaderSource()

ShaderSource MythUIProcedural::LoadShaderSource ( const QString &  filename)

Definition at line 105 of file mythuiprocedural.cpp.

Referenced by ParseElement().

Member Data Documentation

◆ m_hash

QString MythUIProcedural::m_hash

Definition at line 27 of file mythuiprocedural.h.

Referenced by CopyFrom(), DrawSelf(), and Finalize().

◆ m_vertexSource

ShaderSource MythUIProcedural::m_vertexSource { nullptr }

Definition at line 28 of file mythuiprocedural.h.

Referenced by CopyFrom(), DrawSelf(), Finalize(), and ParseElement().

◆ m_fragmentSource

ShaderSource MythUIProcedural::m_fragmentSource { nullptr }

Definition at line 29 of file mythuiprocedural.h.

Referenced by CopyFrom(), DrawSelf(), Finalize(), and ParseElement().

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