billboard_text.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef RVE_RENDER_CLIENT_BILLBOARD_TEXT_H
#define RVE_RENDER_CLIENT_BILLBOARD_TEXT_H

#include <string>

#include <rve_common/uuid.h>
#include <rve_msgs/ColorRGB.h>
#include <rve_msgs/TextAlignment.h>

#include "forwards.h"
#include "single_scene_object.h"

namespace rve_interfaces
{
class BillboardTextProxy;
}

namespace rve_render_client
{

class Color;

class BillboardText : public SingleSceneObject
{
public:
  void setText( const std::string& text );
  const std::string& getText() const { return text_; }

  void setPosition( const rve_msgs::Vector3& position );
  const rve_msgs::Vector3& getPosition() const { return position_; }

  void setCharacterHeight( float height );
  float getCharacterHeight() const { return character_height_; }

  void setHorizontalAlignment( uint8_t h );
  uint8_t getHorizontalAlignment() const { return alignment_.horizontal; }

  void setVerticalAlignment( uint8_t v );
  uint8_t getVerticalAlignment() const { return alignment_.vertical; }

  void setColor(const rve_msgs::ColorRGB& color);
  const rve_msgs::ColorRGB& getColor() const { return color_; }

  virtual void doCreate(ContextInfo& context);
  virtual void doDestroy(ContextInfo& context);

  virtual void getContextDependencies(V_UUID& deps);

private:
  BillboardText();
  ~BillboardText();
  
  rve_interfaces::BillboardTextProxy* getProxy(const ContextInfo& info);

  rve_msgs::Vector3 position_;
  std::string text_;
  float character_height_;
  rve_msgs::TextAlignment alignment_;
  rve_msgs::ColorRGB color_;

  uint32_t proxy_index_;

  friend BillboardTextPtr createBillboardText(const std::string& text);
  friend BillboardTextPtr createBillboardText(Scene* scene, const std::string& text);
  friend void destroyBillboardText(BillboardText*);
};

BillboardTextPtr createBillboardText(const std::string& text = "");
BillboardTextPtr createBillboardText(Scene* scene, const std::string& text = "");
};

#endif // RVE_RENDER_CLIENT_BILLBOARD_TEXT_H