Basic class for all structures that get inserted into the rendering hierarchy. More...

#include <renderable.h>

Inheritance diagram for Mezzanine::UI::Renderable:

Collaboration diagram for Mezzanine::UI::Renderable:

Public Types
enum	RenderableType { RT_LineList, RT_Screen, RT_Widget }
	A small enum to describe the type of renderable this is.

Public Member Functions
virtual void	_AppendRenderData (ScreenRenderData &RenderData)=0
	Appends the vertices of this renderable to another vector. More...

virtual void	_Clean ()=0
	Refreshes the render data of this renderable. More...

Boole	_IsDirty () const
	Gets whether or not this renderable is dirty. More...

virtual void	_MarkDirty ()=0
	Marks this renderable as dirty, and informs other renderables if needed. More...

virtual String	GetDerivedSerializableName () const
	Gets the most derived serializable name of this Renderable. More...

const String &	GetName () const
	Gets the name of this renderable. More...

virtual RenderableType	GetRenderableType () const =0
	Gets the type of renderable this is. More...

Screen *	GetScreen () const
	Gets the parent screen of this renderable. More...

virtual Boole	GetVisible () const =0
	Gets the visibility setting of this renderable. More...

virtual void	Hide ()=0
	Forces this renderable to hide.

Boole	IsScreen () const
	Gets whether or not this renderable is a Screen. More...

virtual Boole	IsVisible () const =0
	Gets whether or not this renderable is being drawn. More...

Boole	IsWidget () const
	Gets whether or not this renderable is a Widget. More...

virtual void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...

virtual void	ProtoDeSerializeProperties (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the properties of this object with it. More...

virtual void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...

virtual void	ProtoSerializeProperties (XML::Node &SelfRoot) const
	Convert the properties of this class to an XML::Node ready for serialization. More...

virtual void	SetVisible (Boole CanSee)=0
	Sets the visibility of this renderable. More...

virtual void	Show ()=0
	Forces this renderable to be shown.

Static Public Member Functions
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...

Protected Member Functions
	Renderable (Screen *Parent)
	Blank constructor. More...

	Renderable (const String &RendName, Screen *Parent)
	Class constructor. More...

virtual	~Renderable ()
	Class destructor.

virtual void	ProtoDeSerializeImpl (const XML::Node &SelfRoot)
	Implementation method for deseriailizing additional sets of data. More...

virtual void	ProtoSerializeImpl (XML::Node &SelfRoot) const
	Implementation method for serializing additional sets of data. More...

Protected Attributes
Boole	Dirty
	Stores whether this Renderables vertices need to be regenerated. More...

String	Name
	The unique name of this Renderable. More...

Screen *	ParentScreen
	A pointer to the Screen that created this Renderable. More...

Boole	Visible
	Stores whether this Renderable is to be rendered (also dependent on parent visibility). More...

Friends
class	Widget

Detailed Description

Basic class for all structures that get inserted into the rendering hierarchy.

Definition at line 58 of file renderable.h.

Constructor & Destructor Documentation

Mezzanine::UI::Renderable::Renderable ( Screen * Parent )

protected

Blank constructor.

Note: This is primarily useful for (and used as) a basic constructor suitable for XML deserialization post-construction.

Parameters

Parent The parent screen that created this renderable.

Definition at line 52 of file renderable.cpp.

Mezzanine::UI::Renderable::Renderable	(	const String &	RendName,
		Screen *	Parent
	)

protected

Class constructor.

Parameters

RendName	The name to be given to this renderable.
Parent	The parent screen that created this renderable.

Definition at line 58 of file renderable.cpp.

Member Function Documentation

virtual void Mezzanine::UI::Renderable::_AppendRenderData ( ScreenRenderData & RenderData )

pure virtual

Appends the vertices of this renderable to another vector.

Parameters

RenderData The vector of vertex's to append to.

Implemented in Mezzanine::UI::QuadRenderable, and Mezzanine::UI::LineList.

virtual void Mezzanine::UI::Renderable::_Clean ( )

pure virtual

Refreshes the render data of this renderable.

Implemented in Mezzanine::UI::QuadRenderable.

Boole Mezzanine::UI::Renderable::_IsDirty ( ) const

Gets whether or not this renderable is dirty.

Returns: Returns true if this renderable is dirty, false otherwise.

Definition at line 149 of file renderable.cpp.

virtual void Mezzanine::UI::Renderable::_MarkDirty ( )

pure virtual

Marks this renderable as dirty, and informs other renderables if needed.

Implemented in Mezzanine::UI::QuadRenderable, Mezzanine::UI::Screen, and Mezzanine::UI::LineList.

String Mezzanine::UI::Renderable::GetDerivedSerializableName ( ) const

virtual

Gets the most derived serializable name of this Renderable.

Note: When creating a new Renderable class verify this method has a valid return for it in order for serialization to work properly.

Returns: Returns the name of the XML tag from the most derived class of "this".

Reimplemented in Mezzanine::UI::QuadRenderable, Mezzanine::UI::Screen, and Mezzanine::UI::Widget.

Definition at line 140 of file renderable.cpp.

const String & Mezzanine::UI::Renderable::GetName ( ) const

Gets the name of this renderable.

Returns: Returns a string containing the name of this renderable.

Definition at line 77 of file renderable.cpp.

virtual RenderableType Mezzanine::UI::Renderable::GetRenderableType ( ) const

pure virtual

Gets the type of renderable this is.

Returns: Returns a RenderableType enum value coressponding the type of renderable this is.

Implemented in Mezzanine::UI::Screen, Mezzanine::UI::Widget, and Mezzanine::UI::LineList.

Screen * Mezzanine::UI::Renderable::GetScreen ( ) const

Gets the parent screen of this renderable.

Returns: Returns a pointer to the screen this renderable belongs to.

Definition at line 80 of file renderable.cpp.

String Mezzanine::UI::Renderable::GetSerializableName ( )

static

Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized.

Returns: A string containing the name of this class.

Definition at line 143 of file renderable.cpp.

virtual Boole Mezzanine::UI::Renderable::GetVisible ( ) const

pure virtual

Gets the visibility setting of this renderable.

Returns: Returns a bool that is the current visibility setting of this renderable.

Implemented in Mezzanine::UI::Widget, Mezzanine::UI::Screen, Mezzanine::UI::PagedContainer, and Mezzanine::UI::LineList.

Boole Mezzanine::UI::Renderable::IsScreen ( ) const

Gets whether or not this renderable is a Screen.

Returns: Returns true if this renderable is a Screen, false otherwise.

Definition at line 86 of file renderable.cpp.

virtual Boole Mezzanine::UI::Renderable::IsVisible ( ) const

pure virtual

Gets whether or not this renderable is being drawn.

This function will check the visibility of all parent objects to see if it is being drawn. This will not tell you whether or not this renderable has it's own visibility setting enabled. For that see: GetVisible().

Returns: Returns a bool representing the visibility of this renderable.

Implemented in Mezzanine::UI::Widget, Mezzanine::UI::Screen, Mezzanine::UI::PagedContainer, and Mezzanine::UI::LineList.

Boole Mezzanine::UI::Renderable::IsWidget ( ) const

Gets whether or not this renderable is a Widget.

Returns: Returns true if this renderable is a Widget, false otherwise.

Definition at line 83 of file renderable.cpp.

void Mezzanine::UI::Renderable::ProtoDeSerialize ( const XML::Node & SelfRoot )

virtual

Take the data stored in an XML Node and overwrite this object with it.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Reimplemented in Mezzanine::UI::QuadRenderable.

Definition at line 113 of file renderable.cpp.

void Mezzanine::UI::Renderable::ProtoDeSerializeImpl ( const XML::Node & SelfRoot )

protectedvirtual

Implementation method for deseriailizing additional sets of data.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Reimplemented in Mezzanine::UI::Widget, Mezzanine::UI::GridContainer, Mezzanine::UI::QuadRenderable, Mezzanine::UI::PagedContainer, Mezzanine::UI::RadioButton, Mezzanine::UI::TabSet, and Mezzanine::UI::PageProvider.

Definition at line 71 of file renderable.cpp.

void Mezzanine::UI::Renderable::ProtoDeSerializeProperties ( const XML::Node & SelfRoot )

virtual

Take the data stored in an XML Node and overwrite the properties of this object with it.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Reimplemented in Mezzanine::UI::QuadRenderable, Mezzanine::UI::Screen, Mezzanine::UI::Widget, Mezzanine::UI::GridContainer, Mezzanine::UI::PagedContainer, Mezzanine::UI::Spinner, Mezzanine::UI::ListBox, Mezzanine::UI::Scrollbar, Mezzanine::UI::Button, Mezzanine::UI::RadioButton, Mezzanine::UI::MenuEntry, Mezzanine::UI::EditBox, Mezzanine::UI::TabSet, Mezzanine::UI::DropDownList, Mezzanine::UI::LinearContainer, Mezzanine::UI::CheckBox, Mezzanine::UI::HorizontalContainer, Mezzanine::UI::VerticalContainer, Mezzanine::UI::LayoutContainer, Mezzanine::UI::StackButton, and Mezzanine::UI::StackedContainer.

Definition at line 118 of file renderable.cpp.

void Mezzanine::UI::Renderable::ProtoSerialize ( XML::Node & ParentNode ) const

virtual

Convert this class to an XML::Node ready for serialization.

Parameters

ParentNode The point in the XML hierarchy that this renderable should be appended to.

Reimplemented in Mezzanine::UI::QuadRenderable.

Definition at line 92 of file renderable.cpp.

void Mezzanine::UI::Renderable::ProtoSerializeImpl ( XML::Node & SelfRoot ) const

protectedvirtual

Implementation method for serializing additional sets of data.

Parameters

SelfRoot The root node containing all the serialized data for this instance.

Reimplemented in Mezzanine::UI::Widget, Mezzanine::UI::GridContainer, Mezzanine::UI::QuadRenderable, Mezzanine::UI::PagedContainer, Mezzanine::UI::RadioButton, Mezzanine::UI::TabSet, and Mezzanine::UI::PageProvider.

Definition at line 68 of file renderable.cpp.

void Mezzanine::UI::Renderable::ProtoSerializeProperties ( XML::Node & SelfRoot ) const

virtual

Convert the properties of this class to an XML::Node ready for serialization.

Parameters

SelfRoot The root node containing all the serialized data for this instance.

Reimplemented in Mezzanine::UI::QuadRenderable, Mezzanine::UI::Screen, Mezzanine::UI::Widget, Mezzanine::UI::GridContainer, Mezzanine::UI::PagedContainer, Mezzanine::UI::Spinner, Mezzanine::UI::ListBox, Mezzanine::UI::Scrollbar, Mezzanine::UI::Button, Mezzanine::UI::MenuEntry, Mezzanine::UI::RadioButton, Mezzanine::UI::EditBox, Mezzanine::UI::TabSet, Mezzanine::UI::DropDownList, Mezzanine::UI::LinearContainer, Mezzanine::UI::CheckBox, Mezzanine::UI::HorizontalContainer, Mezzanine::UI::VerticalContainer, Mezzanine::UI::LayoutContainer, Mezzanine::UI::StackButton, and Mezzanine::UI::StackedContainer.

Definition at line 99 of file renderable.cpp.

virtual void Mezzanine::UI::Renderable::SetVisible ( Boole CanSee )

pure virtual

Sets the visibility of this renderable.

Parameters

CanSee Boole determining whether or not this renderable should be visible.

Implemented in Mezzanine::UI::Widget, Mezzanine::UI::Screen, Mezzanine::UI::PagedContainer, Mezzanine::UI::MenuEntry, Mezzanine::UI::LineList, Mezzanine::UI::DropDownList, Mezzanine::UI::TabSet, Mezzanine::UI::HorizontalScrollbar, and Mezzanine::UI::VerticalScrollbar.

Member Data Documentation

Boole Mezzanine::UI::Renderable::Dirty

protected

Stores whether this Renderables vertices need to be regenerated.

Definition at line 78 of file renderable.h.

String Mezzanine::UI::Renderable::Name

protected

The unique name of this Renderable.

Definition at line 81 of file renderable.h.

Screen* Mezzanine::UI::Renderable::ParentScreen

protected

A pointer to the Screen that created this Renderable.

Definition at line 72 of file renderable.h.

Boole Mezzanine::UI::Renderable::Visible

protected

Stores whether this Renderable is to be rendered (also dependent on parent visibility).

Definition at line 75 of file renderable.h.

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

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/UI/renderable.h
/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/UI/renderable.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation