BaseMarkableBitmapGraphic Class

Represents the base class of all plugins of type markable job elements with bitmap graphic contents.

Inheritance Hierarchy

SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.JobElementBaseJobElement
      RAYLASE.Marker.JobElementBaseMarkableJobElement
        RAYLASE.Marker.JobElementBaseMarkableBitmapGraphic
          RAYLASE.MarkerPlugin.JobElementsMarkableBitmap

Namespace: RAYLASE.Marker.JobElement
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.19.0

Syntax

Copy

public abstract class BaseMarkableBitmapGraphic : BaseMarkableJobElement, 
	IMarkableElementWithInputFile

The BaseMarkableBitmapGraphic type exposes the following members.

Constructors

	Name	Description
	BaseMarkableBitmapGraphic	Initializes a new instance of the Object class.

Top

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)
	BitmapHolder	The bitmap holder of this job element.
	BitmapManager	Bitmap manager of the job, to keep track of the bitmaps used in the job. The bitmaps can be external references or embedded in the job.
	BoundingBoxMap	(Inherited from BaseMarkableJobElement)
	CachedBitmapHolder	Cache for bitmap holder if the bitmap manager is not yet available (ie. this job element has not been added to the job).
	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)
	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. (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)
	FilePath
	InvertPixel	Inverts each pixel.
	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. (Inherited from BaseMarkableJobElement)
	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. (Inherited from BaseMarkableJobElement)
	MarkerProfile	The BitmapMarkerProfile of the bitmap.
	Mask	List of points defining the outline of the bitmap. Can be used to crop the bitmap.
	PenNumber	The pen for the contour of this job element. (Inherited from BaseMarkableJobElement)
	PixelSize	The pixel size of the bitmap.
	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)
	PointDistance	The distance between two points.
	POIs	Points of interest to be drawn on canvas but not marked. (Inherited from BaseMarkableJobElement)
	PropertyMask	(Inherited from BaseJobElement)
	ResourceID	The ID of the bitmap inside the bitmap manager.
	ShowConditionControllerUIDelegate	The delegate to show the controller UI because no ports have been defined. (Inherited from BaseJobElement)
	Size	The metric size of the bitmap.
	SupportIterationLevel	(Inherited from BaseMarkableJobElement)
	VariableManager	(Inherited from BaseJobElement)
	VariableScopeName	(Inherited from BaseJobElement)

Top

Methods

	Name	Description
	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. (Inherited from BaseMarkableJobElement)
	CenterToOrigin	Moves the job element so that its centroid is at the origin. (Inherited from BaseMarkableJobElement)
	CompareWith	(Inherited from BaseMarkableJobElement)
	ConvertToEmbedded	Converts the bitmap into an embedded one. Nothing is done if it is already embedded. The resource ID is adjusted accordingly if converting is successful.
	ConvertToNonEmbedded	Converts the bitmap to an external reference. Nothing is done if it is already an external reference. The resource ID is adjusted accordingly if converting is successful.
	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. (Inherited from BaseMarkableJobElement)
	Dispose	(Inherited from BasePlugin)
	Dispose(Boolean)	(Inherited from BasePlugin)
	DisposeUI	(Inherited from BaseMarkableJobElement)
	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. (Inherited from BaseMarkableJobElement)
	GenerateLocalTag	(Inherited from BaseJobElement)
	GetBoundingBox	Returns the bounding box of the transformed job element. (Inherited from BaseMarkableJobElement)
	GetEndPosition	Returns the untransformed end position.
	GetExecutionStats(MarkingMode, PenSet, dmat4, Nullabledvec3)	Gets the execution statistics of the job element (Inherited from BaseMarkableJobElement)
	GetExecutionStats(MarkerPen, Double, LaserProfile, dmat4, Nullabledvec3, Int32)	Gets the execution statistics of the job element
	GetExecutionTime	Gets the execution time of the job element
	GetNontransformedBoundingBox	(Overrides BaseMarkableJobElementGetNontransformedBoundingBox)
	GetOutline	Get the path representing the bounding box outline of the bitmap.
	GetProcessedBitmap	Returns the processed bitmap used for marking.
	GetStartPosition	Returns the untransformed start position.
	GetTransformedBoundingBox	(Overrides BaseMarkableJobElementGetTransformedBoundingBox(dmat4))
	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. (Inherited from BaseMarkableJobElement)
	Initialize	Plug-in specific initialization can be done here if necessary. (Inherited from BasePlugin)
	InvokeBitmapManagerRequested
	InvokePenSetUpdated	(Inherited from BaseMarkableJobElement)
	IsEmpty	Returns true if job element doesn't contain any content. (Inherited from BaseMarkableJobElement)
	LoadFromFile	Loads a bitmap from a file and store it as a resource for later use.
	MoveTo	Moves the job element so that its centroid is at the given position. (Inherited from BaseMarkableJobElement)
	OnPowerMappingDialogRequested
	Rebuild(dmat4)	Updates the job element's contents (in terms of meta-commands) so that it will be consistent with its properties. (Overrides BaseMarkableJobElementRebuild(dmat4))
	Rebuild(dmat4, CommandListType)	(Inherited from BaseMarkableJobElement)
	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 BaseMarkableJobElement)
	ShowUICallback(PluginSettingsView)	(Inherited from BaseJobElement)
	ShowUICallback(JobElementHolder, PluginSettingsView)	(Inherited from BaseMarkableJobElement)
	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, 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))
	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)
	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)
	UpdateFieldT	Updates the Property to the value by using DirtyFlagLocker and setting IsDirty . (Inherited from BaseJobElement)

Top

Events

	Name	Description
	BitmapManagerRequested
	PowerMappingDialogRequested

Top

Reference

RAYLASE.Marker.JobElement Namespace