Source code for cis_interface.metaschema.datatypes.ObjMetaschemaType
import os
import copy
import numpy as np
import warnings
from cis_interface import backwards
from cis_interface.metaschema.encoder import encode_json, decode_json
from cis_interface.metaschema.datatypes import register_type_from_file, _schema_dir
from cis_interface.metaschema.datatypes.JSONObjectMetaschemaType import (
JSONObjectMetaschemaType)
from cis_interface.metaschema.datatypes.PlyMetaschemaType import (
PlyDict,
_index_type, _color_type, _coord_type,
_index_conv, _color_conv, _coord_conv,
_index_fmt, _color_fmt, _coord_fmt)
_schema_file = os.path.join(_schema_dir, 'obj.json')
_default_element_order = ['material', 'vertices', 'params', 'normals', 'texcoords',
'points', 'lines', 'faces', 'curves', 'curve2Ds', 'surfaces']
# TODO: Unclear what standard puts colors after coords and how that is
# reconciled with the weight (i.e. do colors go before or after weight)
_default_property_order = {
'vertices': ['x', 'y', 'z', 'red', 'green', 'blue', 'w'],
'params': ['u', 'v', 'w'],
'normals': ['i', 'j', 'k'],
'texcoords': ['u', 'v', 'w'],
'points': 'vertex_indices',
'lines': ['vertex_index', 'texcoord_index'],
'faces': ['vertex_index', 'texcoord_index', 'normal_index'],
'curves': ['starting_param', 'ending_param', ['vertex_indices']],
'curve2Ds': 'param_indices',
'surfaces': ['starting_param_u', 'ending_param_u',
'starting_param_v', 'ending_param_v',
{'vertex_indices': ['vertex_index', 'texcoord_index', 'normal_index']}]}
_index_properties = ['vertex_indices', 'vertex_index', 'texcoord_index',
'normal_index', 'param_indices']
_default_property_formats = {}
_default_property_converters = {}
for k in ['x', 'y', 'z', 'u', 'v', 'w', 'i', 'j', 'k',
'starting_param', 'ending_param',
'starting_param_u', 'ending_param_u',
'starting_param_v', 'ending_param_v']:
_default_property_formats[k] = _coord_fmt
_default_property_converters[k] = _coord_conv
for k in ['red', 'green', 'blue']:
_default_property_formats[k] = _color_fmt
_default_property_converters[k] = _color_conv
for k in ['vertex_index', 'texcoord_index', 'normal_index', 'param_index',
'vertex_indices', 'param_indices']:
_default_property_formats[k] = _index_fmt
_default_property_converters[k] = _index_conv
_map_element2code = {'material': 'usemtl', 'vertices': 'v',
'params': 'vp', 'normals': 'vn', 'texcoords': 'vt',
'points': 'p', 'lines': 'l', 'faces': 'f',
'curves': 'curv', 'curve2Ds': 'curv2', 'surfaces': 'surf'}
_map_code2element = {v: k for k, v in _map_element2code.items()}
[docs]def create_schema(overwrite=False):
r"""Creates a file containing the Obj schema.
Args:
overwrite (bool, optional): If True and a file already exists, the
existing file will be replaced. If False, an error will be raised
if the file already exists.
"""
if (not overwrite) and os.path.isfile(_schema_file):
raise RuntimeError("Schema file already exists.")
schema = {
'title': 'obj',
'description': 'A mapping container for Obj 3D data.',
'type': 'object',
'required': ['vertices', 'faces'],
'definitions': {
'vertex': {
'description': 'Map describing a single vertex.',
'type': 'object', 'required': ['x', 'y', 'z'],
'additionalProperties': False,
'properties': {'x': {'type': _coord_type},
'y': {'type': _coord_type},
'z': {'type': _coord_type},
'red': {'type': _color_type},
'blue': {'type': _color_type},
'green': {'type': _color_type},
'w': {'type': _coord_type, 'default': 1.0}}},
'param': {
'description': 'Map describing a single parameter space point.',
'type': 'object', 'required': ['u', 'v'],
'additionalProperties': False,
'properties': {'u': {'type': _coord_type},
'v': {'type': _coord_type},
'w': {'type': _coord_type, 'default': 1.0}}},
'normal': {
'description': 'Map describing a single normal.',
'type': 'object', 'required': ['i', 'j', 'k'],
'additionalProperties': False,
'properties': {'i': {'type': _coord_type},
'j': {'type': _coord_type},
'k': {'type': _coord_type}}},
'texcoord': {
'description': 'Map describing a single texture vertex.',
'type': 'object', 'required': ['u'],
'additionalProperties': False,
'properties': {'u': {'type': _coord_type},
'v': {'type': _coord_type, 'default': 0.0},
'w': {'type': _coord_type, 'default': 0.0}}},
'point': {
'description': 'Array of vertex indices describing a set of points.',
'type': 'array', 'minItems': 1,
'items': {'type': _index_type}},
'line': {
'description': ('Array of vertex indices and texture indices '
+ 'describing a line.'),
'type': 'array', 'minItems': 2,
'items': {'type': 'object', 'required': ['vertex_index'],
'additionalProperties': False,
'properties':
{'vertex_index': {'type': _index_type},
'texcoord_index': {'type': _index_type}}}},
'face': {
'description': ('Array of vertex, texture, and normal indices '
+ 'describing a face.'),
'type': 'array', 'minItems': 3,
'items': {'type': 'object', 'required': ['vertex_index'],
'additionalProperties': False,
'properties':
{'vertex_index': {'type': _index_type},
'texcoord_index': {'type': _index_type},
'normal_index': {'type': _index_type}}}},
'curve': {
'description': 'Properties of describing a curve.',
'type': 'object', 'required': ['starting_param', 'ending_param',
'vertex_indices'],
'additionalProperties': False,
'properties': {
'starting_param': {'type': _coord_type},
'ending_param': {'type': _coord_type},
'vertex_indices': {
'type': 'array', 'minItems': 2,
'items': {'type': _index_type}}}},
'curve2D': {
'description': ('Array of parameter indices describine a 2D curve on '
+ 'a surface.'),
'type': 'array', 'minItems': 2,
'items': {'type': _index_type}},
'surface': {
'description': 'Properties describing a surface.',
'type': 'object', 'required': ['starting_param_u', 'ending_param_u',
'starting_param_v', 'ending_param_v',
'vertex_indices'],
'additionalProperties': False,
'properties': {
'starting_param_u': {'type': _coord_type},
'ending_param_u': {'type': _coord_type},
'starting_param_v': {'type': _coord_type},
'ending_param_v': {'type': _coord_type},
'vertex_indices': {
'type': 'array', 'minItems': 2,
'items': {'type': 'object', 'required': ['vertex_index'],
'additionalProperties': False,
'properties': {
'vertex_index': {'type': _index_type},
'texcoord_index': {'type': _index_type},
'normal_index': {'type': _index_type}}}}}}},
'properties': {
'material': {
'description': 'Name of the material to use.',
'type': ['unicode', 'string']},
'vertices': {
'description': 'Array of vertices.',
'type': 'array', 'items': {'$ref': '#/definitions/vertex'}},
'params': {
'description': 'Array of parameter coordinates.',
'type': 'array', 'items': {'$ref': '#/definitions/param'}},
'normals': {
'description': 'Array of normals.',
'type': 'array', 'items': {'$ref': '#/definitions/normal'}},
'texcoords': {
'description': 'Array of texture vertices.',
'type': 'array', 'items': {'$ref': '#/definitions/texcoord'}},
'points': {
'description': 'Array of points.',
'type': 'array', 'items': {'$ref': '#/definitions/point'}},
'lines': {
'description': 'Array of lines.',
'type': 'array', 'items': {'$ref': '#/definitions/line'}},
'faces': {
'description': 'Array of faces.',
'type': 'array', 'items': {'$ref': '#/definitions/face'}},
'curves': {
'description': 'Array of curves.',
'type': 'array', 'items': {'$ref': '#/definitions/curve'}},
'curve2Ds': {
'description': 'Array of curve2Ds.',
'type': 'array', 'items': {'$ref': '#/definitions/curve2D'}},
'surfaces': {
'description': 'Array of surfaces.',
'type': 'array', 'items': {'$ref': '#/definitions/surface'}}},
'dependencies': {
'lines': ['vertices'],
'faces': ['vertices'],
'curves': ['vertices'],
'curve2Ds': ['params'],
'surfaces': ['vertices']}}
with open(_schema_file, 'w') as fd:
encode_json(schema, fd, indent='\t')
[docs]def get_schema():
r"""Return the Obj schema, initializing it if necessary.
Returns:
dict: Obj schema.
"""
if not os.path.isfile(_schema_file):
create_schema()
with open(_schema_file, 'r') as fd:
out = decode_json(fd)
return out
if not os.path.isfile(_schema_file): # pragma: debug
create_schema()
[docs]class ObjDict(PlyDict):
r"""Enhanced dictionary class for storing Obj information."""
@property
def mesh(self):
r"""list: Vertices for each face in the structure."""
mesh = []
for i in range(self.count_elements('faces')):
imesh = []
for f in self['faces']:
for v in f:
imesh += [self['vertices'][v['vertex_index']][k]
for k in ['x', 'y', 'z']]
mesh.append(imesh)
return mesh
[docs] @classmethod
def from_shape(cls, shape, d, conversion=1.0): # pragma: lpy
r"""Create a ply dictionary from a PlantGL shape and descritizer.
Args:
scene (openalea.plantgl.scene): Scene that should be descritized.
d (openalea.plantgl.descritizer): Descritizer.
conversion (float, optional): Conversion factor that should be
applied to the vertex positions. Defaults to 1.0.
"""
iobj = super(ObjDict, cls).from_shape(shape, d, conversion=conversion,
_as_obj=True)
if iobj is not None:
# Texcoords
if d.result.texCoordList:
iobj.setdefault('texcoords', [])
for t in d.result.texCoordList:
# TODO: Should the coords be scaled?
iobj['texcoords'].append({'u': t.x, 'v': t.y})
if d.result.texCoordIndexList:
for i, t in enumerate(d.result.texCoordIndexList):
if t[0] < len(iobj['texcoords']):
for j in range(3):
iobj['faces'][i][j]['texcoord_index'] = t[j]
# Normals
if d.result.normalList:
iobj.setdefault('normals', [])
for n in d.result.normalList:
iobj['normals'].append({'i': n.x, 'j': n.y, 'k': n.z})
if d.result.normalIndexList:
for i, n in enumerate(d.result.normalIndexList):
if n[0] < len(iobj['normals']):
for j in range(3):
iobj['faces'][i][j]['normal_index'] = n[j]
return iobj
[docs] def to_geom_args(self, conversion=1.0, name=None): # pragma: lpy
r"""Get arguments for creating a PlantGL geometry.
Args:
conversion (float, optional): Conversion factor that should be
applied to the vertices. Defaults to 1.0.
name (str, optional): Name that should be given to the created
PlantGL symbol. Defaults to None and is ignored.
Returns:
tuple: Class, arguments and keyword arguments for PlantGL geometry.
"""
import openalea.plantgl.all as pgl
smb_class, args, kwargs = super(ObjDict, self).to_geom_args(
conversion=conversion, name=name, _as_obj=True)
index_class = pgl.Index
array_class = pgl.IndexArray
# Texture coords
if self.get('texcoords', []):
obj_texcoords = []
for t in self['texcoords']:
obj_texcoords.append(pgl.Vector2(np.float64(t['u']),
np.float64(t.get('v', 0.0))))
kwargs['texCoordList'] = pgl.Point2Array(obj_texcoords)
obj_ftexcoords = []
for i, f in enumerate(self['faces']):
entry = []
for _f in f:
if 'texcoord_index' not in _f:
if i > 0:
warnings.warn(("'texcoord_index' missing from face"
+ "%d, texcoord indices will be "
+ "ignored.") % i)
obj_ftexcoords = []
entry = []
break
entry.append(int(_f['texcoord_index']))
if not entry:
break
obj_ftexcoords.append(index_class(*entry))
if obj_ftexcoords:
kwargs['texCoordIndexList'] = array_class(obj_ftexcoords)
# Normals
if self.get('normals', []):
obj_normals = []
for n in self['normals']:
obj_normals.append(pgl.Vector3(np.float64(n['i']),
np.float64(n['j']),
np.float64(n['k'])))
kwargs['normalList'] = pgl.Point3Array(obj_normals)
obj_fnormals = []
for i, f in enumerate(self['faces']):
entry = []
for _f in f:
if 'normal_index' not in _f:
if i > 0:
warnings.warn(("'normal_index' missing from face"
+ "%d, normal indices will be "
+ "ignored.") % i)
obj_fnormals = []
entry = []
break
entry.append(int(_f['normal_index']))
if not entry:
break
obj_fnormals.append(index_class(*entry))
if obj_fnormals:
kwargs['normalIndexList'] = array_class(obj_fnormals)
return smb_class, args, kwargs
[docs] def append(self, solf):
r"""Append new ply information to this dictionary.
Args:
solf (ObjDict): Another ply to append to this one.
"""
exist_map = {'vertex_index': len(self.get('vertices', [])),
'texcoord_index': len(self.get('texcoords', [])),
'normal_index': len(self.get('normals', [])),
'param_index': len(self.get('params', []))}
exist_map.update(points=exist_map['vertex_index'],
curve2Ds=exist_map['param_index'])
# Vertex fields
for k in ['vertices', 'texcoords', 'normals', 'params']:
if k in solf:
if k not in self:
self[k] = []
self[k] += solf[k]
# Points/2D curves
for k in ['points', 'curve2Ds']:
if k in solf:
if k not in self:
self[k] = []
for x in solf[k]:
self[k].append([v + exist_map[k] for v in x])
# Face/line fields
for k in ['lines', 'faces']:
if k in solf:
if k not in self:
self[k] = []
for x in solf[k]:
iele = [{ik: v[ik] + exist_map[ik] for ik in v.keys()} for v in x]
self[k].append(iele)
# Curves
k = 'curves'
if k in solf:
if k not in self:
self[k] = []
for x in solf[k]:
iele = copy.deepcopy(x)
iele['vertex_indices'] = [v + exist_map['vertex_index']
for v in x['vertex_indices']]
# Surfaces
k = 'surfaces'
if k in solf:
if k not in self:
self[k] = []
for x in solf[k]:
iele = copy.deepcopy(x)
iele['vertex_indices'] = [{ik: v[ik] + exist_map[ik] for ik in v.keys()}
for v in x['vertex_indices']]
# Merge material using first in list
material = None
for x in [self, solf]:
if x.get('material', None) is not None:
material = x['material']
break
if material is not None:
self['material'] = material
return self
[docs] def apply_scalar_map(self, *args, **kwargs):
r"""Set the color of faces in a 3D object based on a scalar map.
This creates a copy unless no_copy is True.
Args:
scalar_arr (arr): Scalar values that should be mapped to colors
for each face.
color_map (str, optional): The name of the color map that should
be used. Defaults to 'plasma'.
vmin (float, optional): Value that should map to the minimum of the
colormap. Defaults to min(scalar_arr).
vmax (float, optional): Value that should map to the maximum of the
colormap. Defaults to max(scalar_arr).
scaling (str, optional): Scaling that should be used to map the scalar
array onto the colormap. Defaults to 'linear'.
scale_by_area (bool, optional): If True, the elements of the scalar
array will be multiplied by the area of the corresponding face.
If True, vmin and vmax should be in terms of the scaled array.
Defaults to False.
no_copy (bool, optional): If True, the returned object will not be a
copy. Defaults to False.
Returns:
dict: Obj with updated vertex colors.
"""
kwargs['_as_obj'] = True
return super(ObjDict, self).apply_scalar_map(*args, **kwargs)
# The base class could be anything since it is discarded during registration,
# but is set to JSONObjectMetaschemaType here for transparancy since this is
# what the base class is determined to be on loading the schema
[docs]@register_type_from_file(_schema_file)
class ObjMetaschemaType(JSONObjectMetaschemaType):
r"""Obj 3D structure map."""
_empty_msg = {'vertices': [], 'faces': []}
python_types = (dict, ObjDict)
@classmethod
def _encode_object_property(cls, obj, order, req_keys=False):
if req_keys:
sep = '/'
else:
sep = ' '
plist = []
if isinstance(obj, (list, tuple)):
for x in obj:
plist.append(cls._encode_object_property(x, order, req_keys=True))
return sep.join(plist)
elif isinstance(obj, dict):
for i, k in enumerate(order):
if isinstance(k, dict):
assert(len(k) == 1)
ksub = list(k.keys())[0]
if ksub in obj:
plist.append(cls._encode_object_property(obj[ksub], k[ksub]))
elif isinstance(k, (list, tuple)):
assert(len(k) == 1)
ksub = k[0]
if ksub in obj:
plist.append(cls._encode_object_property(obj[ksub], ksub))
else:
if k in obj:
plist.append(cls._encode_object_property(obj[k], k))
elif req_keys:
plist.append('')
return sep.join(plist)
else:
if order in _index_properties:
# Add one at write to indexes as .obj is not zero indexed
return _default_property_formats[order] % (obj + 1)
else:
return _default_property_formats[order] % obj
@classmethod
def _decode_object_property(cls, values, order):
if isinstance(values, (list, tuple)):
if not isinstance(order, (list, tuple)):
out = [cls._decode_object_property(v, order) for v in values]
elif (len(values) > 0) and ('/' in values[0]):
out = [cls._decode_object_property(v, order) for v in values]
else:
out = {}
for i, (o, v) in enumerate(zip(order, values)):
if not v:
continue
if isinstance(o, dict):
assert(len(o) == 1)
osub = list(o.keys())[0]
out[osub] = cls._decode_object_property(values[i:], o[osub])
break
elif isinstance(o, (list, tuple)):
assert(len(o) == 1)
osub = o[0]
out[osub] = cls._decode_object_property(values[i:], osub)
else:
out[o] = cls._decode_object_property(v, o)
else:
if not isinstance(order, (list, tuple)):
ftranslate = _default_property_converters[order]
out = ftranslate(values)
if order in _index_properties:
# Subtract 1 from indexes because .obj is not zero indexed
out -= 1
else:
assert('/' in values)
subvalues = values.split('/')
assert(len(order) == len(subvalues))
out = cls._decode_object_property(subvalues, order)
return out
[docs] @classmethod
def encode_data(cls, obj, typedef, comments=[], newline='\n'):
r"""Encode an object's data.
Args:
obj (object): Object to encode.
typedef (dict): Type definition that should be used to encode the
object.
comments (list, optional): List of comments that should be included in
the file header. Defaults to lines describing the automated origin
of the file.
newline (str, optional): String that should be used to delineated end
of lines. Defaults to '\n'.
Returns:
bytes, str: Serialized message.
"""
# Encode header
header = ['# Author cis_auto',
'# Generated by cis_interface']
header += ['# ' + c for c in comments]
header += ['']
# Encode body
body = []
for e in _default_element_order:
if (e not in obj):
continue
if (e == 'material'):
body.append('%s %s' % (_map_element2code[e], obj['material']))
continue
for ie in obj[e]:
ivalue = cls._encode_object_property(ie, _default_property_order[e])
iline = '%s %s' % (_map_element2code[e], ivalue)
body.append(iline.strip()) # Ensure trailing spaces are removed
return newline.join(header + body) + newline
[docs] @classmethod
def decode_data(cls, msg, typedef):
r"""Decode an object.
Args:
msg (string): Encoded object to decode.
typedef (dict): Type definition that should be used to decode the
object.
Returns:
object: Decoded object.
"""
lines = backwards.as_str(msg).splitlines()
metadata = {'comments': []}
out = {}
# Parse
for line_count, line in enumerate(lines):
if line.startswith('#'):
metadata['comments'].append(line)
continue
values = line.split()
if not values:
continue
if values[0] not in _map_code2element:
raise ValueError("Type code '%s' on line %d not understood"
% (values[0], line_count))
e = _map_code2element[values[0]]
if e not in out:
out[e] = []
if e in ['material']:
out[e] = values[1]
continue
else:
out[e].append(
cls._decode_object_property(values[1:], _default_property_order[e]))
# Return
# out.update(**metadata)
return ObjDict(out)
[docs] @classmethod
def updated_fixed_properties(cls, obj):
r"""Get a version of the fixed properties schema that includes information
from the object.
Args:
obj (object): Object to use to put constraints on the fixed properties
schema.
Returns:
dict: Fixed properties schema with object dependent constraints.
"""
out = super(ObjMetaschemaType, cls).updated_fixed_properties(obj)
# Constrain dependencies for indexes into other elements
depend_map = {'vertex_index': 'vertices', 'vertex_indices': 'vertices',
'texcoord_index': 'texcoords',
'normal_index': 'normals'}
check_depends = {'lines': ['texcoord_index'],
'faces': ['texcoord_index', 'normal_index'],
'surfaces:vertex_indices': ['texcoord_index', 'normal_index']}
for e, props in check_depends.items():
sube = None
if ':' in e:
e, sube = e.split(':')
if not ((e in obj) and isinstance(obj[e], (list, tuple))):
continue
req_flags = {k: False for k in props}
for o in obj[e]:
if sum(req_flags.values()) == len(props):
break
if isinstance(o, dict):
assert(sube)
if (((sube not in o) or (not isinstance(o[sube], (list, tuple)))
or (len(o[sube]) == 0) or (not isinstance(o[sube][0], dict)))):
continue
for p in props:
if p in o[sube][0]:
req_flags[p] = True
elif isinstance(o, (list, tuple)):
if (len(o) == 0) or (not isinstance(o[0], dict)):
continue
for p in props:
if p in o[0]:
req_flags[p] = True
# Set dependencies
for p in req_flags.keys():
if not req_flags[p]:
continue
if depend_map[p] not in out['dependencies'][e]:
out['dependencies'][e].append(depend_map[p])
# Contrain indices on number of elements refered to
if ('vertices' in obj) and isinstance(obj['vertices'], (list, tuple)):
out['definitions']['curve']['properties']['vertex_indices']['items'][
'maximum'] = len(obj['vertices']) - 1
if ('params' in obj) and isinstance(obj['params'], (list, tuple)):
out['definitions']['curve2D']['items']['maximum'] = len(obj['params']) - 1
for e in ['line', 'face', 'surface']:
if e == 'surface':
iprop = out['definitions'][e]['properties']['vertex_indices'][
'items']['properties']
else:
iprop = out['definitions'][e]['items']['properties']
for k, e_depends in depend_map.items():
if k in iprop:
if (e_depends in obj) and isinstance(obj[e_depends], (list, tuple)):
iprop[k]['maximum'] = len(obj[e_depends]) - 1
return out
ObjDict._type_class = ObjMetaschemaType