Matrix |
Provides a flow job element as a container to execute child job elements iteratively in a 3D-matrix fashion. The ModelMatrix could be used to give more variations on how the traversal should work.
IMPORTANT: The matrix uses Cartesian convention, not the regular row-column.
IMPORTANT: The matrix uses Cartesian convention, not the regular row-column.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseFlowJobElement
RAYLASE.Marker.JobElementBaseLoopFlow
RAYLASE.MarkerPlugin.JobElementsMatrixCopy
RAYLASE.MarkerPlugin.JobElementsTiler
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseFlowJobElement
RAYLASE.Marker.JobElementBaseLoopFlow
RAYLASE.MarkerPlugin.JobElementsMatrixCopy
RAYLASE.MarkerPlugin.JobElementsTiler
Namespace: RAYLASE.MarkerPlugin.JobElements
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.19.0
SyntaxC#
public class MatrixCopy : BaseLoopFlow
The MatrixCopy type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MatrixCopy | Initializes a new instance of the Object class. |
Properties| Name | Description | |
|---|---|---|
 | AlternationOffset | The offset to be applied for every other index in the 1st dimension. |
 | ApplicationDataDirectory |
The directory where application data, such as logs and configurations, are stored.
(Inherited from BaseJobElement) |
| CanOutputSingleJobElement | (Inherited from BaseFlowJobElement) |
| Centered | Distributes the children around the position of the container. |
| Children |
The list of the child job elements.
(Inherited from BaseFlowJobElement) |
| Condition |
The binning condition for the holder of the job element.
(Inherited from BaseJobElement) |
| ConfigurationManager | (Inherited from BasePlugin) |
| CurrentIteration |
The current iteration index.
(Inherited from BaseLoopFlow) |
| DeviceManager | (Inherited from BaseJobElement) |
| Dimensions | The dimension of the matrix as a vector of (number of cells in x-direction, number of cells in y-direction, number of cells in z-direction). |
| DirtyFlagLocker |
The lock object for property modification.
(Inherited from BaseJobElement) |
| DoHandleConditionPortChangedDelegate | (Inherited from BaseJobElement) |
| FlexibleLocations | List of cell positions that will be processed during execution. This overrides the default behavior of processing all cells. |
| HasConditionValueOverride |
The flag to indicate that the condition is used for the direct children and each can override the condition value. The container itself does not use the binning.
(Inherited from BaseFlowJobElement) |
| InternalChildren |
The list of the child job elements, in read-write form.
(Inherited from BaseFlowJobElement) |
| InternalIterations |
The number of iterations that will be performed.
(Inherited from BaseLoopFlow) |
| IsAborted |
The flag to indicate whether this job element has stopped processing its children in case of error.
(Inherited from BaseFlowJobElement) |
| IsBidirectional | The flag to indicate whether the traversal is bidirectional. For example, if starting from MinMinMin and traversing in XYZ direction, row 1 is from left to right, row 2 is from right to left. |
| IsDirty |
The flag to indicate whether the content of this job element has been modified.
(Inherited from BaseJobElement) |
| IsNonAtomic | Obsolete. The flag to indicate whether the children execution will be intermingled with other outside job elements. This is only meaningful if the parent's IsParallel is true. (Inherited from BaseFlowJobElement) |
| IsParallel | Obsolete. The flag to indicate whether the children will be executed in parallel. (Inherited from BaseFlowJobElement) |
| IsUsingFlexibleLocations | |
| JobElementID |
The unique ID of the job element. If the concrete class inherits from BaseJobElement, the JobElementID of the BaseJobElement will be prefilled. Recommended not to be changed.
(Inherited from BaseJobElement) |
| LogDirectory |
The directory of the log file.
(Inherited from BasePlugin) |
| Logger |
The common logger.
(Inherited from BasePlugin) |
| MarkableConfiguration |
The configuration of this flow job element.
(Inherited from BaseFlowJobElement) |
| OutputSingleJobElement | (Inherited from BaseFlowJobElement) |
| Pitches | The cell size of the matrix as a vector of (cell size in x-direction, cell size in y-direction, cell size in z-direction). |
| PluginMetadata |
The metadata of the plugin instances. If the concrete class inherits from the BasePluginSetup interface, the metadata of the BasePluginSetup will be prefilled.
(Inherited from BasePlugin) |
| ProcessingDirection | The direction of the traversal. The default is x first, then y, and then z. |
| PropertyMask | (Inherited from BaseJobElement) |
| Repeat |
If true the job element will be executed repeatedly
(Inherited from BaseLoopFlow) |
| ShowConditionControllerUIDelegate |
The delegate to show the controller UI because no ports have been defined.
(Inherited from BaseJobElement) |
| SkipLocations | List of cell positions that will be skipped during execution. |
| StartLocation | The location of the starting cell. The default is MinMinMin cell. |
| UseMaxFlowJobElementExecutions |
The flag to indicate whether this flow job element honors the value of maximum executions that is passed via the Execute method.
(Inherited from BaseLoopFlow) |
| VariableManager | (Inherited from BaseJobElement) |
| VariableScopeName | (Inherited from BaseJobElement) |
Methods| Name | Description | |
|---|---|---|
| AddJobElement |
Adds a job element as a child.
(Inherited from BaseFlowJobElement) |
 | CalculateCellPosition | |
| CalculateOffsetToCenter | (Overrides BaseLoopFlowCalculateOffsetToCenter(Int64)) |
| CenterToOrigin |
Moves the job element so that its centroid is at the origin.
(Inherited from BaseFlowJobElement) |
| ClearAllJobElements |
Removes all child items.
(Inherited from BaseFlowJobElement) |
| CompareWith | (Inherited from BaseJobElement) |
| CopyFrom |
Copies the source job element into this job element.
(Inherited from BaseJobElement) |
| Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) | (Inherited from BasePlugin) |
| DisposeUI | (Inherited from BaseFlowJobElement) |
| DoClearAllJobElements |
Removes all child items of a given list.
(Inherited from BaseFlowJobElement) |
| DoCompareWith | (Inherited from BaseJobElement) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoExecuteJobElements |
Process the child job elements relative to this job element. Each child can be modified by a local process configuration.
(Inherited from BaseFlowJobElement) |
| DoGetUIMask | (Inherited from BaseJobElement) |
| DoInsertJobElement |
Inserts a job element as a child of a given list.
(Inherited from BaseFlowJobElement) |
| DoRemoveJobElement |
Removes a child job element from a given list.
(Inherited from BaseFlowJobElement) |
| DoShowUI(String) | (Inherited from BaseJobElement) |
| DoShowUI(JobElementHolder, String) | (Overrides BaseJobElementDoShowUI(JobElementHolder, String)) |
| DoShowUI(JobElementHolder, String, PropertyMask) | (Inherited from BaseJobElement) |
| DoShowUICallback(PluginSettingsView) |
This callback method is called when a GUI settings dialog is closed
with Apply or OK and is used to extract the changed properties from
a settings dialog in the GUI.
(Inherited from BaseJobElement) |
| DoShowUICallback(JobElementHolder, PluginSettingsView) |
This callback method is called when a GUI settings dialog is closed
with Apply or OK and is used to extract the changed properties from
a settings dialog in the GUI.
(Overrides BaseJobElementDoShowUICallback(JobElementHolder, PluginSettingsView)) |
| ExecuteJobElements |
Iterates the child job elements N times.
(Inherited from BaseLoopFlow) |
| Flip |
Flip the job element against given flags for axes.
(Inherited from BaseFlowJobElement) |
| GenerateLocalTag | (Inherited from BaseJobElement) |
| GetBoundingBox | (Inherited from BaseFlowJobElement) |
| GetCounter | (Inherited from BaseLoopFlow) |
| GetLocalTransformation | Returns the transformation matrix of a given child position, relative to the matrix copy. |
| GetUIMask | (Inherited from BaseJobElement) |
| HandleChildJobElementProcessingStarting |
Propagates the event received from the helper back to the top executor.
(Inherited from BaseFlowJobElement) |
| HandleConditionPortChanged |
Performs necessary adjustments whenever the controller has updated its ports.
(Inherited from BaseJobElement) |
| HandleLocalChildJobElementIsAvailable |
Handles the event received from the helper that a child job element is found.
(Inherited from BaseLoopFlow) |
| HasDynamicChild |
Returns whether this job element contains a dynamic job element recursively.
(Inherited from BaseFlowJobElement) |
| HasInfinitePassChild |
Returns whether this job element contains a child with an infinite pass recursively.
(Inherited from BaseFlowJobElement) |
| HasNonFlowChild |
Returns whether this job element contains a job element that is not a flow job element.
(Inherited from BaseFlowJobElement) |
| HasPoint |
Tests whether a point is inside (inclusively) the job element. This applies only if the job element is on a single plane.
(Inherited from BaseFlowJobElement) |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Overrides BasePluginInitialize) |
| InsertJobElement |
Inserts a job element as a child.
(Inherited from BaseFlowJobElement) |
| IsChildEditable | (Inherited from BaseLoopFlow) |
| ModifyChildProcessingHolder | (Inherited from BaseLoopFlow) |
| MoveTo |
Moves the job element so that its centroid is at the given position.
(Inherited from BaseFlowJobElement) |
| PostAllItemIteration |
Executes the necessary steps after each iteration is performed.
(Inherited from BaseLoopFlow) |
| PostExecute |
Executes the necessary steps after the job elements were processed.
(Inherited from BaseFlowJobElement) |
| PreAllItemIteration |
Executes the necessary steps before each iteration is performed.
(Overrides BaseLoopFlowPreAllItemIteration(ProcessingHolder, ProcessingHolder, MarkableConfiguration, MarkableConfiguration, Guid, NullableInt32)) |
| PreExecute |
Executes the necessary steps before the job elements are processed.
(Overrides BaseFlowJobElementPreExecute(ProcessingHolder, ProcessingHolder, MarkableConfiguration, Guid, NullableInt32)) |
| RemoveJobElement |
Removes a child job element.
(Inherited from BaseFlowJobElement) |
| Rotate(Double) |
Rotates the job element a given angle around the z-axis.
(Inherited from BaseFlowJobElement) |
| Rotate(Double, dvec3) |
Rotates the job element a given angle with respect to a given vector passing through its centroid.
(Inherited from BaseFlowJobElement) |
| Scale(Double) |
Scales the job element uniformly with respect to its centroid.
(Inherited from BaseFlowJobElement) |
| Scale(dvec3) |
Scales the job element non-uniformly with respect to its centroid.
(Inherited from BaseFlowJobElement) |
| ShowUI(String) | (Inherited from BaseJobElement) |
| ShowUI(JobElementHolder, String) | (Inherited from BaseJobElement) |
| ShowUI(JobElementHolder, String, PropertyMask) | (Inherited from BaseFlowJobElement) |
| ShowUICallback(PluginSettingsView) | (Inherited from BaseJobElement) |
| ShowUICallback(JobElementHolder, PluginSettingsView) | (Inherited from BaseFlowJobElement) |
| ShowUICancelCallback(PluginSettingsView) |
Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin) |
| ShowUICancelCallback(JobElementHolder, PluginSettingsView) | (Inherited from BaseJobElement) |
| ToString | (Inherited from BasePlugin) |
| Transform |
Multiplies the model matrix with a transformation matrix.
(Inherited from BaseFlowJobElement) |
| Translate |
Translates the job element with a given vector.
(Inherited from BaseFlowJobElement) |
| UpdateFieldT |
Updates the Property to the value by using DirtyFlagLocker and setting IsDirty .
(Inherited from BaseJobElement) |
Events| Name | Description | |
|---|---|---|
 | ChildJobElementProcessingStarting |
Raised when a child job element is started being processed by a flow job element.
(Inherited from BaseFlowJobElement) |
See Also