graphics Package

base Module

class Axes(pos=(0, 0, 0), rot=None, cylinder_radius=0.05)

Bases: ars.graphics.base.Entity

class Body(center, rot)

Bases: ars.graphics.base.Entity

Entity representing a defined body with a given color.

get_color()

set_color(color)

class Box(size, pos, rot=None)

Bases: ars.graphics.base.Body

class Capsule(length, radius, center, rot=None, resolution=10)

Bases: ars.graphics.base.Body

class Cone(height, radius, center, rot=None, resolution=100)

Bases: ars.graphics.base.Body

Constructor.

Parameters:resolution (int) – it is the circumferential number of facets

class Cylinder(length, radius, center, rot=None, resolution=10)

Bases: ars.graphics.base.Body

class Engine(*args, **kwargs)

Bases: object

Abstract class. Not coupled (at all) with VTK or any other graphics library

add_object(obj)

Add obj to the visualization controlled by this adapter.

Parameters:obj (Body) –

add_objects_list(obj_list)

finalize_window()

Finalize window and remove/clear associated resources.

remove_object(obj)

Remove obj from the visualization controlled by this adapter.

Parameters:obj (Body) –

reset()

restart_window()

start_window(on_idle_callback, on_reset_callback, on_key_press_callback)

class Entity(pos, rot)

Bases: object

Renderable and movable object.

It has position and orientation. The underlying object is actor, which connects to the real entity handled by the graphics library in use.

actor

adapter = None

set_pose(pos, rot)

class ScreenshotRecorder(base_filename)

Bases: object

calc_filename(index=1)

Calculate a filename using index for a new image.

Parameters:index (int) – image’s index to use for filename calculation Returns:image’s filename Return type:str

file_extension = None

write(index, time)

Write render-window’s currently displayed image to a file.

The image format (thus the file extension too) to use must be defined by the implementation.

Image’s filename is determined by calc_filename().

Parameters:

• index (int) – image’s index to use for filename calculation
• time –

class Sphere(radius, center, rot=None, phi_resolution=50, theta_resolution=50)

Bases: ars.graphics.base.Body

Constructor.

Parameters:

• phi_resolution (int) – resolution in the latitude (phi) direction
• theta_resolution (int) – resolution in the longitude (theta) direction

class Trimesh(vertices, faces, pos=None, rot=None)

Bases: ars.graphics.base.Body

vtk_adapter Module

class Axes(pos=(0, 0, 0), rot=None, cylinder_radius=0.05)

Bases: ars.graphics.vtk_adapter.Entity, ars.graphics.base.Axes

class Body(*args, **kwargs)

Bases: ars.graphics.vtk_adapter.Entity

get_color()

Returns the color of the body. If it is an assembly, it is not checked whether all the objects’ colors are equal.

set_color(color)

Sets the color of the body. If it is an assembly, all the objects’ color is set.

class Box(size, pos, rot=None)

Bases: ars.graphics.vtk_adapter.Body, ars.graphics.base.Box

class Capsule(length, radius, center, rot=None, resolution=20)

Bases: ars.graphics.vtk_adapter.Body, ars.graphics.base.Capsule

class Cone(height, radius, center, rot=None, resolution=20)

Bases: ars.graphics.vtk_adapter.Body, ars.graphics.base.Cone

class Cylinder(length, radius, center, rot=None, resolution=20)

Bases: ars.graphics.vtk_adapter.Body, ars.graphics.base.Cylinder

class Engine(title, pos=None, size=(1000, 600), zoom=1.0, cam_position=(10, 8, 10), background_color=(0.1, 0.1, 0.4), **kwargs)

Bases: ars.graphics.base.Engine

Graphics adapter to the Visualization Toolkit (VTK) library

add_object(obj)

finalize_window()

Finalize and delete renderer, render_window and interactor.

See also

http://stackoverflow.com/questions/15639762/ and http://docs.python.org/2/reference/datamodel.html#object.__del__

remove_object(obj)

reset()

restart_window()

start_window(on_idle_callback=None, on_reset_callback=None, on_key_press_callback=None)

class Entity(*args, **kwargs)

Bases: object

adapter

alias of Engine

class ScreenshotRecorder(base_filename='screenshot_', graphics_adapter=None)

Bases: ars.graphics.base.ScreenshotRecorder

Based on an official example script, very simple: http://www.vtk.org/Wiki/VTK/Examples/Python/Screenshot

file_extension = 'png'

write(index=1, time=None)

Note

Image files format is PNG, and extension is .png.

class Sphere(radius, center, rot=None, phi_resolution=20, theta_resolution=20)

Bases: ars.graphics.vtk_adapter.Body, ars.graphics.base.Sphere

VTK: sphere (represented by polygons) of specified radius centered at the origin. The resolution (polygonal discretization) in both the latitude (phi) and longitude (theta) directions can be specified.

class Trimesh(vertices, faces, pos, rot=None)

Bases: ars.graphics.vtk_adapter.Body, ars.graphics.base.Trimesh