gepetto.corbaserver.tools.Linear Class Reference

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

Public Member Functions

def __init__ (self, nodeName, color=Color.red, radius=0.005)
  Constructor. More...
 
def setRadius (self, radius)
 Set the arrow parameter. 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=1.)
 Set the 3D vector to plot. More...
 

Public Attributes

 name
 
 R
 
 color
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __init__()

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

 Constructor.

Parameters
radiusthe radius of the arrow.

Member Function Documentation

◆ create()

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

Create the node in the GUI.

◆ remove()

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

Delete the node in the GUI.

◆ set()

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

Set the 3D vector to plot.

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

◆ setRadius()

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

Set the arrow parameter.

Parameters
radiusthe radius of the arrow.

Member Data Documentation

◆ color

gepetto.corbaserver.tools.Linear.color

◆ name

gepetto.corbaserver.tools.Linear.name

◆ R

gepetto.corbaserver.tools.Linear.R

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