We want to reduce the impact of BlenderVR on the blender file (.blend). For instance, all the interactions issued from the plugins (VRPN, OSC ...) don’t have to be defined inside the .blend file, since they do not exists outside BlenderVR development frame. Moreover, elements to synchronize interaction from master to slaves cannot be defined inside .blend file.
BlenderVR thus introduces the notion of processor file. It is a Python file associated with the .blend that contains all the interactions required to use the .blend file within BlenderVR. By default (and you should not change it) this file is in the same folder than the .blend file and its name is the name of the blender file minus .blend, but post-fixed by .processor.py. For instance, the processor file of simple.blend is simple.processor.py.
Refer to the Complete API for all the available commands and functionality.
- Minimal Processor File
- Basic Processor File
- Debugging Processor Through Log Messages
- Keyboard and Mouse
- Choose Objects to Synchronize
- Processor Inheritance
- Master-Slaves Communication
- Stream: Processor as Synchronized Object
- One-Shot: Specifically Send a Data
- Run() Method
- Console-“Virtual Environment” Communication
Minimal Processor File¶
The minimal processor file contains:
import blendervr if blendervr.is_virtual_environment(): class Processor(blendervr.processor.getProcessor()): def __init__(self, parent): super(Processor, self).__init__(parent) elif blendervr.is_console(): class Processor(blendervr.processor.getProcessor()): def __init__(self, console): super(Processor, self).__init__(console)
Basic Processor File¶
Unlike the Minimum Processor File, this one actually does something (in this case it synchronizes all the objects between the master and the slaves. This is file is fully explained in the Basic Example of the BlenderVR API.
import blendervr if blendervr.is_virtual_environment(): import bge class Processor(blendervr.processor.getProcessor()): def __init__(self, parent): super(Processor, self).__init__(parent) if self.BlenderVR.isMaster(): self.BlenderVR.getSceneSynchronizer().\ getItem(bge.logic).activate(True, True) elif blendervr.is_creating_loader(): import bpy class Processor(blendervr.processor.getProcessor()): def __init__(self, creator): super(Processor, self).__init__(creator) elif blendervr.is_console(): class Processor(blendervr.processor.getProcessor()): def __init__(self, console): global try_wait_user_name, try_chooser, try_console_arc_balls super(Processor, self).__init__(console) def useLoader(self): return True
Debugging Processor Through Log Messages¶
As you have probably seen in Debug window per screen , the output of blenderplayer is not displayed by default in the console during BlenderVR runs.
Thus, you cannot use basic print python commands to help you while debugging.
You should instead use the BlenderVR standard logger usable inside any BlenderVR object (due to inheritance):
self.logger.debug("blah blah ...")
blah blah ... is whatever you want, comma separated, as long as there is a “stringification” method (__str__) for each element. The logger object inherits from python login module. Thus, you can replace debug by info, warning, error, critical. Depending on the log window level selection (see the screen window of the Run tab of the Console), you will see your message or not.
You can also use self.logger.log_traceback(False) to display the traceback of your program. True in parenthesis means an error, then BlenderVR will stop running in “Virtual Environment”. This traceback is available inside as well as outside an exception.
There is also self.logger.log_position() that simply displays the position of the calling method in debug level.
Keyboard and Mouse¶
You can use a logger to see what is contained inside the info argument. You can also have a look at the simple.processor.py file inside simple sample folder to get an example of how to use this method.
Choose Objects to Synchronize¶
By default, BlenderVR doesn’t synchronize scene objects (blacklisting for efficiency issues). You must specify the elements you want to synchronize by explicitly flagging the objects to synchronize by the master node:
# synchronizer.objects.getItem(enable, recursive = True) # synchronizer.objects.item_base.Base.activate(enable, recursive = True) if self.BlenderVR.isMaster(): self.BlenderVR.getSceneSynchronizer().getItem(bge.logic).activate(True, True)
This method will synchronize (first True as activate parameter) all elements recursively (second True as activate parameter) from the bge.logic (that is the root of the .blend file). In other words, it will activate all the objects of the scene. You can also synchronize only a few objects by applying this call to each item (the objects as parameter of getItem).
We commonly use the same interactions on different scenes. For instance, the Head Control Navigation system is useful on most scenes. BlenderVR allows the developer to have a “generic” processor that all other processors will be able to use by inheritance. You can add an intermediate processor by adding a line at the beginning of your processor:
blendervr.processor.appendProcessor(os.path.join(BlenderVR_root, 'samples', 'processors.py'))
This line specifically adds the processors.py (from folder samples of BlenderVR) processor to each processor in the sample folder. This processor proposes:
Inside the virtual environment:
- Head control navigation system to navigate through the world just with your head as joystick (see mountain sample)
- Laser interaction, useful when you want to select objects from your scene (see chess sample)
- Viewpoint manipulation in the same way than blender uses in its graphic window (see simple sample and press ‘v’ to use it)
- ‘Q’ to quit clean quit the “Virtual Environment”
Inside the console:
- User interface that can include buttons for Head control navigation system
We suggest you to have a look at the processor files inside the sample folder before you write your owns.
Inside the processors, you can send data from the master to the slaves.
There is no solution to send data from any slave to the master nor any other slave !
Stream: Processor as Synchronized Object¶
You can register your processor as a synchronized object. As such, at each frame, the synchronizer will ask the master’s processor (through getSynchronizerBuffer() method) the buffer to send to the slaves. Then, if the buffer is not empty (getSynchronizerBuffer() doesn’t return None), each slave, in the same frame, will receive it through its processSynchronizerBuffer() method.
To register your processor, you must call from the constructor of your “virtual environment” processor:
self.BlenderVR.addObjectToSynchronize(self, 'main processor')
The argument in single quote is the name of the processor used by the synchronizer to disambiguate between all synchronized objects. You can use anything else than main processor, but this is a good default choice.
As an example, you can have a look at the simple.processor.py in sample folder, where try_use_stream_between_master_and_slave is set to True.
One-Shot: Specifically Send a Data¶
When you don’t need to send data through a stream (ie.: each frame), you can send one data sometime with sendToSlaves/receivedFromMaster methods. The first argument is a string describing your data whereas the second argument is the data.
Beware that this processing use encapsulation and JSON to encode and decode the data. That is heavier than the stream mechanisms and must be applied to data with a low update rate only.
As an example, you can have a look at the simple.processor.py in sample folder, when you press ‘s’ (see method keyboardAndMouse) on the master.
The run method will be called at each frame on the master node. Thus, if you need to process something (register a data, update a value, etc.), you can add whatever you want here. To process something on the slaves, you should unlock it with previous mechanisms to send data from the master to the slaves.
Console-“Virtual Environment” Communication¶
You can send data from the master “virtual environment” node to the console (sendToConsole/receivedFromVirtualEnvironment). You can also do the opposite, from console to “virtual environment” (sendToVirtualEnvironment/receivedFromConsole).
As usual, the simple.processor.py file shows the use of this mechanism. If you set try_wait_user_name to True, then the “virtual environment” is paused. To unlock it, you must type a name in the processor window from the console and you click on Set user name. Then, the name will be sent to the master node that will display it and answer the console.