OpenPolygon  1.0.0
OpenPolygon is a Rendering Engine
Public Types | Public Member Functions | Protected Member Functions | List of all members
Engine::TextElement Class Reference

The TextElement - Text Objective class. More...

#include <textelement.h>

Inheritance diagram for Engine::TextElement:
Engine::RenderElement Engine::RenderInterface

Public Types

enum  PanelOptions { PANEL_ACTIVE = 0x2, PANEL_SIZE_AUTO = 0x4 }
 

Public Member Functions

void create (OpenPolygonDisplay *display)
 create More...
 
void draw (const DrawEvent &event)
 draw More...
 
void setColour (const Vector4f &colour)
 setColour More...
 
void setPanelColour (const Vector4f &colour)
 setPanelColour More...
 
void setPanelSize (const Vector2f &size)
 
void setPanelOptions (uint panel_options)
 
void setCaption (string draw_text)
 setCaption More...
 
void setPosition (const Vector3f &position)
 setPosition More...
 
void setSize (const Vector2f &size)
 setSize More...
 
- Public Member Functions inherited from Engine::RenderElement
 RenderElement (const std::string &name)
 
void setElement (Element *element)
 
ElementgetElement (void)
 

Protected Member Functions

void DrawTextIndirect (const DrawEvent &event)
 
void createIndirectData (void)
 
void DrawPanel (const DrawEvent &event)
 
Vector2f getScreenPixelVector (void)
 

Additional Inherited Members

- Protected Attributes inherited from Engine::RenderElement
Elementm_element
 

Detailed Description

The TextElement - Text Objective class.

Text Element

Member Function Documentation

void TextElement::create ( OpenPolygonDisplay display)
virtual

create

Create Static Text

Implements Engine::RenderInterface.

void TextElement::draw ( const DrawEvent event)
virtual

draw

Draw Static Text

Parameters
event

Implements Engine::RenderInterface.

void TextElement::setCaption ( string  draw_text)

setCaption

Set Text

Parameters
draw_text
void TextElement::setColour ( const Vector4f colour)

setColour

Set Front Colour ( aka Text Colour )

Parameters
colour
void TextElement::setPanelColour ( const Vector4f colour)

setPanelColour

Set Back Color ( aka Panel Colour )

Parameters
colour
void TextElement::setPosition ( const Vector3f position)

setPosition

Set Element Position

Parameters
position
void TextElement::setSize ( const Vector2f size)

setSize

Set Pixel Size

  • original size is 1,1
    Parameters
    size

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