Class Line

Inheritance Relationships

Base Type

Class Documentation

class Line : public rviz_rendering::Object

Public Functions

explicit RVIZ_RENDERING_PUBLIC Line(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. Uses the root scene node if null.

virtual RVIZ_RENDERING_PUBLIC ~Line()
RVIZ_RENDERING_PUBLIC void setPoints (Ogre::Vector3 start, Ogre::Vector3 end)

Set the start and end point of the line.

Parameters:
  • start – The start point.

  • end – The end point.

RVIZ_RENDERING_PUBLIC void setVisible (bool visible)
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 setOrientation (const Ogre::Quaternion &orientation) override

Set the orientation of the object.

Parameters:

Orientation – quaternion orientation 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 void setColor (const Ogre::ColourValue &c)

Set the color of the object using ogre colour definitions.

Parameters:

c – : ogre colour type.

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

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

Set the user data on this object.

Parameters:

data

Protected Attributes

Ogre::SceneNode *scene_node_
Ogre::ManualObject *manual_object_
Ogre::MaterialPtr manual_object_material_