gepetto.corbaserver.tools.Angular Class Reference

Helper class to plot a 3D vector as a circular arrow. More...

Public Member Functions
def	__init__ (self, nodeName, color=Color.red, majorRadius=0.1, minorRadius=0.005, majorN=100, minorN=20)
	Constructor. More...
def	setTorusParameters (self, majorRadius, minorRadius, majorN, minorN)
	Set the torus parameters. More...
def	create (self, gui)
	Create the node in the GUI. More...
def	remove (self, gui)
	Delete the node in the GUI. More...
def	set (self, gui, value, origin=(0, 0, 0), factor=pi)
	Set the 3D vector to plot. More...

Public Attributes
	name
	color
	R
	r
	nR
	nr
	minC
	maxC

Detailed Description

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

Constructor & Destructor Documentation

__init__()

def gepetto.corbaserver.tools.Angular.__init__	(		self,
			nodeName,
			color = Color.red,
			majorRadius = 0.1,
			minorRadius = 0.005,
			majorN = 100,
			minorN = 20
	)

Constructor.

Parameters

majorRadius,majorN	radius and discretisation of the circle that is the center of the torus
minorRadius,minorN	radius and discretisation of the circle that is a section of the torus

Member Function Documentation

create()

def gepetto.corbaserver.tools.Angular.create	(		self,
			gui
	)

Create the node in the GUI.

remove()

def gepetto.corbaserver.tools.Angular.remove	(		self,
			gui
	)

Delete the node in the GUI.

set()

def gepetto.corbaserver.tools.Angular.set	(		self,
			gui,
			value,
			origin = (0,0,0),
			factor = pi
	)

Set the 3D vector to plot.

Parameters

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

setTorusParameters()

def gepetto.corbaserver.tools.Angular.setTorusParameters	(		self,
			majorRadius,
			minorRadius,
			majorN,
			minorN
	)

Set the torus parameters.

Parameters

majorRadius,majorN	radius and discretisation of the circle that is the center of the torus
minorRadius,minorN	radius and discretisation of the circle that is a section of the torus

Member Data Documentation

color

gepetto.corbaserver.tools.Angular.color

maxC

gepetto.corbaserver.tools.Angular.maxC

minC

gepetto.corbaserver.tools.Angular.minC

name

gepetto.corbaserver.tools.Angular.name

nR

gepetto.corbaserver.tools.Angular.nR

nr

gepetto.corbaserver.tools.Angular.nr

R

gepetto.corbaserver.tools.Angular.R

r

gepetto.corbaserver.tools.Angular.r

---

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

• src/gepetto/corbaserver/tools.py