multi-user/net_operators.py

646 lines
18 KiB
Python
Raw Normal View History

2019-03-14 00:02:53 +08:00
from bpy_extras import view3d_utils
import bpy
from . import net_components
from . import net_ui
from . import rna_translation
2019-02-11 22:48:07 +08:00
import time
2019-02-12 00:02:25 +08:00
import logging
import mathutils
2019-02-22 23:46:35 +08:00
import random
import string
import bgl
import blf
import gpu
from gpu_extras.batch import batch_for_shader
2019-02-12 00:02:25 +08:00
logger = logging.getLogger(__name__)
2019-02-11 22:48:07 +08:00
client = None
server = None
context = None
2019-03-14 00:20:19 +08:00
COLOR_TABLE = [(1, 0, 0, 1), (0, 1, 0, 1), (0, 0, 1, 1),(0, 0.5, 1, 1),(0.5, 0, 1, 1)]
NATIVE_TYPES = (
bpy.types.IntProperty,
bpy.types.FloatProperty,
bpy.types.BoolProperty,
bpy.types.StringProperty,
)
def view3d_find():
for area in bpy.context.window.screen.areas:
if area.type == 'VIEW_3D':
v3d = area.spaces[0]
rv3d = v3d.region_3d
for region in area.regions:
if region.type == 'WINDOW':
return area, region, rv3d
2019-03-14 00:02:53 +08:00
break
2019-03-14 00:02:53 +08:00
return None, None, None
2019-03-14 00:02:53 +08:00
def get_target(region, rv3d, coord):
view_vector = view3d_utils.region_2d_to_vector_3d(region, rv3d, coord)
ray_origin = view3d_utils.region_2d_to_origin_3d(region, rv3d, coord)
2019-03-14 00:02:53 +08:00
target = ray_origin + view_vector
return [target.x, target.y, target.z]
def get_client_view_rect():
area, region, rv3d = view3d_find()
2019-03-14 00:02:53 +08:00
v1 = [0, 0, 0]
v2 = [0, 0, 0]
v3 = [0, 0, 0]
v4 = [0, 0, 0]
width = region.width
height = region.height
2019-03-14 00:02:53 +08:00
v1 = get_target(region, rv3d, (0, 0))
v3 = get_target(region, rv3d, (0, height))
v2 = get_target(region, rv3d, (width, height))
v4 = get_target(region, rv3d, (width, 0))
coords = (v1, v2, v3, v4)
indices = (
2019-03-14 00:02:53 +08:00
(1, 3), (2, 1), (3, 0), (2, 0)
)
return coords
2019-03-14 00:02:53 +08:00
def get_client_view_rect():
area, region, rv3d = view3d_find()
2019-03-14 00:02:53 +08:00
v1 = [0, 0, 0]
v2 = [0, 0, 0]
v3 = [0, 0, 0]
v4 = [0, 0, 0]
width = region.width
height = region.height
2019-03-14 00:02:53 +08:00
v1 = get_target(region, rv3d, (0, 0))
v3 = get_target(region, rv3d, (0, height))
v2 = get_target(region, rv3d, (width, height))
v4 = get_target(region, rv3d, (width, 0))
coords = (v1, v2, v3, v4)
indices = (
2019-03-14 00:02:53 +08:00
(1, 3), (2, 1), (3, 0), (2, 0)
)
return coords
2019-03-14 00:02:53 +08:00
def get_client_2d(coords):
area, region, rv3d = view3d_find()
2019-03-14 00:02:53 +08:00
return view3d_utils.location_3d_to_region_2d(region, rv3d, coords)
2019-02-26 01:05:46 +08:00
def on_scene_evalutation(scene):
# TODO: viewer representation
# TODO: Live update only selected object
# TODO: Scene representation
pass
2019-02-22 23:46:35 +08:00
2019-02-22 23:46:35 +08:00
def randomStringDigits(stringLength=6):
"""Generate a random string of letters and digits """
lettersAndDigits = string.ascii_letters + string.digits
return ''.join(random.choice(lettersAndDigits) for i in range(stringLength))
2019-02-26 01:05:46 +08:00
def match_supported_types(value):
type_factory = None
2019-02-26 01:05:46 +08:00
if isinstance(value, bool):
print("float")
2019-02-26 01:05:46 +08:00
elif isinstance(value, mathutils.Vector):
print("vector")
type_factory = VectorTypeTranslation()
2019-02-26 01:05:46 +08:00
elif isinstance(value, mathutils.Euler):
print("Euler")
elif type(value) in NATIVE_TYPES:
print("native")
else:
raise NotImplementedError
2019-02-26 01:05:46 +08:00
return type_factory
# TODO: Less ugly method
def from_bpy(value):
2019-02-14 22:30:35 +08:00
logger.debug(' casting from bpy')
value_type = type(value)
value_casted = None
if value_type is mathutils.Vector:
2019-02-26 01:05:46 +08:00
value_casted = [value.x, value.y, value.z]
elif value_type is bpy.props.collection:
2019-02-26 01:05:46 +08:00
pass # TODO: Collection replication
elif value_type is mathutils.Euler:
2019-02-26 01:05:46 +08:00
value_casted = [value.x, value.y, value.z]
elif value_type is NATIVE_TYPES:
value_casted = value
2019-02-26 01:05:46 +08:00
return str(value.__class__.__name__), value_casted
def to_bpy(store_item):
"""
Get bpy value from store
"""
value_type = store_item.mtype
value_casted = None
store_value = store_item.body
if value_type == 'Vector':
2019-02-26 01:05:46 +08:00
value_casted = mathutils.Vector(
(store_value[0], store_value[1], store_value[2]))
return value_casted
2019-02-26 01:05:46 +08:00
def resolve_bpy_path(path):
"""
Get bpy property value from path
"""
path = path.split('/')
obj = None
attribute = path[2]
2019-02-14 22:30:35 +08:00
logger.debug("resolving {}".format(path))
2019-02-26 01:05:46 +08:00
try:
2019-02-26 01:05:46 +08:00
obj = getattr(bpy.data, path[0])[path[1]]
attribute = getattr(obj, path[2])
logger.debug("done {} : {}".format(obj, attribute))
except AttributeError:
2019-02-14 22:30:35 +08:00
logger.debug(" Attribute not found")
return obj, attribute
2019-02-26 01:05:46 +08:00
def observer():
2019-02-14 22:30:35 +08:00
global client
if client:
for key, values in client.property_map.items():
try:
obj, attr = resolve_bpy_path(key)
2019-02-14 22:30:35 +08:00
if attr != to_bpy(client.property_map[key]):
value_type, value = from_bpy(attr)
client.push_update(key, value_type, value)
except:
pass
return bpy.context.scene.session_settings.update_frequency
2019-02-14 22:30:35 +08:00
2019-02-22 23:46:35 +08:00
def refresh_window():
import bpy
2019-02-12 00:02:25 +08:00
bpy.ops.wm.redraw_timer(type='DRAW_WIN_SWAP', iterations=1)
2019-02-11 22:48:07 +08:00
2019-03-14 00:02:53 +08:00
def init_scene(msg):
pass
2019-02-26 01:05:46 +08:00
2019-03-14 00:02:53 +08:00
def update_scene(msg):
2019-02-14 22:30:35 +08:00
global client
2019-02-14 22:30:35 +08:00
if msg.id != client.id:
if msg.mtype == 'client' and msg.id is not client.id:
refresh_window()
2019-03-14 01:35:59 +08:00
elif msg.mtype == 'object':
refresh_window()
else:
value = None
obj, attr = resolve_bpy_path(msg.key)
attr_name = msg.key.split('/')[2]
value = to_bpy(msg)
# print(msg.get)
logger.debug("Updating scene:\n object: {} attribute: {} , value: {}".format(
obj, attr_name, value))
try:
setattr(obj, attr_name, value)
except:
pass
2019-02-14 22:30:35 +08:00
else:
logger.debug('no need to update scene on our own')
2019-03-14 00:02:53 +08:00
def update_ui(msg):
"""
Update collaborative UI elements
"""
pass
2019-02-26 01:05:46 +08:00
2019-03-14 00:02:53 +08:00
recv_callbacks = [update_scene, update_ui]
2019-02-26 01:05:46 +08:00
post_init_callbacks = [refresh_window]
2019-02-22 23:46:35 +08:00
2019-02-12 00:31:03 +08:00
class session_join(bpy.types.Operator):
bl_idname = "session.join"
bl_label = "join"
2019-02-11 22:48:07 +08:00
bl_description = "connect to a net server"
bl_options = {"REGISTER"}
@classmethod
def poll(cls, context):
return True
def execute(self, context):
global client
2019-02-22 23:46:35 +08:00
net_settings = context.scene.session_settings
2019-02-26 01:05:46 +08:00
2019-02-22 23:46:35 +08:00
if net_settings.username == "DefaultUser":
2019-02-26 01:05:46 +08:00
net_settings.username = "{}_{}".format(
net_settings.username, randomStringDigits())
2019-02-22 23:46:35 +08:00
username = str(context.scene.session_settings.username)
client_factory = rna_translation.RNAFactory()
print("{}".format(client_factory.__class__.__name__))
2019-02-26 01:05:46 +08:00
client = net_components.Client(
2019-03-14 00:02:53 +08:00
id=username,
on_recv=recv_callbacks,
on_post_init=post_init_callbacks,
factory=client_factory)
2019-03-06 21:01:33 +08:00
# time.sleep(1)
2019-02-11 22:48:07 +08:00
bpy.ops.asyncio.loop()
bpy.app.timers.register(observer)
2019-02-11 22:48:07 +08:00
net_settings.is_running = True
bpy.ops.session.draw('INVOKE_DEFAULT')
2019-02-11 22:48:07 +08:00
return {"FINISHED"}
2019-02-26 01:05:46 +08:00
class session_add_property(bpy.types.Operator):
bl_idname = "session.add_prop"
bl_label = "add"
bl_description = "broadcast a property to connected clients"
2019-02-12 00:02:25 +08:00
bl_options = {"REGISTER"}
property_path: bpy.props.StringProperty(default="None")
2019-02-12 00:02:25 +08:00
@classmethod
def poll(cls, context):
return True
def execute(self, context):
global client
obj, attr = resolve_bpy_path(self.property_path)
if obj and attr:
key = self.property_path
value_type, value = from_bpy(attr)
2019-02-26 01:05:46 +08:00
client.push_update(key, value_type, value)
2019-02-12 00:02:25 +08:00
return {"FINISHED"}
2019-02-26 01:05:46 +08:00
class session_remove_property(bpy.types.Operator):
bl_idname = "session.remove_prop"
bl_label = "remove"
bl_description = "broadcast a property to connected clients"
bl_options = {"REGISTER"}
property_path: bpy.props.StringProperty(default="None")
@classmethod
def poll(cls, context):
return True
def execute(self, context):
global client
try:
del client.property_map[self.property_path]
return {"FINISHED"}
except:
return {"CANCELED"}
2019-02-26 01:05:46 +08:00
2019-02-12 00:31:03 +08:00
class session_create(bpy.types.Operator):
bl_idname = "session.create"
bl_label = "create"
bl_description = "create to a net session"
2019-02-11 22:48:07 +08:00
bl_options = {"REGISTER"}
@classmethod
def poll(cls, context):
return True
def execute(self, context):
global server
2019-02-12 00:02:25 +08:00
global client
2019-02-26 01:05:46 +08:00
2019-02-11 22:48:07 +08:00
server = net_components.Server()
2019-02-22 23:46:35 +08:00
time.sleep(0.1)
2019-02-12 00:02:25 +08:00
2019-02-22 23:46:35 +08:00
bpy.ops.session.join()
2019-02-26 01:05:46 +08:00
bpy.app.timers.register(observer)
2019-02-12 00:02:25 +08:00
return {"FINISHED"}
2019-02-12 00:31:03 +08:00
class session_stop(bpy.types.Operator):
bl_idname = "session.stop"
bl_label = "close"
bl_description = "stop net service"
2019-02-12 00:02:25 +08:00
bl_options = {"REGISTER"}
@classmethod
def poll(cls, context):
return True
def execute(self, context):
global server
global client
net_settings = context.scene.session_settings
bpy.app.timers.unregister(observer)
2019-03-14 00:02:53 +08:00
2019-02-26 01:05:46 +08:00
if server:
2019-02-12 00:02:25 +08:00
server.stop()
2019-02-12 00:49:28 +08:00
del server
server = None
2019-02-12 00:31:03 +08:00
if client:
client.stop()
2019-02-12 00:49:28 +08:00
del client
client = None
2019-02-12 00:02:25 +08:00
bpy.ops.asyncio.stop()
net_settings.is_running = False
2019-02-12 00:02:25 +08:00
else:
2019-02-14 22:30:35 +08:00
logger.debug("No server/client running.")
2019-02-11 22:48:07 +08:00
return {"FINISHED"}
2019-02-09 01:34:10 +08:00
2019-02-12 00:02:25 +08:00
2019-02-12 01:10:56 +08:00
class session_settings(bpy.types.PropertyGroup):
username = bpy.props.StringProperty(
name="Username", default="user_{}".format(randomStringDigits()))
2019-02-12 01:10:56 +08:00
ip = bpy.props.StringProperty(name="localhost")
port = bpy.props.IntProperty(name="5555")
buffer = bpy.props.StringProperty(name="None")
2019-02-26 01:05:46 +08:00
is_running = bpy.props.BoolProperty(name="is_running", default=False)
2019-03-14 00:02:53 +08:00
hide_users = bpy.props.BoolProperty(name="is_running", default=False)
hide_settings = bpy.props.BoolProperty(name="hide_settings", default=False)
hide_properties = bpy.props.BoolProperty(name="hide_properties", default=True)
2019-02-26 01:05:46 +08:00
update_frequency = bpy.props.FloatProperty(
name="update_frequency", default=0.008)
2019-03-14 01:35:59 +08:00
active_object = bpy.props.PointerProperty(name="active_object",type=bpy.types.Object)
2019-02-12 01:10:56 +08:00
2019-03-14 00:02:53 +08:00
class session_draw_clients(bpy.types.Operator):
bl_idname = "session.draw"
bl_label = "draw clients"
bl_description = "Description that shows in blender tooltips"
bl_options = {"REGISTER"}
2019-03-14 00:02:53 +08:00
position = bpy.props.FloatVectorProperty(default=(0, 0, 0))
def __init__(self):
super().__init__()
2019-03-14 00:02:53 +08:00
self.draw_items = []
self.draw3d_handle = None
self.draw2d_handle = None
2019-03-14 00:02:53 +08:00
self.draw_event = None
self.coords = None
2019-03-14 01:35:59 +08:00
self.active_object = None
@classmethod
def poll(cls, context):
return True
2019-03-14 00:02:53 +08:00
def invoke(self, context, event):
#
self.coords = get_client_view_rect()
self.create_batch()
self.register_handlers(context)
context.window_manager.modal_handler_add(self)
return {"RUNNING_MODAL"}
2019-03-14 00:02:53 +08:00
def register_handlers(self, context):
self.draw3d_handle = bpy.types.SpaceView3D.draw_handler_add(
self.draw3d_callback, (), 'WINDOW', 'POST_VIEW')
self.draw2d_handle = bpy.types.SpaceView3D.draw_handler_add(
self.draw2d_callback, (), 'WINDOW', 'POST_PIXEL')
2019-03-14 00:02:53 +08:00
self.draw_event = context.window_manager.event_timer_add(
2019-03-14 07:24:24 +08:00
0.01, window=context.window)
2019-03-14 00:02:53 +08:00
def unregister_handlers(self, context):
if self.draw_event and self.draw3d_handle and self.draw2d_handle:
context.window_manager.event_timer_remove(self.draw_event)
bpy.types.SpaceView3D.draw_handler_remove(
self.draw3d_handle, "WINDOW")
bpy.types.SpaceView3D.draw_handler_remove(
self.draw2d_handle, "WINDOW")
self.draw_items.clear()
self.draw3d_handle = None
self.draw2d_handle = None
self.draw_event = None
2019-03-14 07:24:24 +08:00
# TODO: refactor this ugly things
def create_batch(self):
global client
index = 0
2019-03-14 07:24:24 +08:00
index_object = 0
for key, values in client.property_map.items():
if values.body is not None:
if values.mtype == "object":
if values.id != client.id:
indices = (
(0, 1), (1, 2), (2, 3), (0, 3),
(4, 5), (5, 6), (6, 7), (4, 7),
(0, 4), (1, 5), (2, 6), (3, 7)
)
ob = bpy.data.objects[values.body]
bbox_corners = [ob.matrix_world @ mathutils.Vector(corner) for corner in ob.bound_box]
coords= [(point.x,point.y,point.z) for point in bbox_corners]
shader = gpu.shader.from_builtin('3D_UNIFORM_COLOR')
batch = batch_for_shader(
shader, 'LINES', {"pos": coords}, indices=indices)
self.draw_items.append(
(shader, batch, (None,None), COLOR_TABLE[index_object]))
index_object+=1
if values.mtype == "client":
if values.id != client.id:
indices = (
(1, 3), (2, 1), (3, 0), (2, 0)
)
shader = gpu.shader.from_builtin('3D_UNIFORM_COLOR')
batch = batch_for_shader(
shader, 'LINES', {"pos": values.body}, indices=indices)
self.draw_items.append(
(shader, batch, (values.body[1], values.id.decode()), COLOR_TABLE[index]))
index+=1
2019-03-14 07:24:24 +08:00
def draw3d_callback(self):
2019-03-14 00:02:53 +08:00
bgl.glLineWidth(3)
2019-03-14 00:02:53 +08:00
for shader, batch, font, color in self.draw_items:
shader.bind()
shader.uniform_float("color", color)
batch.draw(shader)
def draw2d_callback(self):
2019-03-14 00:02:53 +08:00
for shader, batch, font, color in self.draw_items:
2019-03-14 01:35:59 +08:00
try:
coords = get_client_2d(font[0])
2019-03-14 00:02:53 +08:00
2019-03-14 01:35:59 +08:00
blf.position(0, coords[0], coords[1]+10, 0)
blf.size(0, 10, 72)
blf.color(0, color[0], color[1], color[2], color[3])
blf.draw(0, font[1])
2019-03-14 00:02:53 +08:00
2019-03-14 01:35:59 +08:00
except:
pass
def is_object_selected(self,obj):
#TODO: function to find occurence
global client
for k,v in client.property_map.items():
if v.mtype == 'object':
if client.id != v.id:
if obj.name in v.body:
return True
return False
def modal(self, context, event):
if context.area:
context.area.tag_redraw()
2019-03-14 00:02:53 +08:00
if not context.scene.session_settings.is_running:
self.finish(context)
if event.type in {"TIMER"}:
global client
2019-03-14 01:35:59 +08:00
session = context.scene.session_settings
if client:
2019-03-14 07:24:24 +08:00
# Local view update
current_coords = get_client_view_rect()
2019-03-14 00:02:53 +08:00
if current_coords != self.coords:
self.coords = current_coords
key = "net/clients/{}".format(client.id.decode())
2019-03-14 01:35:59 +08:00
client.push_update(key, 'client', current_coords)
2019-03-14 01:35:59 +08:00
# Hide selected objects
for object in context.scene.objects:
if self.is_object_selected(object):
object.hide_select = True
else:
object.hide_select = False
2019-03-14 01:35:59 +08:00
# Active object bounding box
2019-03-14 07:24:24 +08:00
if len(context.selected_objects) > 0:
2019-03-14 07:24:24 +08:00
if session.active_object is not context.selected_objects[0] or session.active_object.is_evaluated :
2019-03-14 01:35:59 +08:00
session.active_object = context.selected_objects[0]
key = "net/objects/{}".format(client.id.decode())
2019-03-14 07:24:24 +08:00
client.push_update(key, 'object', session.active_object.name)
elif len(context.selected_objects) == 0 and session.active_object:
session.active_object = None
key = "net/objects/{}".format(client.id.decode())
client.push_update(key, 'object', None)
2019-03-14 00:02:53 +08:00
# Draw clients
if len(client.property_map) > 0:
self.unregister_handlers(context)
self.create_batch()
2019-03-14 00:02:53 +08:00
self.register_handlers(context)
2019-03-14 00:02:53 +08:00
return {"PASS_THROUGH"}
2019-03-14 00:02:53 +08:00
def finish(self, context):
self.unregister_handlers(context)
return {"FINISHED"}
2019-02-13 19:11:05 +08:00
# TODO: Rename to match official blender convention
classes = (
2019-02-12 00:31:03 +08:00
session_join,
session_add_property,
2019-02-12 00:31:03 +08:00
session_stop,
session_create,
2019-02-12 01:10:56 +08:00
session_settings,
session_remove_property,
session_draw_clients,
)
2019-02-09 01:34:10 +08:00
def register():
from bpy.utils import register_class
for cls in classes:
register_class(cls)
2019-02-26 01:05:46 +08:00
bpy.types.Scene.session_settings = bpy.props.PointerProperty(
type=session_settings)
2019-03-06 21:01:33 +08:00
# bpy.app.handlers.depsgraph_update_post.append(on_scene_evalutation)
2019-02-26 01:05:46 +08:00
def unregister():
global server
global client
if server:
server.stop()
del server
server = None
if client:
client.stop()
del client
client = None
2019-02-09 01:34:10 +08:00
from bpy.utils import unregister_class
for cls in reversed(classes):
unregister_class(cls)
2019-03-07 20:45:44 +08:00
# bpy.app.handlers.depsgraph_update_post.remove(on_scene_evalutation)
2019-02-12 01:10:56 +08:00
del bpy.types.Scene.session_settings
2019-02-09 01:34:10 +08:00
if __name__ == "__main__":
2019-02-09 01:34:10 +08:00
register()