Purpose

Expand or shrink input CSOs along main axes.

Details

CSOs belonging to inCSOList0 should be:
  • closed
  • not self-intersecting
  • in-plane
  • laying on XY parallel planes

In “Shrink” offset mode “z” direction is disabled.

Known bugs The offset operation fails for some offset values. This is a known bug of the boost::geometry library which is used internally.

Windows

Default Panel

../../../Projects/MLCSOOffset/Modules/mhelp/Images/Screenshots/CSOOffset._default.png

Input Fields

inCSOList0

name: inCSOList0, type: MLBase

Output Fields

outCSOList

name: outCSOList, type: MLBase

Parameter Fields

Field Index

+x: Double Clear: Trigger Reset: Trigger
+y: Double Expand suffix: String Shrink suffix: String
+z: Double Has Valid Output: Bool Spacing [mm]: Double
-x: Double Isotropic: Bool Status Code: Enum
-y: Double Offset mode: Enum Status Message: String
-z: Double On Input Change Behavior: Enum Threads: Integer
[]: Trigger Points per ellipse: Integer Treat ungrouped CSOs as group: Bool
Append offset value: Bool Process groupwise: Bool Update: Trigger

Visible Fields

Update

name: update, type: Trigger

Initiates update of all output field values.

Clear

name: clear, type: Trigger

Clears all output field values to a clean initial state.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: shouldUpdateAutomatically,shouldAutoUpdate

Declares how the module should react if a value of an input field changes.

Values:

Title Name Deprecated Name
Update Update TRUE
Clear Clear FALSE

Status Code

name: statusCode, type: Enum, persistent: no

Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title Name
Ok Ok
Invalid input object Invalid input object
Invalid input parameter Invalid input parameter
Internal error Internal error

Status Message

name: statusMessage, type: String, persistent: no

Gives additional, detailed information about status code as human-readable message.

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

+x

name: inPosXOffset, type: Double, default: 0, minimum: 0

Offset in direction of positive x axis [mm].

-x

name: inNegXOffset, type: Double, default: 0, minimum: 0

Offset in direction of negative x axis [mm].

+y

name: inPosYOffset, type: Double, default: 0, minimum: 0

Offset in direction of positive y axis [mm].

-y

name: inNegYOffset, type: Double, default: 0, minimum: 0

Offset in direction of negative y axis [mm].

+z

name: inPosZOffset, type: Double, default: 0, minimum: 0

Offset in direction of positive z axis [mm].

-z

name: inNegZOffset, type: Double, default: 0, minimum: 0

Offset in direction of negative z axis [mm].

Isotropic

name: inIsotropicMode, type: Bool, default: TRUE

Isotropic mode.

Points per ellipse

name: inPointsPerEllipse, type: Integer, default: 36, minimum: 4

Number of points which are generated per ellipse. Ellipses are used to close discontinuities appearing due to offsetting.

Spacing [mm]

name: inSpacing, type: Double, default: 1

This value is used to determine z coordinates of CSOs in case of extending along z direction.

Reset

name: inReset, type: Trigger

Set all offset values to zero.

Threads

name: inNumThreads, type: Integer, default: 8, minimum: 1

Number of threads used for computation.

Process groupwise

name: inShouldProcessGroupwise, type: Bool, default: TRUE

CSO size is influenced by other CSOs from the same CSOGroup.

Treat ungrouped CSOs as group

name: inShouldTreatUngroupedCSOsAsAGroup, type: Bool, default: FALSE

Treat ungrouped CSOs as a CSOGroup.

Expand suffix

name: inExpandLabelSuffix, type: String, default: _expanded

String appended to group name in Expand mode.

Shrink suffix

name: inShrinkLabelSuffix, type: String, default: _shrunk

String appended to group name in Shrink mode.

Append offset value

name: inShouldAppendOffsetValue, type: Bool, default: TRUE

Appends offset value to group name (only when Isotropic is on).

Offset mode

name: inOffsetMode, type: Enum, default: EXPAND

Offset mode (either Expand or Shrink).

Values:

Title Name
Expand EXPAND
Shrink SHRINK