visualizer.hud.Axes Class Reference

Axes class. More...

Inheritance diagram for visualizer.hud.Axes:

Collaboration diagram for visualizer.hud.Axes:

Public Member Functions
def	__init__ (self, viz)
	Initializer function. More...
def	set_visible (self, visible)
	Set visible function. More...
def	update_view (self)
	Update view function. More...

Public Attributes
	color
	color More...
	hlines
	horizontal lines More...
	labels
	list of labels More...
	visible
	visible More...
	viz
	visualizer More...
	vlines
	vertical lines More...

Private Member Functions
def	_compute_divisions (self, xi, xf)
	Compute divisions function. More...

Detailed Description

Axes class.

Definition at line 9 of file hud.py.

Constructor & Destructor Documentation

__init__()

def visualizer.hud.Axes.__init__	(		self,
			viz
	)

Initializer function.

Parameters

self	this object
viz	visualization object

Returns

none

Definition at line 22 of file hud.py.

Member Function Documentation

_compute_divisions()

def visualizer.hud.Axes._compute_divisions (   self,   xi,   xf  )

private

Compute divisions function.

Parameters

self	this object
xi	xi
xf	xf

Returns

x0 and div

Definition at line 67 of file hud.py.

Referenced by visualizer.hud.Axes.update_view().

Here is the caller graph for this function:

set_visible()

def visualizer.hud.Axes.set_visible	(		self,
			visible
	)

Set visible function.

Parameters

self	this object
visible	visible indicator

Returns

none

Definition at line 49 of file hud.py.

References visualizer.hud.Axes.hlines, visualizer.hud.Axes.labels, visualizer.hud.Axes.visible, and visualizer.hud.Axes.vlines.

update_view()

def visualizer.hud.Axes.update_view

(

self

)

Update view function.

Parameters

self	this object

Returns

none

Definition at line 106 of file hud.py.

References visualizer.hud.Axes._compute_divisions(), visualizer.hud.Axes.color, visualizer.hud.Axes.hlines, visualizer.hud.Axes.labels, visualizer.hud.Axes.viz, visualizer.core.SimulationThread.viz, and visualizer.hud.Axes.vlines.

Here is the call graph for this function:

Member Data Documentation

color

visualizer.hud.Axes.color

color

Definition at line 31 of file hud.py.

Referenced by visualizer.hud.Axes.update_view().

hlines

visualizer.hud.Axes.hlines

horizontal lines

Definition at line 32 of file hud.py.

Referenced by visualizer.hud.Axes.set_visible(), and visualizer.hud.Axes.update_view().

labels

visualizer.hud.Axes.labels

list of labels

Definition at line 36 of file hud.py.

Referenced by visualizer.hud.Axes.set_visible(), and visualizer.hud.Axes.update_view().

visible

visualizer.hud.Axes.visible

visible

Definition at line 46 of file hud.py.

Referenced by visualizer.hud.Axes.set_visible().

viz

visualizer.hud.Axes.viz

visualizer

Definition at line 30 of file hud.py.

Referenced by visualizer.hud.Axes.update_view().

vlines

visualizer.hud.Axes.vlines

vertical lines

Definition at line 34 of file hud.py.

Referenced by visualizer.hud.Axes.set_visible(), and visualizer.hud.Axes.update_view().

---

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

• src/visualizer/visualizer/hud.py