Markable |
Provides a vector graphic job element for drawing a rectangle.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseMarkableJobElement
RAYLASE.Marker.JobElementBaseMarkableVectorGraphic
RAYLASE.MarkerPlugin.JobElementsMarkableSpiral
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseMarkableJobElement
RAYLASE.Marker.JobElementBaseMarkableVectorGraphic
RAYLASE.MarkerPlugin.JobElementsMarkableSpiral
Namespace: RAYLASE.MarkerPlugin.JobElements
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.40.0
SyntaxC#
public class MarkableSpiral : BaseMarkableVectorGraphic
The MarkableSpiral type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MarkableSpiral | 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.
(Inherited from BaseMarkableJobElement) |
 | 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.
(Inherited from BaseMarkableJobElement) |
| BoundingBoxMap | (Inherited from BaseMarkableJobElement) |
| ChordLength | Gets or sets the cord length in Regular mode. A bigger value will decrease the number of vectors. |
| Condition |
The binning condition for the holder of the job element.
(Inherited from BaseJobElement) |
| ConfigurationManager | (Inherited from BasePlugin) |
| DefaultPenNumber | (Inherited from BaseMarkableJobElement) |
| DeviceManager | (Inherited from BaseJobElement) |
| Direction | Gets or sets the direction to inwards or outwards. |
| DirtyFlagLocker |
The lock object for property modification.
(Inherited from BaseJobElement) |
| DoHandleConditionPortChangedDelegate | (Inherited from BaseJobElement) |
| EnvelopingOutline |
Defines the shape used to approximate the outline.
(Inherited from BaseMarkableJobElement) |
| Executions |
The number of times this job element should be executed. This is a shortcut to the first execution sequence.
(Inherited from BaseMarkableJobElement) |
| 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.
(Inherited from BaseMarkableJobElement) |
| FillingPenNumber |
The pen for the filling of this job element. This is a shortcut to the first execution sequence.
(Inherited from BaseMarkableVectorGraphic) |
| FillingProfiles |
The fillingprofiles for the whole vector graphic. The values are dynamically generated during the rebuild process.
(Inherited from BaseMarkableVectorGraphic) |
| FixedRadius | Multiplier for Pitch when using FixedRadiusin Rectangular mode. |
| HasCustomRendering |
Use a different list of layers for rendering and execution.
In case of true, GetCustomRendering must be overridden.
(Inherited from BaseMarkableVectorGraphic) |
| InnerRadius | Gets or sets the inner radius in Regular mode. |
| IsDirty |
The flag to indicate whether the content of this job element has been modified.
(Inherited from BaseJobElement) |
| IsDynamic |
The flag to indicate whether the content of this job element is dynamic.
(Inherited from BaseMarkableVectorGraphic) |
| IsFillable |
Indicates whether the vector graphic content is fillable
(Inherited from BaseMarkableVectorGraphic) |
| IsJerkLimited |
Commands the executor the unlock the scan head. Only activate this setting, if all vectors are jerk limited. Otherwise scan head could be damaged.
(Inherited from BaseMarkableVectorGraphic) |
| IsLocked |
The flag to indicate whether the content of this job element should not be modified.
(Inherited from BaseMarkableJobElement) |
| IsUsingVariable | (Inherited from BaseMarkableVectorGraphic) |
| 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) |
| JobElementManager | (Inherited from BaseJobElement) |
| LayerFactory |
Factory for creating layers.
(Inherited from BaseMarkableVectorGraphic) |
| 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.
(Inherited from BaseMarkableJobElement) |
| MarkerProfile |
The settings for marking. This is a shortcut to the MarkerProfile contained in the MarkableConfiguration.
(Inherited from BaseMarkableVectorGraphic) |
| Orientation | Gets or sets the orientation to clockwise or counterclockwise. |
| PenNumber | (Inherited from BaseMarkableVectorGraphic) |
| PersistVectorGraphic |
Indicates whether the vector graphic content is statically generated, without the need of the Rebuild method.
(Inherited from BaseMarkableVectorGraphic) |
| Pitch | Gets or sets the pitch. |
| 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.
(Inherited from BaseMarkableJobElement) |
| PropertyMask | (Inherited from BaseJobElement) |
| Radius | Gets or sets the radius of the spiral in Regular mode. |
| ShowConditionControllerUIDelegate |
The delegate to show the controller UI because no ports have been defined.
(Inherited from BaseJobElement) |
| Span | Length of the line segments in Regular mode. |
| StartAngle | Gets or sets the start angle in Regular mode. |
| StartTurn | First turn to execute when using rectangular spiral. |
| SupportIterationLevel | (Inherited from BaseMarkableJobElement) |
| SupportsCellFilling |
Indicates whether the vector graphic content supports cell based filling. Mostly useful for Cellcodes.
(Inherited from BaseMarkableVectorGraphic) |
| Turns | Number of turns in Rectangular mode. |
| Type | Gets or sets the type. |
| UseFixedRadius | Uses fixed radius in Rectangular mode. |
| VariableManager | (Inherited from BaseJobElement) |
| VariableScopeName | (Inherited from BaseJobElement) |
| VectorGraphicEngine |
The vector graphic engine. This property holds the content of this job element.
(Inherited from BaseMarkableVectorGraphic) |
Methods| Name | Description | |
|---|---|---|
| AddFilling |
Adds a given filling profile for the contour. This stores only the filling information.
(Inherited from BaseMarkableVectorGraphic) |
| AlterPenSetPostBuild |
Provides the possibility to alter the resolved pen set during execution.
(Inherited from BaseMarkableJobElement) |
| AlterPenSetPreBuild |
Provides the possibility to alter the resolved pen set during execution.
(Inherited from BaseMarkableJobElement) |
 | BuildContent |
Builds the job element's contents (in terms of meta-commands) so that it will be consistent with its properties.
(Overrides BaseMarkableJobElementBuildContent) |
| BuildFillings | (Inherited from BaseMarkableVectorGraphic) |
| CenterToOrigin |
Moves the job element so that its centroid is at the origin.
(Inherited from BaseMarkableJobElement) |
| ClearAllFillings |
Removes all fillings from the list. This removes only the filling information.
(Inherited from BaseMarkableVectorGraphic) |
| CompareWith | (Inherited from BaseMarkableVectorGraphic) |
| 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.
(Overrides BaseMarkableJobElementCreateFromBox(dvec3, dvec3)) |
| Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) | (Inherited from BaseMarkableVectorGraphic) |
| DisposeUI | (Inherited from BaseMarkableJobElement) |
| DoCalculateTotalNumberOfPasses | (Inherited from BaseMarkableJobElement) |
| DoCompareWith | (Overrides BaseJobElementDoCompareWith(JobElementHolder, JobElementHolder, PropertyMask)) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoGetUIMask | (Overrides BaseJobElementDoGetUIMask) |
| DoShowUI(String) | (Inherited from BaseJobElement) |
| DoShowUI(JobElementHolder, String) | (Overrides BaseJobElementDoShowUI(JobElementHolder, String)) |
| DoShowUI(JobElementHolder, String, PropertyMask) | (Overrides BaseJobElementDoShowUI(JobElementHolder, String, PropertyMask)) |
| 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)) |
| DoUpdateDynamicContent |
Updates the content to the latest value. See IsDynamic.
Value can be updated before and after execution.
A unique ID to indicate that the content is simulated using the given ID as the key. The simulated value is reset to the last non-simulated value if the ID changes. The last non-simulated value will be used if the ID is null.The id of the executor calling this method. Used to store and later retrieve the value that was executed by this executor. (Inherited from BaseMarkableVectorGraphic) |
| Flip |
Flip the job element against given flags for axes.
(Inherited from BaseMarkableJobElement) |
| GenerateLocalTag | (Inherited from BaseJobElement) |
| GetBoundingBox |
Returns the bounding box of the transformed job element.
(Inherited from BaseMarkableVectorGraphic) |
| GetCustomRendering |
Returns custom rendering in case of HasCustomRendering.
(Inherited from BaseMarkableVectorGraphic) |
| GetExecutionStats |
Gets the execution statistics of the job element
(Inherited from BaseMarkableVectorGraphic) |
| GetFillingPenNumbers | (Inherited from BaseMarkableVectorGraphic) |
| GetNontransformedBoundingBox | (Inherited from BaseMarkableJobElement) |
| GetPenNumbers | (Inherited from BaseMarkableVectorGraphic) |
| GetTransformedBoundingBox | (Inherited from BaseMarkableVectorGraphic) |
| GetUIMask | (Inherited from BaseJobElement) |
| HandleConditionPortChanged |
Performs necessary adjustments whenever the controller has updated its ports.
(Inherited from BaseJobElement) |
| HasFinitePasses | (Inherited from BaseMarkableVectorGraphic) |
| HasInfinitePasses | (Inherited from BaseMarkableVectorGraphic) |
| HasMultiplePaths | (Inherited from BaseMarkableVectorGraphic) |
| HasPasses | (Inherited from BaseMarkableJobElement) |
| 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 BaseMarkableJobElement) |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Overrides BasePluginInitialize) |
| InvokePenSetUpdated | (Inherited from BaseMarkableJobElement) |
| IsEmpty |
Returns true if job element doesn't contain any content.
(Inherited from BaseMarkableVectorGraphic) |
| LogDynamicContent | (Inherited from BaseMarkableVectorGraphic) |
| MoveTo |
Moves the job element so that its centroid is at the given position.
(Inherited from BaseMarkableJobElement) |
| Rebuild(dmat4) |
Updates the job element's contents (in terms of meta-commands) so that it will be consistent with its properties.
(Inherited from BaseMarkableVectorGraphic) |
| Rebuild(dmat4, CommandListType) | (Inherited from BaseMarkableVectorGraphic) |
| RemoveFilling |
Removes a filling from the list. This removes only the filling information.
(Inherited from BaseMarkableVectorGraphic) |
| RemoveFillingAt |
Removes a filling from the list. This removes only the filling information.
(Inherited from BaseMarkableVectorGraphic) |
| Rotate(Double) |
Rotates the job element a given angle around the z-axis.
(Inherited from BaseMarkableJobElement) |
| Rotate(Double, dvec3) |
Rotates the job element a given angle with respect to a given vector passing through its centroid.
(Inherited from BaseMarkableJobElement) |
| Scale(Double) |
Scales the job element uniformly with respect to its centroid.
(Inherited from BaseMarkableJobElement) |
| Scale(dvec3) |
Scales the job element non-uniformly with respect to its centroid.
(Inherited from BaseMarkableJobElement) |
| ScalePrepend(Double) | (Inherited from BaseMarkableJobElement) |
| ScalePrepend(dvec3) | (Inherited from BaseMarkableJobElement) |
| ShowUI(String) | (Inherited from BaseJobElement) |
| ShowUI(JobElementHolder, String) | (Inherited from BaseJobElement) |
| ShowUI(JobElementHolder, String, PropertyMask) | (Inherited from BaseMarkableVectorGraphic) |
| ShowUICallback(PluginSettingsView) | (Inherited from BaseJobElement) |
| ShowUICallback(JobElementHolder, PluginSettingsView) | (Inherited from BaseMarkableVectorGraphic) |
| 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.
(Inherited from BaseMarkableJobElement) |
| 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.
(Inherited from BaseMarkableJobElement) |
| 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.
(Inherited from BaseMarkableJobElement) |
| 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.
(Inherited from BaseMarkableVectorGraphic) |
| ToString | (Inherited from BasePlugin) |
| Transform |
Multiplies the model matrix with a transformation matrix.
(Inherited from BaseMarkableJobElement) |
| Translate |
Translates the job element with a given vector.
(Inherited from BaseMarkableJobElement) |
| UpdateDynamicContent |
Updates the content to the latest value. The dirty flag is set to true. See IsDynamic.
Value can be updated before and after execution.A unique ID to indicate that the content is simulated using the given ID as the key. The simulated value is reset to the last non-simulated value if the ID changes. The last non-simulated value will be used if the ID is null.The id of the executor calling this method. Used to store and later retrieve the value that was executed by this executor. (Inherited from BaseMarkableVectorGraphic) |
| UpdateFieldT |
Updates the Property to the value by using DirtyFlagLocker and setting IsDirty .
(Inherited from BaseJobElement) |
See Also