Ultima::Shared::Gfx::VisualItem Class Reference

#include <visual_item.h>

Inheritance diagram for Ultima::Shared::Gfx::VisualItem:

Public Member Functions
	VisualItem (TreeItem *parent=nullptr)
	VisualItem (const Rect &r, TreeItem *parent=nullptr)
	VisualItem (const Common::String &name, TreeItem *parent=nullptr)
	VisualItem (const Common::String &name, const Rect &r, TreeItem *parent=nullptr)
virtual void	draw ()
VisualSurface	getSurface ()
const Rect &	getBounds ()
void	setBounds (const Rect &r)
void	setPosition (const Point &pt)
virtual void	setDirty (bool dirty=true)
void	clearDirty ()
virtual bool	isDirty () const
void	setView (const Common::String &viewName)
void	setPopup (Gfx::Popup *popup)
void	setView ()
Public Member Functions inherited from Ultima::Shared::NamedItem
	NamedItem (const Common::String &name)
const Common::String	getName () const override
Public Member Functions inherited from Ultima::Shared::TreeItem
virtual bool	isEquals (const Common::String &name, int maxLen=0) const
virtual int	compareTo (const Common::String &name, int maxLen=0) const
virtual void	viewChange ()
TreeItem *	getParent () const
Game *	getGame ()
const Game *	getGame () const
Gfx::VisualItem *	getView ()
TreeItem *	getNextSibling () const
TreeItem *	getPriorSibling () const
TreeItem *	getLastSibling ()
TreeItem *	getFirstChild () const
TreeItem *	getLastChild () const
TreeItem *	scan (TreeItem *item) const
TreeItem *	findChildInstanceOf (const ClassDef &classDef) const
TreeItem *	findNextInstanceOf (const ClassDef &classDef, TreeItem *startItem) const
void	addUnder (TreeItem *newParent)
void	addChild (TreeItem *child)
void	setParent (TreeItem *newParent)
void	addSibling (TreeItem *item)
void	moveUnder (TreeItem *newParent)
void	destroyAll ()
int	destroyChildren ()
void	detach ()
void	attach (TreeItem *item)
NamedItem *	findByName (const Common::String &name)
Public Member Functions inherited from Ultima::Shared::BaseObject
virtual ::Ultima::Shared::ClassDef	getType () const
bool	isInstanceOf (const ClassDef &classDef) const

Public Attributes
	CLASSDEF
Public Attributes inherited from Ultima::Shared::NamedItem
Common::String	_name
	CLASSDEF
Public Attributes inherited from Ultima::Shared::TreeItem
	CLASSDEF
Public Attributes inherited from Ultima::Shared::MessageTarget
	CLASSDEF

Protected Attributes
Rect	_bounds
bool	_isDirty

Additional Inherited Members
Static Public Member Functions inherited from Ultima::Shared::BaseObject
::Ultima::Shared::ClassDef	type ()
Protected Member Functions inherited from Ultima::Shared::MessageTarget
virtual const Ultima::Shared::MSGMAP *	getMessageMap () const
Static Protected Member Functions inherited from Ultima::Shared::MessageTarget
static const Ultima::Shared::MSGMAP *	getThisMessageMap ()

Detailed Description

Acts as the base class for all classes that have a visual representation on the screen

Member Function Documentation

draw()

virtual void Ultima::Shared::Gfx::VisualItem::draw ( )

inlinevirtual

Draws the visual item on the screen

Reimplemented in Ultima::Ultima1::U1Gfx::ViewCharacterGeneration, Ultima::Ultima1::U1Gfx::ViewTitle, Ultima::Ultima1::U6Gfx::GameView, Ultima::Ultima1::U1Dialogs::Stats, Ultima::Ultima1::U1Dialogs::Dialog, Ultima::Ultima1::U1Dialogs::BuySellDialog, Ultima::Ultima1::U1Dialogs::King, Ultima::Ultima1::U1Dialogs::Ready, Ultima::Ultima1::U1Dialogs::Tavern, Ultima::Ultima1::U1Dialogs::Transports, Ultima::Ultima1::U1Dialogs::Drop, Ultima::Ultima1::U1Gfx::ViewGame, Ultima::Shared::ViewportDungeon, Ultima::Shared::Info, Ultima::Ultima1::U1Dialogs::Armoury, Ultima::Ultima1::U1Dialogs::Weaponry, Ultima::Ultima1::U1Dialogs::Combat, Ultima::Ultima1::U1Dialogs::Magic, Ultima::Shared::Gfx::VisualContainer, Ultima::Ultima1::U1Dialogs::Grocery, Ultima::Ultima1::U1Gfx::ViewportMap, Ultima::Shared::ViewportMap, Ultima::Ultima1::U1Gfx::Status, and Ultima::Shared::Gfx::TextInput.

getSurface()

VisualSurface Ultima::Shared::Gfx::VisualItem::getSurface

(

)

Gets a managed surface representing the portion of the screen defined by _bounds. This allows drawing to be done without worrying about offsets or clipping

getBounds()

const Rect& Ultima::Shared::Gfx::VisualItem::getBounds ( )

inline

Gets the bounds for the item

setBounds()

void Ultima::Shared::Gfx::VisualItem::setBounds

(

const Rect &

r

)

Sets the bounds for the item

Remarks

Does not erase the item if it's already been drawn

setPosition()

void Ultima::Shared::Gfx::VisualItem::setPosition

(

const Point &

pt

)

Set the position for the item

Remarks

Does not erase the item if it's already been drawn

setDirty()

virtual void Ultima::Shared::Gfx::VisualItem::setDirty ( bool  dirty = true )

virtual

Flags the item as being changed, requiring a redraw

Reimplemented in Ultima::Shared::Gfx::VisualContainer.

clearDirty()

void Ultima::Shared::Gfx::VisualItem::clearDirty ( )

inline

Clears the dirty flag

isDirty()

virtual bool Ultima::Shared::Gfx::VisualItem::isDirty ( ) const

inlinevirtual

Returns true if the item is dirty, requiring a redraw

Reimplemented in Ultima::Shared::Gfx::VisualContainer.

setView() [1/2]

void Ultima::Shared::Gfx::VisualItem::setView

(

const Common::String &

viewName

)

Helper function to switch to a different visual item

setPopup()

void Ultima::Shared::Gfx::VisualItem::setPopup

(

Gfx::Popup *

popup

)

Helper function to switch to an on-screen popup

setView() [2/2]

void Ultima::Shared::Gfx::VisualItem::setView

(

)

Helper function to switch the item to be the current view

---

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

• engines/ultima/shared/gfx/visual_item.h