Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Mezzanine::UI::LineListRenderer Class Reference

This is a renderer class specifically designed to draw lines. More...

+ Inheritance diagram for Mezzanine::UI::LineListRenderer:
+ Collaboration diagram for Mezzanine::UI::LineListRenderer:

Public Member Functions

 LineListRenderer (LineList *LL)
 Class constructor. More...
 
virtual ~LineListRenderer ()
 Class destructor.
 
virtual void _MarkDirty ()
 Marks this renderable as well as all parent objects as dirty. More...
 
- Public Member Functions inherited from Mezzanine::UI::SimpleRenderer
void _AppendVertices (std::vector< VertexData > &Vertices)
 Appends the vertices of this renderable to another vector. More...
 
Boole _IsDirty ()
 Gets whether or not this renderer is dirty. More...
 
void _Redraw (Boole Force)
 Regenerates the verticies in this renderable. More...
 
virtual String GetDerivedSerializableName () const
 Gets the most derived serializable name of this Renderable. More...
 
virtual String GetPrimaryAtlas () const
 Gets the currently set primary atlas. 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 SetPrimaryAtlas (const String &Atlas)
 Sets the Atlas to be assumed when one isn't provided for atlas related tasks. More...
 

Protected Member Functions

virtual void RedrawImpl (Boole Force)
 Provides the class specific implementation for regenerating vertices for this renderable. More...
 
- Protected Member Functions inherited from Mezzanine::UI::SimpleRenderer
 SimpleRenderer ()
 Class constructor.
 
virtual ~SimpleRenderer ()
 Class destructor.
 
virtual void PushTriangle (const Vector2 &A, const Vector2 &B, const Vector2 &C, const Vector2 &UV, const ColourValue &Colour, const String &Atlas)
 Pushes vertex information for a triangle to a vector. Equivalent to calling "PushVertex" three times. More...
 
virtual void PushVertex (const Real &X, const Real &Y, const Vector2 &UV, const ColourValue &Colour, const String &Atlas)
 Collects all the relevant information for a single vertex and pushes it to a vector. More...
 

Protected Attributes

LineListParent
 a pointer to the LineList this rendered is rendering for.
 
- Protected Attributes inherited from Mezzanine::UI::SimpleRenderer
Boole Dirty
 This determines whether or not the vertices in this renderer need to be refreshed. More...
 
String PriAtlas
 This contains the name of the atlas that will be used as default when one isn't specified. More...
 
std::vector< VertexDataRenderVertices
 This is a container storing all the vertices generated by this renderer. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Mezzanine::UI::SimpleRenderer
static String GetSerializableName ()
 Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...
 

Detailed Description

This is a renderer class specifically designed to draw lines.

Definition at line 60 of file linelist.cpp.

Constructor & Destructor Documentation

Mezzanine::UI::LineListRenderer::LineListRenderer ( LineList LL)
inline

Class constructor.

Parameters
LLThe parent LineList this renderer is rendering.

Definition at line 127 of file linelist.cpp.

Member Function Documentation

virtual void Mezzanine::UI::LineListRenderer::_MarkDirty ( )
inlinevirtual

Marks this renderable as well as all parent objects as dirty.

Implements Mezzanine::UI::SimpleRenderer.

Definition at line 135 of file linelist.cpp.

virtual void Mezzanine::UI::LineListRenderer::RedrawImpl ( Boole  Force)
inlineprotectedvirtual

Provides the class specific implementation for regenerating vertices for this renderable.

Parameters
ForceWhether or not to force the regenerating of vertices regardless of whether or not the data is dirty.

Implements Mezzanine::UI::SimpleRenderer.

Definition at line 67 of file linelist.cpp.


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