Public Member Functions | Private Member Functions | Private Attributes | Friends
rve_render_client::BillboardText Class Reference

#include <billboard_text.h>

Inheritance diagram for rve_render_client::BillboardText:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void doCreate (ContextInfo &context)
virtual void doDestroy (ContextInfo &context)
float getCharacterHeight () const
const rve_msgs::ColorRGBgetColor () const
virtual void getContextDependencies (V_UUID &deps)
uint8_t getHorizontalAlignment () const
const rve_msgs::Vector3getPosition () 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

Definition at line 56 of file billboard_text.cpp.

Definition at line 64 of file billboard_text.cpp.


Member Function Documentation

Implements rve_render_client::SceneObject.

Definition at line 73 of file billboard_text.cpp.

Implements rve_render_client::SceneObject.

Definition at line 86 of file billboard_text.cpp.

Definition at line 67 of file billboard_text.h.

Definition at line 90 of file billboard_text.h.

Implements rve_render_client::SceneObject.

Definition at line 92 of file billboard_text.cpp.

Definition at line 76 of file billboard_text.h.

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.

Definition at line 85 of file billboard_text.h.

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.

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

Definition at line 141 of file billboard_text.cpp.

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.

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.

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.


Friends And Related Function Documentation

BillboardTextPtr createBillboardText ( const std::string &  text = "") [friend]
BillboardTextPtr createBillboardText ( Scene scene,
const std::string &  text = "" 
) [friend]
void destroyBillboardText ( BillboardText ) [friend]

Member Data Documentation

Definition at line 106 of file billboard_text.h.

Definition at line 105 of file billboard_text.h.

Definition at line 107 of file billboard_text.h.

Definition at line 103 of file billboard_text.h.

Definition at line 109 of file billboard_text.h.

Definition at line 104 of file billboard_text.h.


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


rve_render_client
Author(s): Josh Faust
autogenerated on Wed Dec 11 2013 14:31:32