rviz::Line Class Reference

#include <line.h>

Inheritance diagram for rviz::Line:

List of all members.

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

---

Detailed Description

Definition at line 53 of file line.h.

---

Constructor & Destructor Documentation

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

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 43 of file line.cpp.

rviz::Line::~Line

(

)

[virtual]

Definition at line 68 of file line.cpp.

---

Member Function Documentation

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

(

)

[virtual]

Get the local orientation of this object.

Returns:

The orientation

Implements rviz::Object.

Definition at line 141 of file line.cpp.

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

(

)

[virtual]

Get the local position of this object.

Returns:

The position

Implements rviz::Object.

Definition at line 136 of file line.cpp.

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

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 129 of file line.cpp.

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 110 of file line.cpp.

void rviz::Line::setOrientation

(

const Ogre::Quaternion &

orientation

)

[virtual]

Set the orientation of the object.

Parameters:

Orientation

quaternion orientation to set to.

Implements rviz::Object.

Definition at line 100 of file line.cpp.

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 79 of file line.cpp.

void rviz::Line::setPosition

(

const Ogre::Vector3 &

position

)

[virtual]

Set the position of this object.

Parameters:

Position

vector position to set to.

Implements rviz::Object.

Definition at line 95 of file line.cpp.

void rviz::Line::setScale

(

const Ogre::Vector3 &

scale

)

[virtual]

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 105 of file line.cpp.

void rviz::Line::setUserData

(

const Ogre::Any &

data

)

[virtual]

Set the user data on this object.

Parameters:

data

Implements rviz::Object.

Definition at line 146 of file line.cpp.

void rviz::Line::setVisible

(

bool

visible

)

Definition at line 89 of file line.cpp.

---

Member Data Documentation

Ogre::ManualObject* rviz::Line::manual_object_ [protected]

Definition at line 127 of file line.h.

Ogre::MaterialPtr rviz::Line::manual_object_material_ [protected]

Definition at line 128 of file line.h.

Ogre::SceneNode* rviz::Line::scene_node_ [protected]

Definition at line 126 of file line.h.

---

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

• line.h
• line.cpp