gepetto-viewer-corba 5.8.0
Corba server for gepetto-viewer
Loading...
Searching...
No Matches
gepetto.corbaserver.tools.Vector6 Class Reference

Public Member Functions

 __init__ (self, groupName, angFactor=pi, linFactor=1.0)
 
 create (self, gui)
 
 remove (self, gui)
 
 set (self, gui, value, origin=(0, 0, 0))
 

Public Attributes

 name
 
 linear
 
 angular
 
 angF
 
 linF
 

Static Public Attributes

str suffixLin = "linear"
 
str suffixAng = "angular"
 

Detailed Description

Helper class to plot a 6D vector with one Linear and one Angular arrow.
The 3 first components of the 6D vector are sent to the Linear arrow
and the 3 last ones are sent to the Angular arrow.
It is useful to plot velocities of a body, forces and torques...
Example usage:
\\code
from gepetto.corbaserver import Client
from gepetto.corbaserver.tools import Vector6

client = Client()
gui = client.gui
gui.createWindow ("window")
vector = Vector6 ("window")
vector.create (gui)
vector.set (gui, [.1, .2, .3, .1, -.2, .3])
\\endcode

Constructor & Destructor Documentation

◆ __init__()

gepetto.corbaserver.tools.Vector6.__init__ ( self,
groupName,
angFactor = pi,
linFactor = 1.0 )
Constructor
To tune the parameter of the 3D arrows, directly acces the attributes:
- Vector6.linear
- Vector6.angular
- Vector6.linF
- Vector6.angF
\\param groupName name of an **existing** group
\\param angFactor the norm of the angular part of the vector is divided by
       this value
\\param linFactor the norm of the linear part of the vector is divided by
       this value

Member Function Documentation

◆ create()

gepetto.corbaserver.tools.Vector6.create ( self,
gui )
Create the node in the GUI.

◆ remove()

gepetto.corbaserver.tools.Vector6.remove ( self,
gui )
Delete the node in the GUI.

◆ set()

gepetto.corbaserver.tools.Vector6.set ( self,
gui,
value,
origin = (0, 0, 0) )
Set the 6D 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 6 elements)
\\param origin the translation of the origin (list or tuple of 3 elements)

Member Data Documentation

◆ angF

gepetto.corbaserver.tools.Vector6.angF

◆ angular

gepetto.corbaserver.tools.Vector6.angular

◆ linear

gepetto.corbaserver.tools.Vector6.linear

◆ linF

gepetto.corbaserver.tools.Vector6.linF

◆ name

gepetto.corbaserver.tools.Vector6.name

◆ suffixAng

str gepetto.corbaserver.tools.Vector6.suffixAng = "angular"
static

◆ suffixLin

str gepetto.corbaserver.tools.Vector6.suffixLin = "linear"
static

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