rviz::Line Class Reference

#include <line.h>

Inheritance diagram for rviz::Line:

Public Member Functions
const Ogre::Quaternion &	getOrientation () override
	Get the local orientation of this object. More...
const Ogre::Vector3 &	getPosition () override
	Get the local position of this object. More...
	Line (Ogre::SceneManager *manager, Ogre::SceneNode *parent_node=nullptr)
	Constructor. More...
void	setColor (float r, float g, float b, float a) override
	Set the color of the object. Values are in the range [0, 1]. More...
virtual void	setColor (const Ogre::ColourValue &c)
	Set the color of the object using ogre colour definitions. More...
void	setOrientation (const Ogre::Quaternion &orientation) override
	Set the orientation of the object. More...
void	setPoints (Ogre::Vector3 start, Ogre::Vector3 end)
	Set the start and end point of the line. More...
void	setPosition (const Ogre::Vector3 &position) override
	Set the position of this object. More...
void	setScale (const Ogre::Vector3 &scale) override
	Set the scale of the object. Always relative to the identity orientation of the object. More...
void	setUserData (const Ogre::Any &data) override
	Set the user data on this object. More...
void	setVisible (bool visible)
	~Line () override
Public Member Functions inherited from rviz::Object
	Object (Ogre::SceneManager *scene_manager)
virtual	~Object ()

Protected Attributes
Ogre::ManualObject *	manual_object_
Ogre::MaterialPtr	manual_object_material_
Ogre::SceneNode *	scene_node_
Protected Attributes inherited from rviz::Object
Ogre::SceneManager *	scene_manager_
	Ogre scene manager this object is part of. More...

Detailed Description

Definition at line 52 of file line.h.

Constructor & Destructor Documentation

Line()

rviz::Line::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. If NULL, uses the root scene node.

Definition at line 42 of file line.cpp.

~Line()

rviz::Line::~Line ( )

override

Definition at line 67 of file line.cpp.

Member Function Documentation

getOrientation()

const Ogre::Quaternion & rviz::Line::getOrientation ( )

overridevirtual

Get the local orientation of this object.

Returns

The orientation

Implements rviz::Object.

Definition at line 140 of file line.cpp.

getPosition()

const Ogre::Vector3 & rviz::Line::getPosition ( )

overridevirtual

Get the local position of this object.

Returns

The position

Implements rviz::Object.

Definition at line 135 of file line.cpp.

setColor() [1/2]

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

overridevirtual

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

Parameters

r	Red component
g	Green component
b	Blue component

Implements rviz::Object.

Definition at line 128 of file line.cpp.

setColor() [2/2]

void rviz::Line::setColor ( const Ogre::ColourValue &  c )

virtual

Set the color of the object using ogre colour definitions.

Parameters

c	: ogre colour type.

Definition at line 109 of file line.cpp.

setOrientation()

void rviz::Line::setOrientation ( const Ogre::Quaternion &  orientation )

overridevirtual

Set the orientation of the object.

Parameters

Orientation

quaternion orientation to set to.

Implements rviz::Object.

Definition at line 99 of file line.cpp.

setPoints()

void rviz::Line::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.

Definition at line 78 of file line.cpp.

setPosition()

void rviz::Line::setPosition ( const Ogre::Vector3 &  position )

overridevirtual

Set the position of this object.

Parameters

Position

vector position to set to.

Implements rviz::Object.

Definition at line 94 of file line.cpp.

setScale()

void rviz::Line::setScale ( const Ogre::Vector3 &  scale )

overridevirtual

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

Parameters

Scale

vector scale to set to.

Implements rviz::Object.

Definition at line 104 of file line.cpp.

setUserData()

void rviz::Line::setUserData ( const Ogre::Any &  data )

overridevirtual

Set the user data on this object.

Parameters

data

Implements rviz::Object.

Definition at line 145 of file line.cpp.

setVisible()

void rviz::Line::setVisible

(

bool

visible

)

Definition at line 88 of file line.cpp.

Member Data Documentation

manual_object_

Ogre::ManualObject* rviz::Line::manual_object_

protected

Definition at line 126 of file line.h.

manual_object_material_

Ogre::MaterialPtr rviz::Line::manual_object_material_

protected

Definition at line 127 of file line.h.

scene_node_

Ogre::SceneNode* rviz::Line::scene_node_

protected

Definition at line 125 of file line.h.

---

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

• line.h
• line.cpp