Base |
Represents the base class of all plugins of type markable job elements. A markable job element has a content and a configuration that define how it should be marked by a scan controller.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseMarkableJobElement
RAYLASE.Marker.JobElementBaseMarkableBitmapGraphic
RAYLASE.Marker.JobElementBaseMarkableVectorGraphic
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseMarkableJobElement
RAYLASE.Marker.JobElementBaseMarkableBitmapGraphic
RAYLASE.Marker.JobElementBaseMarkableVectorGraphic
Namespace: RAYLASE.Marker.JobElement
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.19.0
SyntaxC#
public abstract class BaseMarkableJobElement : BaseJobElement, IMarkableJobElement, ITransformable, IRenderableJobElement
The BaseMarkableJobElement type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BaseMarkableJobElement | Initializes a new instance of the Object class. |
Properties| Name | Description | |
|---|---|---|
 | AllowedScanControllers | List of scan controllers as the target of the job element. An empty list means the job element allows any scan controller to be the target. |
 | ApplicationDataDirectory |
The directory where application data, such as logs and configurations, are stored.
(Inherited from BaseJobElement) |
| AvailableScanControllers | List of available scan controllers that can be used as the targets. |
| BoundingBoxMap | |
| Condition |
The binning condition for the holder of the job element.
(Inherited from BaseJobElement) |
| ConfigurationManager | (Inherited from BasePlugin) |
| DefaultPenNumber | |
| DeviceManager | (Inherited from BaseJobElement) |
| DirtyFlagLocker |
The lock object for property modification.
(Inherited from BaseJobElement) |
| DoHandleConditionPortChangedDelegate | (Inherited from BaseJobElement) |
| EnvelopingOutline | Defines the shape used to approximate the outline. |
| Executions | The number of times this job element should be executed. |
| ExecutionSequences | List of sequences on how the job element is iterated during execution. Each sequence can have its own number of iteration, outline pen, and filling pen. |
| IsDirty |
The flag to indicate whether the content of this job element has been modified.
(Inherited from BaseJobElement) |
| IsLocked | The flag to indicate whether the content of this job element should not be modified. |
| 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: marker profiles, model matrix, and bounding box. |
| PenNumber | The pen for the contour of this job element. |
| 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) |
| POIs | Points of interest to be drawn on canvas but not marked. |
| PropertyMask | (Inherited from BaseJobElement) |
| ShowConditionControllerUIDelegate |
The delegate to show the controller UI because no ports have been defined.
(Inherited from BaseJobElement) |
| SupportIterationLevel | |
| VariableManager | (Inherited from BaseJobElement) |
| VariableScopeName | (Inherited from BaseJobElement) |
Methods| Name | Description | |
|---|---|---|
 | AlterPenSetPostBuild | Provides the possibility to alter the resolved pen set during execution. |
| AlterPenSetPreBuild | Provides the possibility to alter the resolved pen set during execution. |
| BuildContent | Builds the job element's contents (in terms of meta-commands) so that it will be consistent with its properties. |
| CenterToOrigin | Moves the job element so that its centroid is at the origin. |
| CompareWith | (Overrides BaseJobElementCompareWith(JobElementHolder, JobElementHolder, PropertyMask)) |
| CopyFrom |
Copies the source job element into this job element.
(Inherited from BaseJobElement) |
| CreateFromBox | Sets the metric properties to fit the box defined by the two points. |
| Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) | (Inherited from BasePlugin) |
| DisposeUI | (Overrides BaseJobElementDisposeUI(PluginSettingsView)) |
| DoCompareWith | (Inherited from BaseJobElement) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoGetUIMask | (Inherited from BaseJobElement) |
| 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) |
| Flip | Flip the job element against given flags for axes. |
| GenerateLocalTag | (Inherited from BaseJobElement) |
| GetBoundingBox | Returns the bounding box of the transformed job element. |
| GetExecutionStats | Gets the execution statistics of the job element |
| GetNontransformedBoundingBox | |
| GetTransformedBoundingBox | |
| GetUIMask | (Inherited from BaseJobElement) |
| HandleConditionPortChanged |
Performs necessary adjustments whenever the controller has updated its ports.
(Inherited from BaseJobElement) |
| 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) |
| InvokePenSetUpdated | |
| IsEmpty | Returns true if job element doesn't contain any content. |
| MoveTo | Moves the job element so that its centroid is at the given position. |
| Rebuild(dmat4) | Updates the job element's contents (in terms of meta-commands) so that it will be consistent with its properties. |
| Rebuild(dmat4, CommandListType) | |
| 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. |
| ScalePrepend(Double) | |
| ScalePrepend(dvec3) | |
| 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) |
| SplitAtPlane(FuncBaseMarkableJobElement, dvec2, dvec2, dmat4, MarkingMode, Double, Double) | Splits the job element along the plate that is perpendicular to the XY plane and traversing the line defined by the two points. |
| SplitAtPlane(FuncBaseMarkableJobElement, dvec2, dvec2, dmat4, Double, Double, Boolean) | Splits the job element along the plate that is perpendicular to the XY plane and traversing the line defined by the two points. |
| SplitAtPlane(FuncBaseMarkableJobElement, dvec3, dvec3, dvec3, dmat4, MarkingMode, Double, Double) | Splits the job element along the plate defined by the two lines from p0 to p1 and p0 to p2. |
| SplitAtPlane(FuncBaseMarkableJobElement, dvec3, dvec3, dvec3, dmat4, Double, Double, Boolean) | Splits the job element along the plate defined by the two lines from p0 to p1 and p0 to p2. |
| 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) |
See Also