octapyx 0.0.19

Library for creating OCTAS® world XML files through Python.

octapyx

A Python framework for writing OCTAS® XML files via Python code.

It imports OCTAS® definitions for steppers and properties, and provides these through Python modules.

Python code written based on octapyx

XML file to be opened in OCTAS®

import octapyx.oct.world as world from octapyx.modules.org.octane.oct.ent import Camera from octapyx.modules.org.octane.oct.prop import Pose, TfTree from octapyx.modules.org.octane.stdlib import TfTreeStepper world = world.World() renderCamera = world.add( Camera("renderCamera")) renderCamera.assign( Pose( position=[1, 2, 3])) renderCamera.assign( TfTree( position=[3, 2, 1])) tfTreeStepper = world.add( TfTreeStepper( name="tfTreeStepper")) tfTreeStepper.registerEntity( entity=renderCamera) tfTreeStepper.step() world.addToScheduler(tfTreeStepper) world.write("example.oct.xml") # Optional: Run OCTAS® directly # by loading the world. world.run()

<World> <!--Generated by octapyx.--> <Entity ucn="octane.org/oct/ent/Camera" name="renderCamera"> <Property ucn="octane.org/oct/prop/Pose" position="1 2 3" /> <Property ucn="octane.org/oct/prop/TfTree" position="3 2 1" /> </Entity> <Stepper ucn="octane.org/stdlib/TfTreeStepper" name="tfTreeStepper"> <registerEntity name="renderCamera" /> </Stepper> <Build fromStepper="tfTreeStepper" /> <Scheduler ucn="oct/sched/ASyncThreadScheduler"> <addStepper name="tfTreeStepper" /> </Scheduler> </World>

In particular, it enables the use of Python control flows (if, for, ...), libraries and interfaces to generate complex scenes in a flexible, adaptive way.

Installation

Install the octapyx package by running:

pip install octapyx

or

pip install git+https://gitlab.cc-asp.fraunhofer.de/octas/tools/python/octaspyxml