Compare commits

...

24 Commits

Author SHA1 Message Date
Claire Kuang b1adeb0881 Merge branch 'dev' into jonathon/colorizedmesh 2025-08-22 12:51:07 +01:00
Claire Kuang bd7a3c7c43 Merge pull request #1037 from specklesystems/claire/revit-snapping
feat(revit): adds snapping for mesh vertices and nurbs curves
2025-08-22 12:36:10 +01:00
Claire Kuang ea976309bc Merge branch 'dev' into claire/revit-snapping 2025-08-22 12:31:33 +01:00
Claire Kuang 1b5787274a Merge pull request #1010 from specklesystems/claire/cnx-2167-material-quantity-extraction-for-revit-railings
feat(revit): adds material quantities for railings
2025-08-22 12:31:17 +01:00
Björn 7e595deabc Merge branch 'dev' into claire/revit-snapping 2025-08-22 11:42:22 +02:00
Claire Kuang 66091b2b73 Merge branch 'dev' into claire/cnx-2167-material-quantity-extraction-for-revit-railings 2025-08-22 10:37:30 +01:00
Claire Kuang 4f8d8d4f07 Merge pull request #1036 from specklesystems/bjorn/cnx-2212-grasshopper-deconstruct-node-should-encapsulate-all-input
fix(grasshopper): handle multiple objects with different fields in deconstruct node
2025-08-22 09:57:20 +01:00
Björn cd6888868e fix: flickering, dynamic outputs and docstrings 2025-08-21 10:10:07 +02:00
Björn f2d4e64005 Merge remote-tracking branch 'origin/dev' into bjorn/cnx-2212-grasshopper-deconstruct-node-should-encapsulate-all-input 2025-08-21 08:54:14 +02:00
Björn Steinhagen a92b88f6d3 fix: replace list access with progressive field discovery in deconstruct component 2025-08-21 08:19:10 +02:00
dependabot[bot] abfdbdeffa chore(deps): bump actions/checkout from 4 to 5 (#1034)
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-08-20 22:24:20 +01:00
Claire Kuang efe66e7e98 Merge branch 'dev' into claire/cnx-2167-material-quantity-extraction-for-revit-railings 2025-08-20 16:28:47 +01:00
Claire Kuang c3fa1bb0dc Update LocalToGlobalToDirectShapeConverter.cs 2025-08-20 15:32:12 +01:00
Claire Kuang e487981e5b adds snapping for mesh, curve, and points 2025-08-20 15:06:44 +01:00
Björn 46e7d6e432 chore: re-add comments 2025-08-19 17:04:12 +02:00
Björn b9f4845fa7 feat: handle multiple inputs 2025-08-19 16:49:20 +02:00
Björn 36863efc5a refactor: update SolveInstance to collect multiple input objects 2025-08-19 16:01:41 +02:00
Björn a0ce883a3f feat: DeconstructSpeckleParam input to accept multiple objects 2025-08-19 15:48:25 +02:00
Jedd Morgan 876d5c1bfe fix(rhino-importer): Do not save to objects sqlite cache (#1033)
* First pass

* ifc importer to not save objects to sqlite
2025-08-18 15:50:03 +01:00
Jonathon Broughton c5ae589c31 Simplifies the addition of faces in various cases and ensures consistent material use. 2025-08-14 02:32:20 +01:00
Jonathon Broughton 8db0bda1c1 Introduces a new implementation for converting mesh data.
Enhances handling of non-planar geometry by triangulating quads and n-gons.
Implements more efficient material management and retrieval.
Cleans up redundant code and improves overall maintainability.
2025-08-14 00:19:21 +01:00
Claire Kuang 7f3b23e71e Merge branch 'dev' into claire/cnx-2167-material-quantity-extraction-for-revit-railings 2025-08-07 09:00:26 +01:00
Claire Kuang 9b0a6c3202 Merge branch 'dev' into claire/cnx-2167-material-quantity-extraction-for-revit-railings 2025-07-31 17:08:45 +01:00
Claire Kuang de662e4a2b adds material quantities for pipes 2025-07-30 21:00:17 +01:00
11 changed files with 792 additions and 276 deletions
+2 -2
View File
@@ -7,7 +7,7 @@ jobs:
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v5
with:
fetch-depth: 0
@@ -28,7 +28,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v5
with:
fetch-depth: 0
+2 -2
View File
@@ -16,7 +16,7 @@ jobs:
file_version: ${{ steps.set-version.outputs.file_version }}
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v5
with:
fetch-depth: 0
@@ -83,7 +83,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v5
with:
fetch-depth: 0
@@ -37,91 +37,173 @@ public class DeconstructSpeckleParam : GH_Component, IGH_VariableParameterCompon
protected override void SolveInstance(IGH_DataAccess da)
{
object data = new();
da.GetData(0, ref data);
List<OutputParamWrapper> outputParams = new();
switch (data)
// on first iteration, discover all fields from all objects to create stable output structure
if (da.Iteration == 0)
{
case SpeckleCollectionWrapperGoo collectionGoo when collectionGoo.Value != null:
// get children elements from the wrapper to override the elements prop while parsing
List<IGH_Goo> children = collectionGoo.Value.Elements.Select(o => ((SpeckleWrapper)o).CreateGoo()).ToList();
outputParams = ParseSpeckleWrapper(collectionGoo.Value, children);
break;
case SpeckleDataObjectWrapperGoo dataObjectGoo when dataObjectGoo.Value != null:
// get geometries from the wrapper to override the displayvalue prop while parsing
List<IGH_Goo> display = dataObjectGoo.Value.Geometries.Select(o => o.CreateGoo()).ToList();
outputParams = ParseSpeckleWrapper(dataObjectGoo.Value, null, display);
break;
case SpeckleGeometryWrapperGoo objectGoo when objectGoo.Value != null:
outputParams = ParseSpeckleWrapper(objectGoo.Value);
break;
case SpeckleBlockInstanceWrapperGoo blockInstanceGoo when blockInstanceGoo.Value != null:
outputParams = ParseSpeckleWrapper(blockInstanceGoo.Value);
break;
case SpeckleBlockDefinitionWrapperGoo blockDef:
outputParams = ParseSpeckleWrapper(blockDef.Value);
break;
case SpeckleMaterialWrapperGoo materialGoo when materialGoo.Value != null:
outputParams = ParseSpeckleWrapper(materialGoo.Value);
break;
HashSet<string> allFields = DiscoverAllFieldsFromInput();
case SpecklePropertyGroupGoo propGoo:
Name = $"properties ({propGoo.Value.Count})";
outputParams = new();
foreach (var key in propGoo.Value.Keys)
if (allFields.Count > 0)
{
var requiredOutputs = CreateOutputParamsFromFieldNames(allFields);
if (OutputMismatch(requiredOutputs))
{
ISpecklePropertyGoo value = propGoo.Value[key];
object? outputValue = value is SpecklePropertyGoo prop
? prop.Value
: value is SpecklePropertyGroupGoo propGroup
? propGroup
: value;
OutputParamWrapper output =
outputValue is IList
? CreateOutputParamByKeyValue(key, outputValue, GH_ParamAccess.list)
: CreateOutputParamByKeyValue(key, outputValue, GH_ParamAccess.item);
outputParams.Add(output);
OnPingDocument()?.ScheduleSolution(5, _ => CreateOutputs(requiredOutputs));
return;
}
break;
default:
AddRuntimeMessage(GH_RuntimeMessageLevel.Error, $"Type cannot be deconstructed: {data.GetType().Name}");
return;
}
}
// process current object normally
object data = new();
if (!da.GetData(0, ref data))
{
return;
}
var outputParams = DeconstructObject(data);
if (outputParams == null)
{
return;
}
// set component name based on the current object
NickName = Name;
if (da.Iteration == 0 && OutputMismatch(outputParams))
// set output data - fill missing fields with nulls for objects that don't have all fields
SetOutputData(da, outputParams);
}
/// <summary>
/// Discovers all unique field names from all input objects by looking at volatile data directly.
/// </summary>
private HashSet<string> DiscoverAllFieldsFromInput()
{
HashSet<string> allFields = new();
foreach (var item in Params.Input[0].VolatileData.AllData(true))
{
OnPingDocument()
.ScheduleSolution(
5,
_ =>
{
CreateOutputs(outputParams);
}
);
}
else
{
for (int i = 0; i < outputParams.Count; i++)
var objectOutputs = DeconstructObject(item);
if (objectOutputs != null)
{
var outParam = Params.Output[i];
var outParamWrapper = outputParams[i];
switch (outParam.Access)
foreach (var output in objectOutputs)
{
case GH_ParamAccess.item:
da.SetData(i, outParamWrapper.Value);
break;
case GH_ParamAccess.list:
da.SetDataList(i, outParamWrapper.Value as IList);
break;
allFields.Add(output.Param.Name);
}
}
}
return allFields;
}
/// <summary>
/// Creates output parameter wrappers from a set of field names, all with item access.
/// </summary>
private List<OutputParamWrapper> CreateOutputParamsFromFieldNames(HashSet<string> fieldNames) =>
fieldNames
.OrderBy(name => name)
.Select(fieldName => CreateOutputParamByKeyValue(fieldName, null, GH_ParamAccess.item))
.ToList();
/// <summary>
/// Deconstructs a single object into its constituent fields/properties.
/// </summary>
private List<OutputParamWrapper>? DeconstructObject(object data) =>
data switch
{
// get children elements from wrapper to override elements prop while parsing
SpeckleCollectionWrapperGoo collectionGoo when collectionGoo.Value != null
=> ParseSpeckleWrapper(
collectionGoo.Value,
collectionGoo.Value.Elements.Select(o => ((SpeckleWrapper)o).CreateGoo()).ToList()
),
// get geometries from wrapper to override displayValue prop while parsing
SpeckleDataObjectWrapperGoo dataObjectGoo when dataObjectGoo.Value != null
=> ParseSpeckleWrapper(
dataObjectGoo.Value,
null,
dataObjectGoo.Value.Geometries.Select(o => o.CreateGoo()).ToList()
),
SpeckleGeometryWrapperGoo objectGoo when objectGoo.Value != null => ParseSpeckleWrapper(objectGoo.Value),
SpeckleBlockInstanceWrapperGoo blockInstanceGoo when blockInstanceGoo.Value != null
=> ParseSpeckleWrapper(blockInstanceGoo.Value),
SpeckleBlockDefinitionWrapperGoo blockDef when blockDef.Value != null => ParseSpeckleWrapper(blockDef.Value),
SpeckleMaterialWrapperGoo materialGoo when materialGoo.Value != null => ParseSpeckleWrapper(materialGoo.Value),
SpecklePropertyGroupGoo propGoo when propGoo.Value != null => ParsePropertyGroup(propGoo),
_ => HandleUnsupportedType(data)
};
/// <summary>
/// Handles SpecklePropertyGroupGoo objects by extracting their key-value pairs.
/// </summary>
private List<OutputParamWrapper> ParsePropertyGroup(SpecklePropertyGroupGoo propGoo)
{
Name = $"properties ({propGoo.Value.Count})";
List<OutputParamWrapper> objectOutputs = new();
foreach (var key in propGoo.Value.Keys)
{
ISpecklePropertyGoo value = propGoo.Value[key];
object? outputValue = value switch
{
SpecklePropertyGoo prop => prop.Value,
SpecklePropertyGroupGoo propGroup => propGroup,
_ => value
};
objectOutputs.Add(CreateOutputParamByKeyValue(key, outputValue, GH_ParamAccess.item));
}
return objectOutputs;
}
/// <summary>
/// Handles unsupported object types by logging an error and returning null.
/// </summary>
private List<OutputParamWrapper>? HandleUnsupportedType(object data)
{
AddRuntimeMessage(GH_RuntimeMessageLevel.Error, $"Type cannot be deconstructed: {data.GetType().Name}");
return null;
}
/// <summary>
/// Sets output data for the current iteration, filling missing fields with null values.
/// Uses a lookup dictionary for efficient field matching.
/// </summary>
private void SetOutputData(IGH_DataAccess da, List<OutputParamWrapper> currentOutputs)
{
if (Params.Output.Count == 0)
{
return;
}
// create a lookup for current outputs by field name
var outputLookup = currentOutputs.ToDictionary(o => o.Param.Name, o => o.Value);
// set data for each output parameter
for (int i = 0; i < Params.Output.Count; i++)
{
var outputParam = Params.Output[i];
// set the value if it exists, otherwise set null
object? value = outputLookup.TryGetValue(outputParam.Name, out var fieldValue) ? fieldValue : null;
switch (outputParam.Access)
{
case GH_ParamAccess.item:
da.SetData(i, value);
break;
case GH_ParamAccess.list:
da.SetDataList(i, value as IList ?? new List<object?>());
break;
}
}
}
private List<OutputParamWrapper> ParseSpeckleWrapper(
@@ -146,125 +228,146 @@ public class DeconstructSpeckleParam : GH_Component, IGH_VariableParameterCompon
return result;
}
// cycle through base props
// process each property of the Base object
foreach (var prop in @base.GetMembers(DynamicBaseMemberType.Instance | DynamicBaseMemberType.Dynamic))
{
// Convert and add to corresponding output structure
var value = prop.Value;
switch (value)
// skip internal dynamic property keys
if (prop.Key == nameof(Base.DynamicPropertyKeys))
{
case null:
result.Add(CreateOutputParamByKeyValue(prop.Key, null, GH_ParamAccess.item));
break;
continue;
}
case IList list:
List<object> nativeObjects = new();
// override list value if base is a collection and this is the elements prop, since this is empty if coming from a collectionwrapper
if (@base is Collection && prop.Key == "elements" && elements != null)
{
list = elements;
}
// override list value if base is a dataobject and this is the displayvalue prop, since this is empty if coming from a dataobject wrapper
if (@base is Speckle.Objects.Data.DataObject && prop.Key == "displayValue" && displayValue != null)
{
list = displayValue;
}
foreach (var x in list)
{
switch (x)
{
case SpeckleWrapper wrapper:
nativeObjects.Add(wrapper.CreateGoo());
break;
case Base xBase:
nativeObjects.AddRange(ConvertOrCreateWrapper(xBase));
break;
default:
nativeObjects.Add(x);
break;
}
}
result.Add(CreateOutputParamByKeyValue(prop.Key, nativeObjects, GH_ParamAccess.list));
break;
case Dictionary<string, object?> dict: // this should be treated a properties dict
SpecklePropertyGroupGoo propertyGoo = new();
propertyGoo.CastFrom(dict);
result.Add(CreateOutputParamByKeyValue(prop.Key, propertyGoo, GH_ParamAccess.item));
break;
case SpeckleWrapper wrapper:
result.Add(CreateOutputParamByKeyValue(prop.Key, wrapper.CreateGoo(), GH_ParamAccess.item));
break;
case Base baseValue:
result.Add(CreateOutputParamByKeyValue(prop.Key, ConvertOrCreateWrapper(baseValue), GH_ParamAccess.list));
break;
default:
// we don't want to output dynamic property keys
if (prop.Key == nameof(Base.DynamicPropertyKeys))
{
continue;
}
result.Add(CreateOutputParamByKeyValue(prop.Key, prop.Value, GH_ParamAccess.item));
break;
var outputParam = CreateOutputParamForProperty(prop, @base, elements, displayValue);
if (outputParam != null)
{
result.Add(outputParam);
}
}
return result;
}
/// <summary>
/// Creates an output parameter for a single property, handling different value types appropriately.
/// </summary>
private OutputParamWrapper CreateOutputParamForProperty(
KeyValuePair<string, object?> prop,
Base @base,
List<IGH_Goo>? elements,
List<IGH_Goo>? displayValue
) =>
prop.Value switch
{
null => CreateOutputParamByKeyValue(prop.Key, null, GH_ParamAccess.item),
IList list => CreateListOutputParam(prop.Key, list, @base, elements, displayValue),
Dictionary<string, object?> dict => CreateDictionaryOutputParam(prop.Key, dict),
SpeckleWrapper wrapper => CreateOutputParamByKeyValue(prop.Key, wrapper.CreateGoo(), GH_ParamAccess.item),
Base baseValue => CreateOutputParamByKeyValue(prop.Key, ConvertOrCreateWrapper(baseValue), GH_ParamAccess.list),
_ => CreateOutputParamByKeyValue(prop.Key, prop.Value, GH_ParamAccess.item)
};
/// <summary>
/// Creates an output parameter for list properties, with special handling for collection elements and display values.
/// </summary>
private OutputParamWrapper CreateListOutputParam(
string key,
IList list,
Base @base,
List<IGH_Goo>? elements,
List<IGH_Goo>? displayValue
)
{
// override list value for special cases
IList actualList = key switch
{
"elements" when @base is Collection && elements != null => elements,
"displayValue" when @base is Speckle.Objects.Data.DataObject && displayValue != null => displayValue,
_ => list
};
List<object> nativeObjects = new();
foreach (var item in actualList)
{
switch (item)
{
case SpeckleWrapper wrapper:
nativeObjects.Add(wrapper.CreateGoo());
break;
case Base baseItem:
nativeObjects.AddRange(ConvertOrCreateWrapper(baseItem));
break;
default:
nativeObjects.Add(item);
break;
}
}
return CreateOutputParamByKeyValue(key, nativeObjects, GH_ParamAccess.list);
}
/// <summary>
/// Creates an output parameter for dictionary properties, converting them to SpecklePropertyGroupGoo.
/// </summary>
private OutputParamWrapper CreateDictionaryOutputParam(string key, Dictionary<string, object?> dict)
{
SpecklePropertyGroupGoo propertyGoo = new();
propertyGoo.CastFrom(dict);
return CreateOutputParamByKeyValue(key, propertyGoo, GH_ParamAccess.item);
}
/// <summary>
/// Converts a Speckle Base object to host geometry or creates a wrapper if conversion fails.
/// Returns a list of SpeckleGeometryWrapperGoo objects.
/// </summary>
private List<SpeckleGeometryWrapperGoo> ConvertOrCreateWrapper(Base @base)
{
try
{
// convert the base and create a wrapper for each result
// attempt conversion to host geometry
List<(object, Base)> convertedBase = SpeckleConversionContext.Current.ConvertToHost(@base);
List<SpeckleGeometryWrapperGoo> convertedWrappers = new();
foreach ((object o, Base b) in convertedBase)
{
GeometryBase? g = o as GeometryBase;
SpeckleGeometryWrapper convertedWrapper =
new()
{
Base = b,
GeometryBase = g,
Name = b["name"] as string ?? "",
Color = null,
Material = null
};
convertedWrappers.Add(new(convertedWrapper));
}
return convertedWrappers;
return convertedBase.Select(CreateGeometryWrapper).ToList();
}
catch (ConversionException)
{
// some classes, like RawEncoding, have no direct conversion or fallback value.
// when this is the case, wrap it to allow users to further expand the object.
SpeckleGeometryWrapper convertedWrapper =
new()
{
Base = @base,
GeometryBase = null,
Name = @base[Constants.NAME_PROP] as string ?? "",
Color = null,
Material = null
};
return new() { new SpeckleGeometryWrapperGoo(convertedWrapper) };
// fallback: create wrapper without conversion for objects that can't be converted
return new List<SpeckleGeometryWrapperGoo> { CreateFallbackWrapper(@base) };
}
}
/// <summary>
/// Creates a SpeckleGeometryWrapperGoo from a converted geometry and base object pair.
/// </summary>
private SpeckleGeometryWrapperGoo CreateGeometryWrapper((object geometry, Base @base) converted)
{
SpeckleGeometryWrapper wrapper =
new()
{
Base = converted.@base,
GeometryBase = converted.geometry as GeometryBase,
Name = converted.@base["name"] as string ?? "",
Color = null,
Material = null
};
return new SpeckleGeometryWrapperGoo(wrapper);
}
/// <summary>
/// Creates a fallback wrapper for Base objects that cannot be converted to host geometry.
/// </summary>
private SpeckleGeometryWrapperGoo CreateFallbackWrapper(Base @base)
{
SpeckleGeometryWrapper wrapper =
new()
{
Base = @base,
GeometryBase = null,
Name = @base[Constants.NAME_PROP] as string ?? "",
Color = null,
Material = null
};
return new SpeckleGeometryWrapperGoo(wrapper);
}
private OutputParamWrapper CreateOutputParamByKeyValue(string key, object? value, GH_ParamAccess access)
{
Param_GenericObject param =
@@ -297,19 +400,17 @@ public class DeconstructSpeckleParam : GH_Component, IGH_VariableParameterCompon
return myParam;
}
public bool DestroyParameter(GH_ParameterSide side, int index)
{
return side == GH_ParameterSide.Output;
}
public bool DestroyParameter(GH_ParameterSide side, int index) => side == GH_ParameterSide.Output;
private void CreateOutputs(List<OutputParamWrapper> outputParams)
{
// TODO: better, nicer handling of creation/removal
// remove all existing output parameters
while (Params.Output.Count > 0)
{
Params.UnregisterOutputParameter(Params.Output[^1]);
}
// add new output parameters
foreach (var newParam in outputParams)
{
var param = new Param_GenericObject
@@ -322,11 +423,15 @@ public class DeconstructSpeckleParam : GH_Component, IGH_VariableParameterCompon
Params.RegisterOutputParam(param);
}
// notify Grasshopper of parameter changes
Params.OnParametersChanged();
VariableParameterMaintenance();
ExpireSolution(false);
}
/// <summary>
/// Determines if the current output parameter structure differs from the required structure.
/// </summary>
private bool OutputMismatch(List<OutputParamWrapper> outputParams)
{
if (Params.Output.Count != outputParams.Count)
@@ -334,10 +439,10 @@ public class DeconstructSpeckleParam : GH_Component, IGH_VariableParameterCompon
return true;
}
var count = 0;
foreach (var newParam in outputParams)
for (int i = 0; i < outputParams.Count; i++)
{
var oldParam = Params.Output[count];
var newParam = outputParams[i];
var oldParam = Params.Output[i];
if (
oldParam.NickName != newParam.Param.NickName
|| oldParam.Name != newParam.Param.Name
@@ -346,7 +451,6 @@ public class DeconstructSpeckleParam : GH_Component, IGH_VariableParameterCompon
{
return true;
}
count++;
}
return false;
@@ -1,95 +1,188 @@
using System.Diagnostics.CodeAnalysis;
using Autodesk.Revit.DB;
using Speckle.Converters.Common;
using Speckle.Converters.Common.Objects;
using Speckle.Converters.RevitShared.Helpers;
using Speckle.Converters.RevitShared.Services;
using Speckle.Converters.RevitShared.Settings;
using Speckle.DoubleNumerics;
using Speckle.Sdk.Common;
using Speckle.Sdk.Common.Exceptions;
namespace Speckle.Converters.RevitShared.ToHost.TopLevel;
public class MeshConverterToHost : ITypedConverter<SOG.Mesh, List<DB.GeometryObject>>
public class MeshConverterToHost : ITypedConverter<SOG.Mesh, List<GeometryObject>>
{
private readonly RevitToHostCacheSingleton _revitToHostCacheSingleton;
private readonly ScalingServiceToHost _scalingServiceToHost;
private readonly IReferencePointConverter _referencePointConverter;
private readonly IConverterSettingsStore<RevitConversionSettings> _converterSettings;
private const double PLANAR_TOLERANCE = 1e-9; // tune if needed, added to avoid numeric noise
private const bool ALLOW_VERTEX_COLOR_OVERRIDE = true; // flip to true if colors should win
private Document? _lastDoc; // if this converter instance is used across open documents, we'll want to invalidate the material cache
public MeshConverterToHost(
RevitToHostCacheSingleton revitToHostCacheSingleton,
ScalingServiceToHost scalingServiceToHost,
IReferencePointConverter referencePointConverter
IReferencePointConverter referencePointConverter,
IConverterSettingsStore<RevitConversionSettings> converterSettings
)
{
_revitToHostCacheSingleton = revitToHostCacheSingleton;
_scalingServiceToHost = scalingServiceToHost;
_referencePointConverter = referencePointConverter;
_converterSettings = converterSettings;
}
public List<DB.GeometryObject> Convert(SOG.Mesh mesh)
public List<GeometryObject> Convert(SOG.Mesh mesh)
{
TessellatedShapeBuilderTarget target = TessellatedShapeBuilderTarget.Mesh;
TessellatedShapeBuilderFallback fallback = TessellatedShapeBuilderFallback.Salvage;
const TessellatedShapeBuilderTarget TARGET = TessellatedShapeBuilderTarget.Mesh;
const TessellatedShapeBuilderFallback FALLBACK = TessellatedShapeBuilderFallback.Salvage;
using var tsb = new TessellatedShapeBuilder()
{
Fallback = fallback,
Target = target,
GraphicsStyleId = ElementId.InvalidElementId
};
using var tsb = new TessellatedShapeBuilder();
tsb.Fallback = FALLBACK;
tsb.Target = TARGET;
tsb.GraphicsStyleId = ElementId.InvalidElementId;
// tsb.OpenConnectedFaceSet(false);
tsb.OpenConnectedFaceSet(false);
var vertices = ArrayToPoints(mesh.vertices, mesh.units);
var vertColors = DecodeVertexColors(mesh.colors);
ElementId materialId = ElementId.InvalidElementId;
// optional default material from cache
ElementId defaultMat = ElementId.InvalidElementId;
if (
_revitToHostCacheSingleton.MaterialsByObjectId.TryGetValue(
mesh.applicationId ?? mesh.id.NotNull(),
out var mappedElementId
out var mapped
)
)
{
materialId = mappedElementId;
defaultMat = mapped;
}
bool hasExplicitMat = defaultMat != ElementId.InvalidElementId;
var facesByMat = new Dictionary<ElementId, List<IList<XYZ>>>();
int i = 0;
while (i < mesh.faces.Count)
{
int n = mesh.faces[i];
if (n < 3)
int faceVertexCount = mesh.faces[i];
if (faceVertexCount < 3)
{
n += 3; // 0 -> 3, 1 -> 4 to preserve backwards compatibility
faceVertexCount += 3;
}
var points = mesh.faces.GetRange(i + 1, n).Select(x => vertices[x]).ToArray();
if (IsNonPlanarQuad(points))
var faceIdx = mesh.faces.GetRange(i + 1, faceVertexCount);
var points = new XYZ[faceVertexCount];
for (int k = 0; k < faceVertexCount; k++)
{
// Non-planar quads will be triangulated as it's more desirable than `TessellatedShapeBuilder.Build`'s attempt to make them planar.
// TODO consider triangulating all n > 3 polygons that are non-planar
var triPoints = new List<XYZ> { points[0], points[1], points[3] };
var face1 = new TessellatedFace(triPoints, materialId);
tsb.AddFace(face1);
triPoints = new List<XYZ> { points[1], points[2], points[3] };
var face2 = new TessellatedFace(triPoints, materialId);
tsb.AddFace(face2);
}
else
{
var face = new TessellatedFace(points, materialId);
tsb.AddFace(face);
points[k] = vertices[faceIdx[k]];
}
i += n + 1;
var faceMaterial = FaceMat(faceIdx);
switch (faceVertexCount)
{
case 4 when IsNonPlanarQuad(points):
{
// Non-planar quads will be triangulated as it's more desirable than
// TessellatedShapeBuilder.Build's attempt to make them planar.
AddFace([points[0], points[1], points[3]], faceMaterial);
AddFace([points[1], points[2], points[3]], faceMaterial);
break;
}
case > 4 when !IsPlanarNgon(points):
{
for (int k = 1; k < faceVertexCount - 1; k++)
{
AddFace([points[0], points[k], points[k + 1]], faceMaterial);
}
break;
}
default:
{
AddFace(points, faceMaterial);
break;
}
}
i += faceVertexCount + 1;
}
tsb.CloseConnectedFaceSet();
var all = new List<GeometryObject>();
tsb.Build();
var result = tsb.GetBuildResult();
foreach (var kv in facesByMat)
{
using var perMat = new TessellatedShapeBuilder();
perMat.Fallback = FALLBACK;
perMat.Target = TARGET;
perMat.GraphicsStyleId = ElementId.InvalidElementId;
return result.GetGeometricalObjects().ToList();
perMat.OpenConnectedFaceSet(true);
foreach (var tf in kv.Value.Select(pts => new TessellatedFace(pts, kv.Key)).Where(tf => tf.IsValidObject))
{
perMat.AddFace(tf);
}
perMat.CloseConnectedFaceSet();
perMat.Build();
all.AddRange(perMat.GetBuildResult().GetGeometricalObjects());
}
return all;
void AddFace(IList<XYZ> pts, ElementId mat)
{
if (!facesByMat.TryGetValue(mat, out var list))
{
facesByMat[mat] = list = [];
}
list.Add(pts);
}
// local helper to pick a face material from vertex colors
[SuppressMessage("ReSharper", "RedundantLogicalConditionalExpressionOperand")]
ElementId FaceMat(IList<int> idx)
{
int vCount = vertColors.Length;
var hasColors = vCount > 0;
if (!hasColors || hasExplicitMat && !ALLOW_VERTEX_COLOR_OVERRIDE)
{
return defaultMat;
}
int sr = 0,
sg = 0,
sb = 0,
c = 0;
foreach (var v in idx)
{
if ((uint)v >= (uint)vCount)
{
continue;
}
var vc = vertColors[v];
sr += vc.Red;
sg += vc.Green;
sb += vc.Blue;
c++;
}
if (c == 0)
{
return defaultMat;
}
byte r = Quant((byte)(sr / c));
byte g = Quant((byte)(sg / c));
byte b = Quant((byte)(sb / c));
return GetOrCreateMaterial(_converterSettings.Current.Document, r, g, b);
}
}
private static bool IsNonPlanarQuad(IList<XYZ> points)
@@ -117,7 +210,59 @@ public class MeshConverterToHost : ITypedConverter<SOG.Mesh, List<DB.GeometryObj
1,
1
);
return matrix.GetDeterminant() != 0;
return Math.Abs(matrix.GetDeterminant()) > PLANAR_TOLERANCE;
}
private static bool IsPlanarNgon(IList<XYZ> vertices)
{
int n = vertices.Count;
if (n < 4)
{
return true; // 3 points always define a plane
}
// Newells method for robust best-fit plane =>
// https://www.realtimerendering.com/resources/GraphicsGems/gemsiii/newell.c
double normalX = 0,
normalY = 0,
normalZ = 0;
for (int i = 0, j = n - 1; i < n; j = i, i++)
{
var u = vertices[i];
var v = vertices[j];
normalX += (v.Y - u.Y) * (v.Z + u.Z);
normalY += (v.Z - u.Z) * (v.X + u.X);
normalZ += (v.X - u.X) * (v.Y + u.Y);
}
var length = Math.Sqrt(normalX * normalX + normalY * normalY + normalZ * normalZ);
if (length < 1e-12)
{
return true; // degenerate polygon; treat as planar
}
normalX /= length;
normalY /= length;
normalZ /= length;
var pointOnPlane = vertices[0];
double normalisedPlane = -(normalX * pointOnPlane.X + normalY * pointOnPlane.Y + normalZ * pointOnPlane.Z);
// max signed distance of all vertices to plane
double maxSignedDistance = 0;
for (int i = 1; i < n; i++)
{
var p = vertices[i];
double distance = normalX * p.X + normalY * p.Y + normalZ * p.Z + normalisedPlane;
maxSignedDistance = Math.Max(maxSignedDistance, Math.Abs(distance));
if (maxSignedDistance > PLANAR_TOLERANCE)
{
return false;
}
}
return true;
}
private XYZ[] ArrayToPoints(IList<double> arr, string units)
@@ -128,7 +273,7 @@ public class MeshConverterToHost : ITypedConverter<SOG.Mesh, List<DB.GeometryObj
}
XYZ[] points = new XYZ[arr.Count / 3];
var fTypeId = _scalingServiceToHost.UnitsToNative(units) ?? UnitTypeId.Meters;
var fTypeId = _scalingServiceToHost.UnitsToNative(units);
for (int i = 2, k = 0; i < arr.Count; i += 3)
{
@@ -146,4 +291,89 @@ public class MeshConverterToHost : ITypedConverter<SOG.Mesh, List<DB.GeometryObj
return points;
}
private readonly Dictionary<int, ElementId> _matCache = new();
private static Color[] DecodeVertexColors(IList<int>? argb)
{
if (argb == null)
{
return [];
}
var outArr = new Color[argb.Count];
for (int i = 0; i < argb.Count; i++)
{
uint v = unchecked((uint)argb[i]); // Speckle stores ARGB in a signed int
byte r = (byte)((v >> 16) & 0xFF);
byte g = (byte)((v >> 8) & 0xFF);
byte b = (byte)(v & 0xFF);
outArr[i] = new Color(r, g, b);
}
return outArr;
}
private static byte Quant(byte v, int step = 17)
{
int q = (int)Math.Round(v / (double)step) * step;
return (byte)Math.Max(0, Math.Min(255, q));
}
private ElementId GetOrCreateMaterial(Document doc, byte r, byte g, byte b)
{
if (!ReferenceEquals(doc, _lastDoc)) // essentially a document change check hack
{
_matCache.Clear();
_lastDoc = doc;
}
int key = (r << 16) | (g << 8) | b;
if (_matCache.TryGetValue(key, out var id))
{
return id;
}
string name = $"Speckle_DS_{r}_{g}_{b}";
Material? existing;
using (var filteredElementCollector = new FilteredElementCollector(doc))
{
filteredElementCollector.OfClass(typeof(Material)); // add the filter on the same instance
existing = filteredElementCollector
.Cast<Material>() // enumerate inside the using
.FirstOrDefault(m => string.Equals(m.Name, name, StringComparison.OrdinalIgnoreCase));
}
if (existing != null)
{
return _matCache[key] = existing.Id;
}
ElementId mid;
if (doc.IsModifiable)
{
using var st = new SubTransaction(doc);
st.Start();
mid = CreateMaterialWithColor(doc, name, r, g, b);
st.Commit();
}
else
{
using var t = new Transaction(doc, "Create DS Material");
t.Start();
mid = CreateMaterialWithColor(doc, name, r, g, b);
t.Commit();
}
return _matCache[key] = mid;
static ElementId CreateMaterialWithColor(Document doc, string name, byte r, byte g, byte b)
{
var materialId = Material.Create(doc, name);
((Material)doc.GetElement(materialId)).Color = new Color(r, g, b);
return materialId;
}
}
}
@@ -78,6 +78,24 @@ public class LocalToGlobalToDirectShapeConverter
.DirectShapeLibrary.GetDirectShapeLibrary(_converterSettings.Current.Document)
.FindDefinition(target.atomicObject.applicationId ?? target.atomicObject.id.NotNull());
result.SetShape(def);
// add snapping references for meshes and curves
foreach (var shape in def)
{
switch (shape)
{
case DB.Mesh m:
foreach (var v in m.Vertices)
{
result.AddReferencePoint(v);
}
break;
case DB.Curve c:
result.AddReferenceCurve(c);
break;
}
}
return result; // note fast exit here
}
@@ -44,9 +44,27 @@ public class MaterialQuantitiesToSpeckleLite : ITypedConverter<DB.Element, Dicti
public Dictionary<string, object> Convert(DB.Element target)
{
Dictionary<string, object> quantities = new();
if (target.Category?.HasMaterialQuantities ?? false) //category can be null
switch (target)
{
foreach (DB.ElementId? matId in target.GetMaterialIds(false))
case DBA.Railing railing:
// railings can have subelements including top rails, hand rails, and balusters.
// they also do *not* have any materials associated with their category.
List<DB.ElementId> railingElementIds = [railing.GetTypeId(), railing.TopRail, .. railing.GetHandRails()];
ProcessMaterialsByElementTypes(railingElementIds, quantities);
break;
default:
ProcessMaterialsByCategory(target, quantities);
break;
}
return quantities;
}
private void ProcessMaterialsByCategory(DB.Element element, Dictionary<string, object> quantities)
{
if (element.Category?.HasMaterialQuantities ?? false) //category can be null
{
foreach (DB.ElementId? matId in element.GetMaterialIds(false))
{
if (matId is null)
{
@@ -56,11 +74,18 @@ public class MaterialQuantitiesToSpeckleLite : ITypedConverter<DB.Element, Dicti
var materialQuantity = new Dictionary<string, object>();
var unitSettings = _converterSettings.Current.Document.GetUnits();
// add material props
if (TryAddMaterialPropertiesToQuantitiesDict(matId, materialQuantity, out string matName))
{
quantities[matName] = materialQuantity;
}
// add area and volume props
var areaUnitType = unitSettings.GetFormatOptions(DB.SpecTypeId.Area).GetUnitTypeId();
AddMaterialProperty(
materialQuantity,
"area",
_scalingService.Scale(target.GetMaterialArea(matId, false), areaUnitType),
_scalingService.Scale(element.GetMaterialArea(matId, false), areaUnitType),
areaUnitType
);
@@ -68,57 +93,142 @@ public class MaterialQuantitiesToSpeckleLite : ITypedConverter<DB.Element, Dicti
AddMaterialProperty(
materialQuantity,
"volume",
_scalingService.Scale(target.GetMaterialVolume(matId), volumeUnitType),
_scalingService.Scale(element.GetMaterialVolume(matId), volumeUnitType),
volumeUnitType
);
}
}
}
if (_converterSettings.Current.Document.GetElement(matId) is DB.Material material)
private void ProcessMaterialsByElementTypes(List<DB.ElementId> elementIds, Dictionary<string, object> quantities)
{
Dictionary<DB.ElementId, double> matLengths = new(); // stores mat id to total length found for mat
foreach (DB.ElementId elementId in elementIds)
{
if (
_converterSettings.Current.Document.GetElement(elementId) is DB.Element element
&& _converterSettings.Current.Document.GetElement(element.GetTypeId()) is DB.ElementType elementType
)
{
DB.ElementId elementMatId = DB.ElementId.InvalidElementId;
foreach (DB.Parameter param in elementType.Parameters)
{
materialQuantity["materialName"] = material.Name;
materialQuantity["materialCategory"] = material.MaterialCategory;
materialQuantity["materialClass"] = material.MaterialClass;
// get StructuralAssetId (or try to)
DB.ElementId structuralAssetId = material.StructuralAssetId;
if (structuralAssetId != DB.ElementId.InvalidElementId)
DB.Definition def = param.Definition;
if (param.StorageType == DB.StorageType.ElementId && def.GetDataType() == DB.SpecTypeId.Reference.Material)
{
StructuralAssetProperties structuralAssetProperties = _structuralAssetExtractor.TryGetProperties(
structuralAssetId
);
elementMatId = param.AsElementId();
break;
}
}
materialQuantity["structuralAsset"] = structuralAssetProperties.Name;
AddMaterialProperty(
materialQuantity,
"density",
structuralAssetProperties.Density,
structuralAssetProperties.DensityUnitId
);
// more reliable way of determining material type (wood/concrete/type) as it uses Revit enum
// materialClass, materialCategory etc. are user string inputs
materialQuantity["materialType"] = structuralAssetProperties.MaterialType;
// Only add compressive strength for concrete materials (used by F+E for Automate)
if (
structuralAssetProperties.MaterialType == "Concrete"
&& structuralAssetProperties.CompressiveStrength.HasValue
)
if (elementMatId != DB.ElementId.InvalidElementId)
{
// try get the length from the element
foreach (DB.Parameter eParam in element.Parameters)
{
DB.Definition eParamDef = eParam.Definition;
var forgeTypeId = eParamDef.GetDataType();
if (forgeTypeId == DB.SpecTypeId.Length)
{
AddMaterialProperty(
materialQuantity,
"compressiveStrength",
structuralAssetProperties.CompressiveStrength.Value,
structuralAssetProperties.CompressiveStrengthUnitId!
);
double length = eParam.AsDouble();
if (matLengths.TryGetValue(elementMatId, out double _))
{
matLengths[elementMatId] += length;
}
else
{
matLengths.Add(elementMatId, length);
}
}
}
quantities[material.Name] = materialQuantity;
}
}
}
return quantities;
foreach (var entry in matLengths)
{
var materialQuantity = new Dictionary<string, object>();
var unitSettings = _converterSettings.Current.Document.GetUnits();
// add material props
if (TryAddMaterialPropertiesToQuantitiesDict(entry.Key, materialQuantity, out string matName))
{
quantities[matName] = materialQuantity;
// add length prop
var lengthUnitType = unitSettings.GetFormatOptions(DB.SpecTypeId.Length).GetUnitTypeId();
AddMaterialProperty(
materialQuantity,
"length",
_scalingService.Scale(entry.Value, lengthUnitType),
lengthUnitType
);
}
}
}
/// <summary>
/// Adds the material properties (like name, category, and class) to the material quantity dictionary
/// </summary>
/// <param name="matId">the material id</param>
/// <param name="materialQuantity"></param>
/// <param name="matName"></param>
/// <returns>true if material is found, false if not</returns>
private bool TryAddMaterialPropertiesToQuantitiesDict(
DB.ElementId matId,
Dictionary<string, object> materialQuantity,
out string matName
)
{
matName = "";
if (_converterSettings.Current.Document.GetElement(matId) is DB.Material material)
{
materialQuantity["materialName"] = material.Name;
materialQuantity["materialCategory"] = material.MaterialCategory;
materialQuantity["materialClass"] = material.MaterialClass;
// get StructuralAssetId (or try to)
DB.ElementId structuralAssetId = material.StructuralAssetId;
if (structuralAssetId != DB.ElementId.InvalidElementId)
{
StructuralAssetProperties structuralAssetProperties = _structuralAssetExtractor.TryGetProperties(
structuralAssetId
);
materialQuantity["structuralAsset"] = structuralAssetProperties.Name;
AddMaterialProperty(
materialQuantity,
"density",
structuralAssetProperties.Density,
structuralAssetProperties.DensityUnitId
);
// more reliable way of determining material type (wood/concrete/type) as it uses Revit enum
// materialClass, materialCategory etc. are user string inputs
materialQuantity["materialType"] = structuralAssetProperties.MaterialType;
// Only add compressive strength for concrete materials (used by F+E for Automate)
if (
structuralAssetProperties.MaterialType == "Concrete"
&& structuralAssetProperties.CompressiveStrength.HasValue
)
{
AddMaterialProperty(
materialQuantity,
"compressiveStrength",
structuralAssetProperties.CompressiveStrength.Value,
structuralAssetProperties.CompressiveStrengthUnitId!
);
}
}
matName = material.Name;
return true;
}
return false;
}
/// <summary>
@@ -129,7 +239,7 @@ public class MaterialQuantitiesToSpeckleLite : ITypedConverter<DB.Element, Dicti
/// <param name="value">The numeric value of the property</param>
/// <param name="unitId">The Forge type ID representing the units of the property</param>
/// <remarks>
/// Saves code when used repeatedbly. Etabs implements an extension method to dicts (see utils folder). May be worth exploring.
/// Saves code when used repeatedly. Etabs implements an extension method to dicts (see utils folder). May be worth exploring.
/// </remarks>
private void AddMaterialProperty(
Dictionary<string, object> materialQuantity,
@@ -1,11 +1,12 @@
using Speckle.Importers.JobProcessor.Domain;
using Microsoft.Extensions.Logging;
using Speckle.Importers.JobProcessor.Domain;
using Speckle.Importers.Rhino;
using Speckle.Sdk.Api;
using Version = Speckle.Sdk.Api.GraphQL.Models.Version;
namespace Speckle.Importers.JobProcessor.JobHandlers;
internal sealed class RhinoJobHandler : IJobHandler
internal sealed class RhinoJobHandler(ILogger<RhinoJobHandler> logger) : IJobHandler
{
public async Task<Version> ProcessJob(FileimportJob job, IClient client, CancellationToken cancellationToken)
{
@@ -31,7 +32,23 @@ internal sealed class RhinoJobHandler : IJobHandler
}
finally
{
Directory.Delete(directory.FullName, true);
try
{
await Cleanup(directory.FullName);
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
{
logger.LogError(ex, "Failed to cleanup file");
}
}
}
private static async Task Cleanup(string path)
{
//Some weird cases where *something* is keeping a lock on the file, this *may* fix things...
await Task.Delay(100);
GC.Collect();
GC.WaitForPendingFinalizers();
Directory.Delete(path, true);
}
}
@@ -28,10 +28,10 @@ internal sealed class JobProcessorInstance(
{
await using var connection = await repository.SetupConnection(cancellationToken).ConfigureAwait(false);
logger.LogInformation("Listening for jobs...");
while (true)
{
logger.LogInformation("Listening for jobs...");
FileimportJob? job = await repository.GetNextJob(connection, cancellationToken);
if (job == null)
{
@@ -94,7 +94,7 @@ internal sealed class JobProcessorInstance(
projectId = job.Payload.ProjectId,
jobId = job.Payload.BlobId,
warnings = [],
reason = ex.ToString(),
reason = string.IsNullOrEmpty(ex.Message) ? ex.GetType().ToString() : ex.Message,
result = new FileImportResult(0, 0, 0, "Rhino Importer", versionId: null)
};
await client.FileImport.FinishFileImportJob(input, cancellationToken);
@@ -0,0 +1,34 @@
using Speckle.Sdk.SQLite;
namespace Speckle.Importers.Rhino.Internal;
/// <summary>
/// Dummy implementation of <see cref="ISqLiteJsonCacheManager"/> to avoid
/// </summary>
public sealed class DummySqliteJsonCacheManager : ISqLiteJsonCacheManager
{
public void Dispose() { }
public IReadOnlyCollection<(string Id, string Json)> GetAllObjects() => [];
public void DeleteObject(string id) { }
public string? GetObject(string id) => null;
public void SaveObject(string id, string json) { }
public void UpdateObject(string id, string json) { }
public void SaveObjects(IEnumerable<(string id, string json)> items) { }
public bool HasObject(string objectId) => false;
}
public sealed class DummySqliteJsonCacheManagerFactory : ISqLiteJsonCacheManagerFactory
{
private static readonly ISqLiteJsonCacheManager s_instance = new DummySqliteJsonCacheManager();
public ISqLiteJsonCacheManager CreateForUser(string scope) => s_instance;
public ISqLiteJsonCacheManager CreateFromStream(string streamId) => s_instance;
}
@@ -1,4 +1,4 @@
using Rhino;
using Rhino;
using Speckle.Importers.Rhino.Internal.FileTypeConfig;
using Speckle.Sdk;
using Speckle.Sdk.Credentials;
@@ -34,10 +34,9 @@ internal sealed class ImporterInstance(Sender sender)
}
finally
{
//Being a bit extra defensive that we're cleaning up the old doc
//Being a bit extra defensive to ensure we're cleaning up the old doc
RhinoDoc.ActiveDoc?.Dispose();
RhinoDoc.ActiveDoc = null;
GC.Collect();
}
}
@@ -3,6 +3,7 @@ using Speckle.Connectors.Common;
using Speckle.Connectors.Common.Threading;
using Speckle.Connectors.Rhino.DependencyInjection;
using Speckle.Converters.Rhino;
using Speckle.Sdk.SQLite;
namespace Speckle.Importers.Rhino.Internal;
@@ -21,6 +22,9 @@ internal static class ServiceRegistration
// override default thread context
services.AddSingleton<IThreadContext>(new ImporterThreadContext());
// override sqlite cache, since we don't want to persist to disk any object data
services.AddTransient<ISqLiteJsonCacheManagerFactory, DummySqliteJsonCacheManagerFactory>();
return services;
}
}