FME Transformers: 2024.1

Categories
3D

3D

Geometries

Geometries

Categories
3D

3D

Geometries

Geometries

SolidBuilder

Constructs solids from surfaces and cuts hollow regions, or voids, in solid features with other solid features. A solid that is cut by another solid must contain that second solid.

Example

The example below illustrates the input features on the left and the output features on the right. The input consists of surface and simple solid features. The output consists of a constructed solid feature in blue and unused solid features in brown and purple that were not used in constructing closed solids.

Configuration

Input Ports

Surface and simple solid features

Output Ports

Solid features

This port outputs surface features that were not used in creating closed solids.

Also, when there is a set of geometrically identical solids, all but one of these solids will be rejected. Two solids are considered geometrically identical if their geometries match exactly. Non-geometry properties like coordinate systems, measures, traits, and geometry names are not considered when matching input geometries.

Non-surface or non-solid features.

Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.

Parameters

Group By

Leaving this parameter blank causes the entire set of input solids to form a single group. Alternatively, this parameter allows you to select attributes on which to form groups of solid features – each set of features that have the same value for all of these attributes will be processed independently in a group.

No attributes other than Group By attributes will be carried across from the Input features to the output features.

Complete Groups

Select the point in processing at which groups are processed:

When All Features Received

This is the default behavior. Processing will only occur in this transformer once all input is present.

When Group Changes (Advanced)

This transformer will process input groups in order. Changes of the value of the Group By parameter on the input stream will trigger processing on the currently accumulating group. This may improve overall speed (particularly with multiple, equally-sized groups), but could cause undesired behavior if input groups are not truly ordered.

There are two typical reasons for using When Group Changes (Advanced) . The first is incoming data that is intended to be processed in groups (and is already so ordered). In this case, the structure dictates Group By usage - not performance considerations.

The second possible reason is potential performance gains.

Performance gains are most likely when the data is already sorted (or read using a SQL ORDER BY statement) since less work is required of FME. If the data needs ordering, it can be sorted in the workspace (though the added processing overhead may negate any gains).

Sorting becomes more difficult according to the number of data streams. Multiple streams of data could be almost impossible to sort into the correct order, since all features matching a Group By value need to arrive before any features (of any feature type or dataset) belonging to the next group. In this case, using Group By with When All Features Received may be the equivalent and simpler approach.

Note  Multiple feature types and features from multiple datasets will not generally naturally occur in the correct order.

As with many scenarios, testing different approaches in your workspace with your data is the only definitive way to identify performance gains.

Drop Voids

The Drop Voids parameter indicates whether or not solid features used to cut voids in containing features should be dropped or output.

Accumulation Mode

Specify how attributes should be accumulated:

Drop Incoming Attributes

All incoming attributes are removed from the features

Merge Incoming Attributes

Merges all attributes from overlapping features

Use Attributes From One Feature

Takes all attributes from one representative feature

Generate List

When enabled, adds a list attribute to the output features, retaining attribute values for multiple input features. A list with the same name is created for traits.

List Name

Enter a name for the list attribute.

Note  List attributes are not accessible from the output schema in FME Workbench unless they are first processed using a transformer that operates on them, such as ListExploder or ListConcatenator. Alternatively, AttributeExposer can be used.

Add To List

All Attributes: Every attribute from all input features that contributed to the output feature will be added to the list specified in List Name.

Selected Attributes: Only the attributes specified in the Selected Attributes parameter will be added to the list specified in List Name.

Selected Attributes

The attributes to be added to the list when Add To List is Selected Attributes.

Void Flag

Name the attribute to contain "yes" if that feature was used to cut a void inside some other feature, and "no" if that feature did not cut into any other features.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters Create your own editable parameters.

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

FME Community

The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.

Search for all results about the SolidBuilder on the FME Community.