Class BillboardLine

Inheritance Relationships

Base Type

Class Documentation

class BillboardLine : public rviz_rendering::Object

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

Public Types

typedef std::vector<Ogre::BillboardChain*> V_ChainContainers

Public Functions

explicit RVIZ_RENDERING_PUBLIC BillboardLine(Ogre::SceneManager *manager, Ogre::SceneNode *parent_node = nullptr)

Constructor.

Parameters:

  • manager – Scene manager this object is a part of

  • parent_node – A scene node to use as the parent of this object. If NULL, uses the root scene node.

RVIZ_RENDERING_PUBLIC ~BillboardLine() override
RVIZ_RENDERING_PUBLIC void clear ()
RVIZ_RENDERING_PUBLIC void finishLine ()
RVIZ_RENDERING_PUBLIC void addPoint (const Ogre::Vector3 &point)
RVIZ_RENDERING_PUBLIC void addPoint (const Ogre::Vector3 &point, const Ogre::ColourValue &color)
RVIZ_RENDERING_PUBLIC void setLineWidth (float width)
RVIZ_RENDERING_PUBLIC void setMaxPointsPerLine (uint32_t max)
RVIZ_RENDERING_PUBLIC void setNumLines (uint32_t num)
virtual RVIZ_RENDERING_PUBLIC void setOrientation (const Ogre::Quaternion &orientation) override

Set the orientation of the object.

Parameters:

Orientation – quaternion orientation to set to.

virtual RVIZ_RENDERING_PUBLIC void setPosition (const Ogre::Vector3 &position) override

Set the position of this object.

Parameters:

Position – vector position to set to.

virtual RVIZ_RENDERING_PUBLIC void setScale (const Ogre::Vector3 &scale) override

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

Parameters:

Scale – vector scale to set to.

virtual RVIZ_RENDERING_PUBLIC void setColor (float r, float g, float b, float a) override

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

Parameters:

  • r – Red component

  • g – Green component

  • b – Blue component

virtual RVIZ_RENDERING_PUBLIC const Ogre::Vector3 & getPosition () override

Get the local position of this object.

Returns:

The position

virtual RVIZ_RENDERING_PUBLIC const Ogre::Quaternion & getOrientation () override

Get the local orientation of this object.

Returns:

The orientation

inline Ogre::SceneNode *getSceneNode()

Get the scene node associated with this object.

Returns:

The scene node associated with this object

inline virtual void setUserData(const Ogre::Any &data) override

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

inline Ogre::MaterialPtr getMaterial()
inline V_ChainContainers getChains()

exposed for testing