Base |
Represents the base class of all plugins of type flow job elements. A flow job element is a container that has children job elements. It will perform a certain logic to its children when it is executed.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseFlowJobElement
RAYLASE.Marker.JobElementBaseLoopFlow
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseFlowJobElement
RAYLASE.Marker.JobElementBaseLoopFlow
Namespace: RAYLASE.Marker.JobElement
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.31.0
SyntaxC#
public abstract class BaseFlowJobElement : BaseJobElement, IMarkableJobElement, ITransformable
The BaseFlowJobElement type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BaseFlowJobElement | Initializes a new instance of the Object class. |
Properties| Name | Description | |
|---|---|---|
 | ApplicationDataDirectory |
The directory where application data, such as logs and configurations, are stored.
(Inherited from BaseJobElement) |
 | CanOutputSingleJobElement | |
| Children | The list of the child job elements. |
| Condition |
The binning condition for the holder of the job element.
(Inherited from BaseJobElement) |
| ConfigurationManager | (Inherited from BasePlugin) |
| DeviceManager | (Inherited from BaseJobElement) |
| DirtyFlagLocker |
The lock object for property modification.
(Inherited from BaseJobElement) |
| DoHandleConditionPortChangedDelegate | (Inherited from BaseJobElement) |
| 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. |
| InternalChildren | The list of the child job elements, in read-write form. |
| IsAborted | The flag to indicate whether this job element has stopped processing its children in case of error. |
| 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. |
| IsParallel | Obsolete. The flag to indicate whether the children will be executed in parallel. |
| 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. |
| OutputSingleJobElement | |
| 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) |
| PropertyMask | (Inherited from BaseJobElement) |
| ShowConditionControllerUIDelegate |
The delegate to show the controller UI because no ports have been defined.
(Inherited from BaseJobElement) |
| VariableManager | (Inherited from BaseJobElement) |
| VariableScopeName | (Inherited from BaseJobElement) |
Methods| Name | Description | |
|---|---|---|
 | AddJobElement | Adds a job element as a child. |
| CenterToOrigin | Moves the job element so that its centroid is at the origin. |
| ClearAllJobElements | Removes all child items. |
| 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 | (Overrides BaseJobElementDisposeUI(PluginSettingsView)) |
| DoClearAllJobElements | Removes all child items of a given list. |
| 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. |
| DoGetUIMask | (Inherited from BaseJobElement) |
| DoInsertJobElement | Inserts a job element as a child of a given list. |
| DoRemoveJobElement | Removes a child job element from a given list. |
| DoShowUI(String) | (Inherited from BaseJobElement) |
| DoShowUI(JobElementHolder, String) | (Inherited from BaseJobElement) |
| 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.
(Inherited from BaseJobElement) |
| ExecuteJobElements | Processes child job elements using a certain logic. This method is executed in between the PreExecute and the PostExecute methods. |
| Flip | Flip the job element against given flags for axes. |
| GenerateLocalTag | (Inherited from BaseJobElement) |
| GetBoundingBox | |
| GetUIMask | (Inherited from BaseJobElement) |
| HandleChildJobElementProcessingStarting | Propagates the event received from the helper back to the top executor. |
| 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. |
| HasDynamicChild | Returns whether this job element contains a dynamic job element recursively. |
| HasInfinitePassChild | Returns whether this job element contains a child with an infinite pass recursively. |
| HasNonFlowChild | Returns whether this job element contains a job element that is not a flow job element. |
| HasPoint | Tests whether a point is inside (inclusively) the job element. This applies only if the job element is on a single plane. |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin) |
| InsertJobElement | Inserts a job element as a child. |
| IsChildEditable | |
| MoveTo | Moves the job element so that its centroid is at the given position. |
| PostExecute | Executes the necessary steps after the job elements were processed. |
| PreExecute | Executes the necessary steps before the job elements are processed. |
| RemoveJobElement | Removes a child job element. |
| Rotate(Double) | Rotates the job element a given angle around the z-axis. |
| Rotate(Double, dvec3) | Rotates the job element a given angle with respect to a given vector passing through its centroid. |
| Scale(Double) | Scales the job element uniformly with respect to its centroid. |
| Scale(dvec3) | Scales the job element non-uniformly with respect to its centroid. |
| ShowUI(String) | (Inherited from BaseJobElement) |
| ShowUI(JobElementHolder, String) | (Inherited from BaseJobElement) |
| ShowUI(JobElementHolder, String, PropertyMask) | (Overrides BaseJobElementShowUI(JobElementHolder, String, PropertyMask)) |
| ShowUICallback(PluginSettingsView) | (Inherited from BaseJobElement) |
| ShowUICallback(JobElementHolder, PluginSettingsView) | (Overrides BaseJobElementShowUICallback(JobElementHolder, PluginSettingsView)) |
| 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. |
| Translate | Translates the job element with a given vector. |
| 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. |
See Also