Click or drag to resize

BaseMarkableVectorGraphic Class

Represents the base class of all plugins of type markable job elements with vector graphic contents.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.JobElementBaseJobElement
      RAYLASE.Marker.JobElementBaseMarkableJobElement
        RAYLASE.Marker.JobElementBaseMarkableVectorGraphic
          More

Namespace: RAYLASE.Marker.JobElement
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.19.0
Syntax
C#
public abstract class BaseMarkableVectorGraphic : BaseMarkableJobElement

The BaseMarkableVectorGraphic type exposes the following members.

Constructors
 NameDescription
Protected methodBaseMarkableVectorGraphicInitializes a new instance of the Object class.
Top
Properties
 NameDescription
Public propertyAllowedScanControllers 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)
Protected propertyApplicationDataDirectory The directory where application data, such as logs and configurations, are stored.
(Inherited from BaseJobElement)
Public propertyAvailableScanControllers List of available scan controllers that can be used as the targets.
(Inherited from BaseMarkableJobElement)
Protected propertyBoundingBoxMap
(Inherited from BaseMarkableJobElement)
Public propertyCondition The binning condition for the holder of the job element.
(Inherited from BaseJobElement)
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Protected propertyDefaultPenNumber
(Inherited from BaseMarkableJobElement)
Protected propertyDeviceManager
(Inherited from BaseJobElement)
Protected propertyDirtyFlagLocker The lock object for property modification.
(Inherited from BaseJobElement)
Protected propertyDoHandleConditionPortChangedDelegate
(Inherited from BaseJobElement)
Public propertyEnvelopingOutline Defines the shape used to approximate the outline.
(Inherited from BaseMarkableJobElement)
Public propertyExecutions The number of times this job element should be executed.
(Inherited from BaseMarkableJobElement)
Public propertyExecutionSequences 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)
Public propertyFillingPenNumber The pen for the filling of this job element.
Public propertyFillingProfiles The fillingprofiles for the whole vector graphic. The values are dynamically generated during the rebuild process.
Public propertyIsDirty The flag to indicate whether the content of this job element has been modified.
(Inherited from BaseJobElement)
Public propertyIsDynamic The flag to indicate whether the content of this job element is dynamic.
Public propertyIsFillable Indicates whether the vector graphic content is fillable
Public propertyIsJerkLimited Commands the executor the unlock the scan head. Only activate this setting, if all vectors are jerk limited. Otherwise scan head could be damaged.
Public propertyIsLocked The flag to indicate whether the content of this job element should not be modified.
(Inherited from BaseMarkableJobElement)
Public propertyIsUsingVariable 
Public propertyJobElementID 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)
Protected propertyLogDirectory The directory of the log file.
(Inherited from BasePlugin)
Public propertyLogger The common logger.
(Inherited from BasePlugin)
Public propertyMarkableConfiguration The configuration: marker profiles, model matrix, and bounding box.
(Inherited from BaseMarkableJobElement)
Public propertyMarkerProfile The settings for marking. This is a shortcut to the MarkerProfile contained in the MarkableConfiguration.
Public propertyPenNumber
(Overrides BaseMarkableJobElementPenNumber)
Public propertyPersistVectorGraphic Indicates whether the vector graphic content is statically generated, without the need of the Rebuild method.
Public propertyPluginMetadata 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)
Public propertyPOIs Points of interest to be drawn on canvas but not marked.
(Inherited from BaseMarkableJobElement)
Public propertyPropertyMask
(Inherited from BaseJobElement)
Public propertyShowConditionControllerUIDelegate The delegate to show the controller UI because no ports have been defined.
(Inherited from BaseJobElement)
Public propertySupportIterationLevel
(Inherited from BaseMarkableJobElement)
Public propertySupportsCellFilling Indicates whether the vector graphic content supports cell based filling. Mostly useful for Cellcodes.
Protected propertyVariableManager
(Inherited from BaseJobElement)
Public propertyVariableScopeName
(Inherited from BaseJobElement)
Public propertyVectorGraphicEngine The vector graphic engine. This property holds the content of this job element.
Top
Methods
 NameDescription
Public methodAddFilling Adds a given filling profile for the contour. This stores only the filling information.
Public methodAlterPenSetPostBuild Provides the possibility to alter the resolved pen set during execution.
(Inherited from BaseMarkableJobElement)
Public methodAlterPenSetPreBuild Provides the possibility to alter the resolved pen set during execution.
(Inherited from BaseMarkableJobElement)
Protected methodBuildContent Builds the job element's contents (in terms of meta-commands) so that it will be consistent with its properties.
(Inherited from BaseMarkableJobElement)
Protected methodBuildFillings 
Public methodCenterToOrigin Moves the job element so that its centroid is at the origin.
(Inherited from BaseMarkableJobElement)
Public methodClearAllFillings Removes all fillings from the list. This removes only the filling information.
Public methodCompareWith
(Overrides BaseMarkableJobElementCompareWith(JobElementHolder, JobElementHolder, PropertyMask))
Public methodCopyFrom Copies the source job element into this job element.
(Inherited from BaseJobElement)
Public methodCreateFromBox Sets the metric properties to fit the box defined by the two points.
(Inherited from BaseMarkableJobElement)
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the BaseMarkableVectorGraphic and optionally releases the managed resources
(Overrides BasePluginDispose(Boolean))
Public methodDisposeUI
(Inherited from BaseMarkableJobElement)
Protected methodDoCompareWith
(Inherited from BaseJobElement)
Protected methodDoDisposeUI
(Inherited from BasePlugin)
Protected methodDoGetUIMask
(Inherited from BaseJobElement)
Protected methodDoShowUI(String)
(Inherited from BaseJobElement)
Protected methodDoShowUI(JobElementHolder, String)
(Inherited from BaseJobElement)
Protected methodDoShowUI(JobElementHolder, String, PropertyMask)
(Inherited from BaseJobElement)
Protected methodDoShowUICallback(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)
Protected methodDoShowUICallback(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)
Protected methodDoUpdateDynamicContent 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.
Public methodFlip Flip the job element against given flags for axes.
(Inherited from BaseMarkableJobElement)
Protected methodGenerateLocalTag
(Inherited from BaseJobElement)
Public methodGetBoundingBox Returns the bounding box of the transformed job element.
(Overrides BaseMarkableJobElementGetBoundingBox(dmat4))
Public methodGetExecutionStats Gets the execution statistics of the job element
(Overrides BaseMarkableJobElementGetExecutionStats(MarkingMode, PenSet, dmat4, Nullabledvec3))
Public methodGetFillingPenNumbers 
Protected methodGetNontransformedBoundingBox
(Inherited from BaseMarkableJobElement)
Public methodGetPenNumbers 
Protected methodGetTransformedBoundingBox
(Overrides BaseMarkableJobElementGetTransformedBoundingBox(dmat4))
Public methodGetUIMask
(Inherited from BaseJobElement)
Public methodHandleConditionPortChanged Performs necessary adjustments whenever the controller has updated its ports.
(Inherited from BaseJobElement)
Public methodHasPoint 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)
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin)
Protected methodInvokePenSetUpdated
(Inherited from BaseMarkableJobElement)
Public methodIsEmpty Returns true if job element doesn't contain any content.
(Overrides BaseMarkableJobElementIsEmpty)
Public methodMoveTo Moves the job element so that its centroid is at the given position.
(Inherited from BaseMarkableJobElement)
Public methodRebuild(dmat4) Updates the job element's contents (in terms of meta-commands) so that it will be consistent with its properties.
(Overrides BaseMarkableJobElementRebuild(dmat4))
Protected methodRebuild(dmat4, CommandListType)
(Overrides BaseMarkableJobElementRebuild(dmat4, CommandListType))
Public methodRemoveFilling Removes a filling from the list. This removes only the filling information.
Public methodRemoveFillingAt Removes a filling from the list. This removes only the filling information.
Public methodRotate(Double) Rotates the job element a given angle around the z-axis.
(Inherited from BaseMarkableJobElement)
Public methodRotate(Double, dvec3) Rotates the job element a given angle with respect to a given vector passing through its centroid.
(Inherited from BaseMarkableJobElement)
Public methodScale(Double) Scales the job element uniformly with respect to its centroid.
(Inherited from BaseMarkableJobElement)
Public methodScale(dvec3) Scales the job element non-uniformly with respect to its centroid.
(Inherited from BaseMarkableJobElement)
Public methodScalePrepend(Double)
(Inherited from BaseMarkableJobElement)
Public methodScalePrepend(dvec3)
(Inherited from BaseMarkableJobElement)
Public methodShowUI(String)
(Inherited from BaseJobElement)
Public methodShowUI(JobElementHolder, String)
(Inherited from BaseJobElement)
Public methodShowUI(JobElementHolder, String, PropertyMask)
(Overrides BaseMarkableJobElementShowUI(JobElementHolder, String, PropertyMask))
Public methodShowUICallback(PluginSettingsView)
(Inherited from BaseJobElement)
Public methodShowUICallback(JobElementHolder, PluginSettingsView)
(Overrides BaseMarkableJobElementShowUICallback(JobElementHolder, PluginSettingsView))
Public methodShowUICancelCallback(PluginSettingsView) Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin)
Public methodShowUICancelCallback(JobElementHolder, PluginSettingsView)
(Inherited from BaseJobElement)
Public methodSplitAtPlane(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)
Public methodSplitAtPlane(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)
Public methodSplitAtPlane(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)
Public methodSplitAtPlane(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.
(Overrides BaseMarkableJobElementSplitAtPlane(FuncBaseMarkableJobElement, dvec3, dvec3, dvec3, dmat4, MarkingMode, Double, Double))
Public methodToString
(Inherited from BasePlugin)
Public methodTransform Multiplies the model matrix with a transformation matrix.
(Inherited from BaseMarkableJobElement)
Public methodTranslate Translates the job element with a given vector.
(Inherited from BaseMarkableJobElement)
Public methodUpdateDynamicContent 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.
Protected methodUpdateFieldT Updates the Property to the value by using DirtyFlagLocker and setting IsDirty .
(Inherited from BaseJobElement)
Top
See Also
Inheritance Hierarchy