Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
rviz::BillboardLine Class Reference

An object that displays a multi-segment line strip rendered as billboards. More...

#include <billboard_line.h>

Inheritance diagram for rviz::BillboardLine:
Inheritance graph
[legend]

Public Member Functions

void addPoint (const Ogre::Vector3 &point)
 
void addPoint (const Ogre::Vector3 &point, const Ogre::ColourValue &color)
 
 BillboardLine (Ogre::SceneManager *manager, Ogre::SceneNode *parent_node=NULL)
 Constructor. More...
 
void clear ()
 
Ogre::MaterialPtr getMaterial ()
 
virtual const Ogre::Quaternion & getOrientation ()
 Get the local orientation of this object. More...
 
virtual const Ogre::Vector3getPosition ()
 Get the local position of this object. More...
 
Ogre::SceneNode * getSceneNode ()
 Get the scene node associated with this object. More...
 
void newLine ()
 
virtual void setColor (float r, float g, float b, float a)
 Set the color of the object. Values are in the range [0, 1]. More...
 
void setLineWidth (float width)
 
void setMaxPointsPerLine (uint32_t max)
 
void setNumLines (uint32_t num)
 
virtual void setOrientation (const Ogre::Quaternion &orientation)
 Set the orientation of the object. More...
 
virtual void setPosition (const Ogre::Vector3 &position)
 Set the position of this object. More...
 
virtual void setScale (const Ogre::Vector3 &scale)
 Set the scale of the object. Always relative to the identity orientation of the object. More...
 
void setUserData (const Ogre::Any &data)
 We have no objects that we can set user data on. More...
 
virtual ~BillboardLine ()
 
- Public Member Functions inherited from rviz::Object
 Object (Ogre::SceneManager *scene_manager)
 
virtual ~Object ()
 

Private Types

typedef std::vector< Ogre::BillboardChain * > V_Chain
 
typedef std::vector< uint32_t > V_uint32
 

Private Member Functions

Ogre::BillboardChain * createChain ()
 
void setupChains ()
 

Private Attributes

V_Chain chains_
 
Ogre::ColourValue color_
 
uint32_t current_chain_
 
uint32_t current_line_
 
uint32_t elements_in_current_chain_
 
uint32_t lines_per_chain_
 
Ogre::MaterialPtr material_
 
uint32_t max_points_per_line_
 
V_uint32 num_elements_
 
uint32_t num_lines_
 
Ogre::SceneNode * scene_node_
 
uint32_t total_elements_
 
float width_
 

Additional Inherited Members

- Protected Attributes inherited from rviz::Object
Ogre::SceneManager * scene_manager_
 Ogre scene manager this object is part of. More...
 

Detailed Description

An object that displays a multi-segment line strip rendered as billboards.

Definition at line 59 of file billboard_line.h.

Member Typedef Documentation

typedef std::vector<Ogre::BillboardChain*> rviz::BillboardLine::V_Chain
private

Definition at line 107 of file billboard_line.h.

typedef std::vector<uint32_t> rviz::BillboardLine::V_uint32
private

Definition at line 117 of file billboard_line.h.

Constructor & Destructor Documentation

rviz::BillboardLine::BillboardLine ( Ogre::SceneManager *  manager,
Ogre::SceneNode *  parent_node = NULL 
)

Constructor.

Parameters
managerScene manager this object is a part of
parent_nodeA scene node to use as the parent of this object. If NULL, uses the root scene node.

Definition at line 49 of file billboard_line.cpp.

rviz::BillboardLine::~BillboardLine ( )
virtual

Definition at line 78 of file billboard_line.cpp.

Member Function Documentation

void rviz::BillboardLine::addPoint ( const Ogre::Vector3 point)

Definition at line 197 of file billboard_line.cpp.

void rviz::BillboardLine::addPoint ( const Ogre::Vector3 point,
const Ogre::ColourValue &  color 
)

Definition at line 202 of file billboard_line.cpp.

void rviz::BillboardLine::clear ( )

Definition at line 106 of file billboard_line.cpp.

Ogre::BillboardChain * rviz::BillboardLine::createChain ( )
private

Definition at line 92 of file billboard_line.cpp.

Ogre::MaterialPtr rviz::BillboardLine::getMaterial ( )
inline

Definition at line 99 of file billboard_line.h.

const Ogre::Quaternion & rviz::BillboardLine::getOrientation ( )
virtual

Get the local orientation of this object.

Returns
The orientation

Implements rviz::Object.

Definition at line 292 of file billboard_line.cpp.

const Ogre::Vector3 & rviz::BillboardLine::getPosition ( )
virtual

Get the local position of this object.

Returns
The position

Implements rviz::Object.

Definition at line 287 of file billboard_line.cpp.

Ogre::SceneNode* rviz::BillboardLine::getSceneNode ( )
inline

Get the scene node associated with this object.

Returns
The scene node associated with this object

Definition at line 92 of file billboard_line.h.

void rviz::BillboardLine::newLine ( )

Definition at line 190 of file billboard_line.cpp.

void rviz::BillboardLine::setColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Set the color of the object. Values are in the range [0, 1].

Parameters
rRed component
gGreen component
bBlue component

Implements rviz::Object.

Definition at line 257 of file billboard_line.cpp.

void rviz::BillboardLine::setLineWidth ( float  width)

Definition at line 223 of file billboard_line.cpp.

void rviz::BillboardLine::setMaxPointsPerLine ( uint32_t  max)

Definition at line 169 of file billboard_line.cpp.

void rviz::BillboardLine::setNumLines ( uint32_t  num)

Definition at line 176 of file billboard_line.cpp.

void rviz::BillboardLine::setOrientation ( const Ogre::Quaternion &  orientation)
virtual

Set the orientation of the object.

Parameters
Orientationquaternion orientation to set to.

Implements rviz::Object.

Definition at line 247 of file billboard_line.cpp.

void rviz::BillboardLine::setPosition ( const Ogre::Vector3 position)
virtual

Set the position of this object.

Parameters
Positionvector position to set to.

Implements rviz::Object.

Definition at line 242 of file billboard_line.cpp.

void rviz::BillboardLine::setScale ( const Ogre::Vector3 scale)
virtual

Set the scale of the object. Always relative to the identity orientation of the object.

Parameters
Scalevector scale to set to.

Implements rviz::Object.

Definition at line 252 of file billboard_line.cpp.

void rviz::BillboardLine::setupChains ( )
private

Definition at line 126 of file billboard_line.cpp.

void rviz::BillboardLine::setUserData ( const Ogre::Any &  data)
inlinevirtual

We have no objects that we can set user data on.

Implements rviz::Object.

Definition at line 97 of file billboard_line.h.

Member Data Documentation

V_Chain rviz::BillboardLine::chains_
private

Definition at line 108 of file billboard_line.h.

Ogre::ColourValue rviz::BillboardLine::color_
private

Definition at line 111 of file billboard_line.h.

uint32_t rviz::BillboardLine::current_chain_
private

Definition at line 125 of file billboard_line.h.

uint32_t rviz::BillboardLine::current_line_
private

Definition at line 114 of file billboard_line.h.

uint32_t rviz::BillboardLine::elements_in_current_chain_
private

Definition at line 126 of file billboard_line.h.

uint32_t rviz::BillboardLine::lines_per_chain_
private

Definition at line 123 of file billboard_line.h.

Ogre::MaterialPtr rviz::BillboardLine::material_
private

Definition at line 109 of file billboard_line.h.

uint32_t rviz::BillboardLine::max_points_per_line_
private

Definition at line 122 of file billboard_line.h.

V_uint32 rviz::BillboardLine::num_elements_
private

Definition at line 118 of file billboard_line.h.

uint32_t rviz::BillboardLine::num_lines_
private

Definition at line 121 of file billboard_line.h.

Ogre::SceneNode* rviz::BillboardLine::scene_node_
private

Definition at line 105 of file billboard_line.h.

uint32_t rviz::BillboardLine::total_elements_
private

Definition at line 119 of file billboard_line.h.

float rviz::BillboardLine::width_
private

Definition at line 112 of file billboard_line.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Wed Aug 28 2019 04:01:52