#include <billboard_text.h>

Inheritance diagram for rve_render_client::BillboardText:

Public Member Functions
virtual void	doCreate (ContextInfo &context)
virtual void	doDestroy (ContextInfo &context)
float	getCharacterHeight () const
const rve_msgs::ColorRGB &	getColor () const
virtual void	getContextDependencies (V_UUID &deps)
uint8_t	getHorizontalAlignment () const
const rve_msgs::Vector3 &	getPosition () const
const std::string &	getText () const
uint8_t	getVerticalAlignment () const
void	setCharacterHeight (float height)
void	setColor (const rve_msgs::ColorRGB &color)
void	setHorizontalAlignment (uint8_t h)
void	setPosition (const rve_msgs::Vector3 &position)
void	setText (const std::string &text)
void	setVerticalAlignment (uint8_t v)
Private Member Functions
	BillboardText ()
rve_interfaces::BillboardTextProxy *	getProxy (const ContextInfo &info)
	~BillboardText ()
Private Attributes
rve_msgs::TextAlignment	alignment_
float	character_height_
rve_msgs::ColorRGB	color_
rve_msgs::Vector3	position_
uint32_t	proxy_index_
std::string	text_
Friends
BillboardTextPtr	createBillboardText (const std::string &text)
BillboardTextPtr	createBillboardText (Scene *scene, const std::string &text)
void	destroyBillboardText (BillboardText *)

Detailed Description

Definition at line 51 of file billboard_text.h.

Constructor & Destructor Documentation

rve_render_client::BillboardText::BillboardText ( ) [private]

Definition at line 56 of file billboard_text.cpp.

rve_render_client::BillboardText::~BillboardText ( ) [private]

Definition at line 64 of file billboard_text.cpp.

Member Function Documentation

void rve_render_client::BillboardText::doCreate ( ContextInfo & context ) [virtual]

Implements rve_render_client::SceneObject.

Definition at line 73 of file billboard_text.cpp.

void rve_render_client::BillboardText::doDestroy ( ContextInfo & context ) [virtual]

Implements rve_render_client::SceneObject.

Definition at line 86 of file billboard_text.cpp.

float rve_render_client::BillboardText::getCharacterHeight ( ) const [inline]

Definition at line 67 of file billboard_text.h.

const rve_msgs::ColorRGB& rve_render_client::BillboardText::getColor ( ) const [inline]

Definition at line 90 of file billboard_text.h.

void rve_render_client::BillboardText::getContextDependencies ( V_UUID & deps ) [virtual]

Implements rve_render_client::SceneObject.

Definition at line 92 of file billboard_text.cpp.

uint8_t rve_render_client::BillboardText::getHorizontalAlignment ( ) const [inline]

Definition at line 76 of file billboard_text.h.

const rve_msgs::Vector3& rve_render_client::BillboardText::getPosition ( ) const [inline]

Definition at line 62 of file billboard_text.h.

rve_interfaces::BillboardTextProxy * rve_render_client::BillboardText::getProxy ( const ContextInfo & info ) [private]

Definition at line 68 of file billboard_text.cpp.

const std::string& rve_render_client::BillboardText::getText ( ) const [inline]

Definition at line 57 of file billboard_text.h.

uint8_t rve_render_client::BillboardText::getVerticalAlignment ( ) const [inline]

Definition at line 85 of file billboard_text.h.

void rve_render_client::BillboardText::setCharacterHeight ( float height )

Set the height, in meters, of a single line of text. Similar to setting a font size.

Definition at line 113 of file billboard_text.cpp.

void rve_render_client::BillboardText::setColor ( const rve_msgs::ColorRGB & color )

Set the text color. Background color is not yet implemented. Background is transparent.

Definition at line 141 of file billboard_text.cpp.

void rve_render_client::BillboardText::setHorizontalAlignment ( uint8_t h )

Set the horizontal alignment: TextAlignment:: H_LEFT or H_CENTER. This sets where the anchor point is relative to the text. With H_LEFT, the anchor will be to the left of the text, and every line of text will have its left end lined up.

Default is H_LEFT.

Set the horizontal alignment: TextAlignment:: H_LEFT or H_CENTER. This sets where the anchor point is relative to the text. With H_LEFT, the anchor will be to the left of the text, and every line of text will have its left end lined up.

Definition at line 123 of file billboard_text.cpp.

void rve_render_client::BillboardText::setPosition ( const rve_msgs::Vector3 & position )

Set the position of the alignment anchor point. Actual text position depends on the alignment and size.

Definition at line 99 of file billboard_text.cpp.

void rve_render_client::BillboardText::setText ( const std::string & text )

Set the text. Can contain newline characters, which make a multiline result.

Definition at line 105 of file billboard_text.cpp.

void rve_render_client::BillboardText::setVerticalAlignment ( uint8_t v )

Set the vertical alignment: TextAlignment:: V_TOP, V_CENTER, or V_BOTTOM. This sets where the anchor is relative to the text. With V_BOTTOM, for instance, the anchor will be at the bottom of the text.

Default is V_TOP.

Set the vertical alignment: TextAlignment:: V_TOP, V_CENTER, or V_BOTTOM. This sets where the anchor is relative to the text. With V_BOTTOM, for instance, the anchor will be at the bottom of the text.

Definition at line 133 of file billboard_text.cpp.