gepetto.corbaserver.tools.Linear Class Reference

Public Member Functions
	__init__ (self, nodeName, color=Color.red, radius=0.005)
	setRadius (self, radius)
	create (self, gui)
	remove (self, gui)
	set (self, gui, value, origin=(0, 0, 0), factor=1.0)

Public Attributes
	name = nodeName
	R = radius
	color = color

Detailed Description

Helper class to plot a 3D vector as a straight arrow.

Constructor & Destructor Documentation

__init__()

gepetto.corbaserver.tools.Linear.__init__	(		self,
			nodeName,
			color = Color.red,
			radius = 0.005 )

Constructor
\\param radius the radius of the arrow.

Member Function Documentation

create()

gepetto.corbaserver.tools.Linear.create	(		self,
			gui )

Create the node in the GUI.

remove()

gepetto.corbaserver.tools.Linear.remove	(		self,
			gui )

Delete the node in the GUI.

set()

gepetto.corbaserver.tools.Linear.set	(		self,
			gui,
			value,
			origin = (0, 0, 0),
			factor = 1.0 )

Set the 3D vector to plot
\\param gui    the IDL client (typically the \\c gui attribute
                               of class gepetto.corbaserver.client.Client)
\\param value  the vector to plot (list or tuple of 3 elements)
\\param origin the translation of the origin (list or tuple of 3 elements)
\\param factor the norm of the vector is divided by this value

setRadius()

gepetto.corbaserver.tools.Linear.setRadius	(		self,
			radius )

Set the arrow parameter.
\\param radius the radius of the arrow.

Member Data Documentation

color

gepetto.corbaserver.tools.Linear.color = color

name

gepetto.corbaserver.tools.Linear.name = nodeName

R

gepetto.corbaserver.tools.Linear.R = radius

---

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

• src/gepetto/corbaserver/tools.py