dymokomi/luce-usd
Source of release 0.9.3
0.9.3 / src / usda / writer / properties.lucb
## Attributes and relationships (Sdf_WriteAttribute, Sdf_WriteRelationship
## and their helpers): the declaration line with the default value and the
## metadata section, then `.timeSamples`, `.spline`, `.connect` and list-edited
## connections; a relationship's explicit targets on its line, list-edited
## targets on their own lines.
extend Writer:
func write_attribute(spec: usize, indent: usize) -> !:
let attribute = self.layer.spec(spec)
let name = self.names.name_text(attribute.path)
let uniform = if_uniform(attribute.get(self.keys.variability))
var type_buffer: u8[80]
var type_text = ""
if let value = attribute.get(self.keys.type_name):
type_text = serialization_name(self.text(value.as_token()), type_buffer)
let custom = if_true(attribute.get(self.keys.custom))
var comment = ""
if let value = attribute.get(self.keys.comment): comment = self.text(value.as_token())
let default = attribute.get(self.keys.default)
let samples = attribute.get(self.keys.time_samples)
let spline = attribute.get(self.keys.spline)
let connections = attribute.get(self.keys.connection_paths)
var fields = Growing[u32]()
defer fields.close()
try self.metadata_fields(attribute, attribute_extra, &fields)
let info = comment.length > 0 or fields.count > 0
if info or default != none or custom or (connections == none and samples == none and spline == none):
try self.indent(indent)
if custom: try self.put("custom ")
if uniform: try self.put("uniform ")
try self.put(type_text)
try self.byte(' ')
try self.put(name)
if let value = default:
if value.kind == ValueKind.path:
# Sdf writes a path default after the indentation, not " = ".
try self.indent(indent)
try self.path_ref((u32)value.bits)
elif not value.is_empty():
try self.put(" = ")
try self.value(value)
if info:
try self.put(" (\n")
if comment.length > 0:
try self.indent(indent + 1)
try self.quoted(comment)
try self.put("\n")
for field in fields.view():
let value = attribute.get(field) else continue
if field == self.keys.documentation:
try self.indent(indent + 1)
try self.put("doc = ")
try self.quoted(self.text(value.as_token()))
try self.put("\n")
elif field == self.keys.permission:
try self.indent(indent + 1)
try self.put("permission = private\n" if value.bits == permission_private else "permission = public\n")
elif field == self.keys.symmetry_function:
try self.indent(indent + 1)
try self.put("symmetryFunction = ")
try self.token_text(value.as_token())
try self.put("\n")
elif self.text(field) == "displayUnit":
try self.indent(indent + 1)
try self.put("displayUnit = ")
try self.token_text(value.as_token())
try self.put("\n")
else:
try self.simple_field(indent + 1, field, value)
try self.indent(indent)
try self.put(")")
try self.put("\n")
if let value = samples:
try self.indent(indent)
if uniform: try self.put("uniform ")
try self.put(type_text)
try self.byte(' ')
try self.put(name)
try self.put(".timeSamples = {\n")
try self.time_samples(indent, value)
try self.indent(indent)
try self.put("}\n")
if let value = spline:
try self.indent(indent)
if uniform: try self.put("uniform ")
try self.put(type_text)
try self.byte(' ')
try self.put(name)
try self.put(".spline = {\n")
try self.spline_body(indent, value)
try self.indent(indent)
try self.put("}\n")
if let value = connections:
try self.connection_list(indent, value, uniform, type_text, name)
## `.connect` statements: explicit, or one per list op part.
func connection_list(indent: usize, value: const Value*, uniform: bool, type_text: str, name: str) -> !:
let list = value.list_op() else return
if list.explicit:
try self.connection_statement(indent, list.items(ListPart.explicit), "", uniform, type_text, name)
return
try self.connection_part(indent, list.items(ListPart.deleted), "delete ", uniform, type_text, name)
try self.connection_part(indent, list.items(ListPart.added), "add ", uniform, type_text, name)
try self.connection_part(indent, list.items(ListPart.prepended), "prepend ", uniform, type_text, name)
try self.connection_part(indent, list.items(ListPart.appended), "append ", uniform, type_text, name)
try self.connection_part(indent, list.items(ListPart.ordered), "reorder ", uniform, type_text, name)
func connection_part(indent: usize, items: const ListItem[], lead: str, uniform: bool, type_text: str, name: str) -> !:
if items.length == 0: return
try self.connection_statement(indent, items, lead, uniform, type_text, name)
func connection_statement(indent: usize, items: const ListItem[], lead: str, uniform: bool, type_text: str, name: str) -> !:
try self.indent(indent)
try self.put(lead)
if uniform: try self.put("uniform ")
try self.put(type_text)
try self.byte(' ')
try self.put(name)
try self.put(".connect = ")
if items.length == 0:
try self.put("None\n")
elif items.length == 1:
try self.path_ref((u32)items[0].a)
try self.put("\n")
else:
try self.put("[\n")
for item in items:
try self.indent(indent + 1)
try self.path_ref((u32)item.a)
try self.put(",\n")
try self.indent(indent)
try self.put("]\n")
func write_relationship(spec: usize, indent: usize) -> !:
let relationship = self.layer.spec(spec)
let name = self.names.name_text(relationship.path)
var comment = ""
if let value = relationship.get(self.keys.comment): comment = self.text(value.as_token())
let custom = if_true(relationship.get(self.keys.custom))
let varying = not if_uniform(relationship.get(self.keys.variability))
var fields = Growing[u32]()
defer fields.close()
try self.metadata_fields(relationship, no_extra, &fields)
let info = comment.length > 0 or fields.count > 0
var explicit_targets = false
var target_edits = false
var list: const ListOp*? = none
if let value = relationship.get(self.keys.target_paths):
if let targets = value.list_op():
list = targets
explicit_targets = targets.explicit
target_edits = not targets.explicit and has_items(targets)
if info or explicit_targets or (not target_edits and not custom):
try self.indent(indent)
if custom: try self.put("custom ")
if varying: try self.put("varying ")
try self.put("rel ")
try self.put(name)
if explicit_targets:
let targets = list else trap("targets")
let items = targets.items(ListPart.explicit)
if items.length == 0: try self.put(" = None")
else: try self.target_list(indent, items, false)
if info:
try self.put(" (\n")
if comment.length > 0:
try self.indent(indent + 1)
try self.quoted(comment)
try self.put("\n")
for field in fields.view():
let value = relationship.get(field) else continue
if field == self.keys.documentation:
try self.indent(indent + 1)
try self.put("doc = ")
try self.quoted(self.text(value.as_token()))
try self.put("\n")
elif field == self.keys.permission:
try self.indent(indent + 1)
try self.put("permission = private\n" if value.bits == permission_private else "permission = public\n")
elif field == self.keys.symmetry_function:
try self.indent(indent + 1)
try self.put("symmetryFunction = ")
try self.token_text(value.as_token())
try self.put("\n")
else:
try self.simple_field(indent + 1, field, value)
try self.indent(indent)
try self.put(")")
try self.put("\n")
elif custom:
try self.indent(indent)
try self.put("custom ")
if varying: try self.put("varying ")
try self.put("rel ")
try self.put(name)
try self.put("\n")
if target_edits:
let targets = list else trap("targets")
try self.target_part(indent, targets.items(ListPart.deleted), "delete ", varying, name)
try self.target_part(indent, targets.items(ListPart.added), "add ", varying, name)
try self.target_part(indent, targets.items(ListPart.prepended), "prepend ", varying, name)
try self.target_part(indent, targets.items(ListPart.appended), "append ", varying, name)
try self.target_part(indent, targets.items(ListPart.ordered), "reorder ", varying, name)
if let value = relationship.get(self.keys.default):
if value.kind == ValueKind.path:
try self.indent(indent)
if varying: try self.put("varying ")
try self.put("rel ")
try self.put(name)
try self.put(".default = ")
try self.path_ref((u32)value.bits)
# Sdf writes the line end after the indentation.
try self.indent(indent)
try self.put("\n")
func target_part(indent: usize, items: const ListItem[], lead: str, varying: bool, name: str) -> !:
if items.length == 0: return
try self.indent(indent)
try self.put(lead)
if varying: try self.put("varying ")
try self.put("rel ")
try self.put(name)
try self.target_list(indent, items, true)
## ` = <path>` or ` = [ ... ]`, with a line end when `newline`.
func target_list(indent: usize, items: const ListItem[], newline: bool) -> !:
if items.length > 1:
try self.put(" = [\n")
for item in items:
try self.indent(indent + 1)
try self.path_ref((u32)item.a)
try self.put(",\n")
try self.indent(indent)
try self.put("]")
else:
try self.put(" = ")
try self.path_ref((u32)items[0].a)
if newline: try self.put("\n")
func if_uniform(value: const Value*?) -> bool:
let found = value else return false
return found.bits == variability_uniform
func if_true(value: const Value*?) -> bool:
let found = value else return false
return found.bits != 0
func has_items(list: const ListOp*) -> bool:
for part: usize in 0..<6:
if list.parts[part].count > 0: return true
return false
## An attribute's metadata section also takes displayUnit.
func attribute_extra(keys: FieldKeys, name: u32) -> bool:
return name == keys.display_unit
func no_extra(keys: FieldKeys, name: u32) -> bool:
return false